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