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