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