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