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