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