/[cvs]/nfo/php/libs/org.netfrag.glib/DataSource/Locator.php
ViewVC logotype

Diff of /nfo/php/libs/org.netfrag.glib/DataSource/Locator.php

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by joko, Wed Mar 5 12:04:37 2003 UTC revision 1.20 by joko, Tue Mar 11 03:17:37 2003 UTC
# Line 1  Line 1 
1  <?php  <?php
2  /**  /**
  * --- @about  
  *  
3   * This file contains the DataSource::Locator class.   * This file contains the DataSource::Locator class.
4     *
5   * It acts as a container for DataSource connection   * It acts as a container for DataSource connection
6   * metadata. Think of it as an enhanced dsn.   * metadata. Think of it as an enhanced dsn.
7   *   *
8   * It gets used by DataSource::GenericDataSource   * It gets used by DataSource::Generic
9   * to be informed about the most important stuff it   * to be informed about the most important stuff it
10   * has to do.   * has to do.
11   *   *
  *  
12   * @author Andreas Motl <andreas.motl@ilo.de>   * @author Andreas Motl <andreas.motl@ilo.de>
13   * @package org.netfrag.glib   * @package org.netfrag.glib
14   * @module DataSource::Locator   * @name DataSource::Locator
15     *
16   *   *
17   */   */
18    
19    
20  /**  /**
21     * <b>Cvs-Log:</b>
22     *
23     * <pre>
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.20  2003/03/11 03:17:37  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.19  2003/03/11 03:05:01  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.18  2003/03/11 02:42:51  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.17  2003/03/11 02:34:55  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.16  2003/03/11 02:28:12  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.15  2003/03/11 02:23:03  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.14  2003/03/11 02:14:24  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.13  2003/03/11 02:04:37  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.12  2003/03/11 01:10:00  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.11  2003/03/11 00:12:49  joko
55     * + fixed metadata for phpDocumentor
56     *
57     * Revision 1.10  2003/03/10 23:25:03  joko
58     * + fixed metadata for phpDocumentor
59     *
60     * Revision 1.9  2003/03/10 22:31:55  joko
61     * + fixed metadata for phpDocumentor
62     *
63     * Revision 1.8  2003/03/09 15:50:36  joko
64     * + additional metadata for Autodia
65     *
66     * Revision 1.7  2003/03/05 17:13:16  joko
67     * updated docu (phpDocumentor testing....)
68     *
69     * Revision 1.6  2003/03/05 16:10:08  joko
70     * updated docu (phpDocumentor testing....)
71     *
72     * Revision 1.5  2003/03/05 15:40:39  joko
73     * updated docu (phpDocumentor testing....)
74     *
75     * Revision 1.4  2003/03/05 15:26:23  joko
76     * updated docu (phpDocumentor testing....)
77     *
78     * Revision 1.3  2003/03/05 15:21:54  joko
79     * updated docu (phpDocumentor testing....)
80     *
81     * Revision 1.2  2003/03/05 15:01:10  joko
82     * updated docu
83     *
84   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
85   * + initial commit   * + initial commit
86     * </pre>
87   *   *
88   *   *
89   */   */
90    
91  /**  /**
92   * --- @description   * It helps DataSource::Generic working in different "operation modes".
  *  
  * --- It helps GenericDataSource working in different "operation modes".  
  *  
  *    o Pass-Through-Reference: php Object will get passed through all layers  
  *    o Pass-Through-Memory: reference to a memory area will get used  
  *    x Build-Locator: build locator from datasource-type and adapter-type  
  *    o Use-Locator: directly use DataSource::Locator instance passed in  
  *    o Merge-Locators: merge metadata of two or more DataSource::Locator instances  
  *    o Build-AutoLocator: use global constants making up our metadata  
  *  
  *  
  * --- It can/should contain (flexible, just some parameters are required for each operation mode)  
  *  
  *    o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)  
  *    x name of a Proxy module to use to *wrap/hide* the connection/transport-layer  
  *       (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)  
  *    x metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')  
  *    o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')  
  *       this will get propagated (pass-through-mode)  
  *    x a datasource-type (of 'rpc|mysql|csv-file|xml-file')  
  *        this will be mapped to a module name and used as a *Proxy*  
  *        by the GenericDataSource at runtime  
  *    x an adapter-type (of 'phpHtmlLib|pear')  
  *        this will be mapped to a module name and used as an *Adapter*  
  *        by the GenericDataSource at runtime  
  *    o names of global constants where to find these informations  
  *    o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')  
  *  
  *  
  * --- It can do  
  *    x builds a larger locator from a minimum of information passed in via constructor-arguments  
  *    o direct fallback mode to some predefined constant names if locator is empty and above method fails  
  *    o direct fallback mode to some predefined values if just *everything* fails  
93   *   *
94     * <p>
95     * <b>Modes:</b> (these are proposals, more or less...)
96     * o Pass-Through-Reference: php Object will get passed through all layers
97     * o Pass-Through-Memory: reference to a memory area will get used
98     * + Build-Locator: build locator from datasource-type and adapter-type
99     * o Use-Locator: directly use DataSource::Locator instance passed in
100     * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
101     * o Build-AutoLocator: use global constants making up our metadata
102     * </p>
103     *
104     * <b>It can/should contain:</b>
105     * (flexible, just some parameters are required for each operation mode)
106     * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
107     * + (x) name of a Proxy module to use to *wrap/hide* the connection/transport-layer
108     *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
109     * + (x) metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')
110     * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
111     *   this will get propagated (pass-through-mode)
112     * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
113     *   this will be mapped to a module name and used as a *Proxy*
114     *   by the DataSource::Generic at runtime
115     * + (x) an adapter-type (of 'phpHtmlLib|pear')
116     *   this will be mapped to a module name and used as an *Adapter*
117     *   by the DataSource::Generic at runtime
118     * o names of global constants where to find these informations
119     * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
120     *
121     * <b>It can do:</b>
122     * - builds a larger locator from a minimum of information passed in via constructor-arguments
123     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
124     * - direct fallback mode to some predefined values if just *everything* fails
125   *   *
126   * --- How to use?   * <b>How to use?</b>
127   *   *
128   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
129   * This module takes care of the rest.   * This module takes care of the rest.
  *  
130   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
131   *   *
132   *  1. for doing rpc-calls....   * 1. for doing rpc-calls....
133     * <code>
134   *    $locator = array(   *    $locator = array(
135   *      datasource_type => 'rpc',   *      datasource_type => 'rpc',
136   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
137   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
138   *    );   *    );
139   *    $source = new GenericDataSource($locator);   *    $source = ne w DataSource::Generic($locator);
140   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
141     * </code>
142   *   *
143   *  2. [proposal] for common/oldschool datahandles....   *  2. [proposal] for common/oldschool datahandles....
144     * <code>
145   *    $locator = array(   *    $locator = array(
146   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
147   *    );   *    );
148   *    $source = new GenericDataSource($locator);   *    $source = ne w DataSource::Generic($locator);
149   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
150     * </code>
151   *   *
152   *   *
153   *   *
154   * @author Andreas Motl <andreas.motl@ilo.de>   * @author Andreas Motl <andreas.motl@ilo.de>
155     * @link http://www.netfrag.org/~joko/
156   * @copyright (c) 2003 - All Rights reserved.   * @copyright (c) 2003 - All Rights reserved.
  * @license GNU LGPL (GNU Lesser General Public License)  
157   *   *
158   * @author-url http://www.netfrag.org/~joko/   * @license GNU LGPL (GNU Lesser General Public License)
159   * @license-url http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
160   *   *
  * @author Andreas Motl <andreas.motl@ilo.de>  
161   * @package org.netfrag.glib   * @package org.netfrag.glib
162   * @module DataSource::Locator   * @subpackage DataSource
163     * @name DataSource::Locator
164   *   *
165   */   */
   
   
166  class DataSource_Locator {  class DataSource_Locator {
167    
168    /**    /**
169      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
170        *
171      * which is built from some predefined rules      * which is built from some predefined rules
172      * using metadata from $_options and some      * using metadata from $_options and some
173      * other presets.      * other presets.
174      *      *
175      * See '_buildLocator' which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
176      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
177      * (main dispatching level)      * (main dispatching level)
178      *      *
179      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
180      *      *
181        * <code><pre>
182      *  $locator = array(      *  $locator = array(
183      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
184      *    metadata => array(      *    metadata => array(
# Line 124  class DataSource_Locator { Line 186  class DataSource_Locator {
186      *    ),      *    ),
187      *    [dsn => '<your dsn markup>'],      *    [dsn => '<your dsn markup>'],
188      *  );      *  );
189        * </pre></code>
190      *      *
191      * Example 1 - data is inside a rdbms, using a dsn to connect to it:      * Example 1 - data is inside a rdbms, using a dsn to connect to it:
192        * <pre><code>
193      *  $locator = array(      *  $locator = array(
194      *    dsn => 'mysql://username:password@localhost/database',      *    dsn => 'mysql://username:password@localhost/database',
195      *  );      *  );
196        * </code></pre>
197      *      *
198      * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):      * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
199        * <code>
200      *  $locator = array(      *  $locator = array(
201      *    type => 'rpc',      *    type => 'rpc',
202      *    metadata => array(      *    metadata => array(
# Line 139  class DataSource_Locator { Line 205  class DataSource_Locator {
205      *      Port => '8765',      *      Port => '8765',
206      *    )      *    )
207      *  );      *  );
208        * </code>
209        *
210        * @deprecated
211      *      *
212      */      */
213            var $_locator_metadata = NULL;
     //var $_locator_metadata = NULL;  
214    
215    
216          /**     /**
217           * This var holds the arguments passed in to the constructor.      * This var holds the arguments passed in to the constructor.
218           * We will try to build full blown locator metadata information from that.      * We will try to build full blown locator metadata information from that.
219           *      *
220           */      * @deprecated
221          //var $_in = NULL;      *
222        */
223        var $_in = NULL;
224    
225          /**     /**
226           * This var holds the locator metadata informations inside      * This var holds the locator metadata informations inside
227           * a single hash. This is returned from '->get()'.      * a single hash. This is returned from '->get()'.
228           *      *
229           */      * @deprecated
230          //var $_out = NULL;      *
231        */
232        var $_out = NULL;
233    
234    
235          /**          /**
# Line 171  class DataSource_Locator { Line 243  class DataSource_Locator {
243      // name of an Adapter module      // name of an Adapter module
244      var $_adapter_type;      var $_adapter_type;
245            
246      // additional information required (passed on to the Proxy by GenericDataSource)      // additional information required (passed on to the Proxy by DataSource::Generic)
247      var $_metadata = array();      var $_metadata = array();
248            
249      //var $_dsn;      //var $_dsn;
# Line 181  class DataSource_Locator { Line 253  class DataSource_Locator {
253           * The constructor is used to pass in the           * The constructor is used to pass in the
254           * locator metadata hash.           * locator metadata hash.
255           *           *
256           * @param LocatorMetadataHash array - layout: array( type => '', metadata => '', dsn => '' )           * @param object(DataSource::Locator)|hash optional: a &$locator instance
          * @param Query array - layout: array( type => '', metadata => '', dsn => '' )  
257           */           */
258          function DataSource_Locator() {          function DataSource_Locator() {
259        $args_multi = func_get_args();        $args_multi = func_get_args();
# Line 258  class DataSource_Locator { Line 329  class DataSource_Locator {
329                    
330          /**          /**
331       * Set the locator metadata hash we will feed *partly*       * Set the locator metadata hash we will feed *partly*
332       * to an encapsulated Data::Driver::Proxy instance.       * to an encapsulated Data::Driver::Proxy instance
333       *       *
334       * @param LocatorMetadataHash array -       * @param LocatorMetadataHash array -
335       *       *
# Line 285  class DataSource_Locator { Line 356  class DataSource_Locator {
356          $metadata = array(          $metadata = array(
357            //package => 'Data::Driver::Proxy',            //package => 'Data::Driver::Proxy',
358            //package => 'DataSource::Proxy::XMLRPC',            //package => 'DataSource::Proxy::XMLRPC',
359            //package => 'DataSource::GenericDataSource',            //package => 'DataSource::Generic',
360            //package => 'DesignPattern::RemoteProxy',            //package => 'DesignPattern::RemoteProxy',
361            Host => RPC_HOSTNAME,            Host => RPC_HOSTNAME,
362            Port => RPC_PORT,            Port => RPC_PORT,
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.20
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed