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