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