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