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