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