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