/[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.5 by joko, Wed Mar 5 15:40:39 2003 UTC revision 1.22 by joko, Tue Mar 11 04:03:54 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>   * @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.22  2003/03/11 04:03:54  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.21  2003/03/11 03:23:36  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.20  2003/03/11 03:17:37  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.19  2003/03/11 03:05:01  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.18  2003/03/11 02:42:51  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.17  2003/03/11 02:34:55  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.16  2003/03/11 02:28:12  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.15  2003/03/11 02:23:03  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.14  2003/03/11 02:14:24  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.13  2003/03/11 02:04:37  joko
55     * + fixed metadata for phpDocumentor
56     *
57     * Revision 1.12  2003/03/11 01:10:00  joko
58     * + fixed metadata for phpDocumentor
59     *
60     * Revision 1.11  2003/03/11 00:12:49  joko
61     * + fixed metadata for phpDocumentor
62     *
63     * Revision 1.10  2003/03/10 23:25:03  joko
64     * + fixed metadata for phpDocumentor
65     *
66     * Revision 1.9  2003/03/10 22:31:55  joko
67     * + fixed metadata for phpDocumentor
68     *
69     * Revision 1.8  2003/03/09 15:50:36  joko
70     * + additional metadata for Autodia
71     *
72     * Revision 1.7  2003/03/05 17:13:16  joko
73     * updated docu (phpDocumentor testing....)
74     *
75     * Revision 1.6  2003/03/05 16:10:08  joko
76     * updated docu (phpDocumentor testing....)
77     *
78   * Revision 1.5  2003/03/05 15:40:39  joko   * Revision 1.5  2003/03/05 15:40:39  joko
79   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
80   *   *
# Line 34  Line 89 
89   *   *
90   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
91   * + initial commit   * + initial commit
92     * </pre>
93   *   *
94   *   *
95   */   */
# Line 41  Line 97 
97  /**  /**
98   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
99   *   *
100   * - Pass-Through-Reference: php Object will get passed through all layers   * <b>Modes:</b> (these are proposals, more or less...)
101   * - Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Reference: php Object will get passed through all layers
102     * o Pass-Through-Memory: reference to a memory area will get used
103   * + Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
104   * - Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
105   * - Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
106   * - Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
107   *   *
108   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
109   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
110   * - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
111   * + 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
112   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
113   * + 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')
114   * - 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')
115   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
116   * - a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
117   *   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*
118   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
119   * + an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
120   *   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*
121   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
122   * - names of global constants where to find these informations   * o names of global constants where to find these informations
123   * - datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  *  
  *  
  * <b>It can do</b>  
  * + 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  
124   *   *
125     * <b>It can do:</b>
126     * - builds a larger locator from a minimum of information passed in via constructor-arguments
127     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
128     * - direct fallback mode to some predefined values if just *everything* fails
129   *   *
130   * <b>How to use?</b>   * <b>How to use?</b>
131   *   *
132   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
133   * This module takes care of the rest.   * This module takes care of the rest.
  *  
134   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
135   *   *
136   *  1. for doing rpc-calls....   * <code>
137   *    <code>   *    // 1. for doing rpc-calls....
138   *    $locator = array(   *    $locator = array(
139   *      datasource_type => 'rpc',   *      datasource_type => 'rpc',
140   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
141   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
142   *    );   *    );
143   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
144   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
145   *    </code>   * </code>
146   *   *
147   *  2. [proposal] for common/oldschool datahandles....   * <code>
148   *    <code>   *    // 2. [proposal] for common/oldschool datahandles....
149   *    $locator = array(   *    $locator = array(
150   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
151   *    );   *    );
152   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
153   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
154   *    </code>   * </code>
155   *   *
156   *   *
157   *   *
# Line 108  Line 162 
162   * @license GNU LGPL (GNU Lesser General Public License)   * @license GNU LGPL (GNU Lesser General Public License)
163   * @link http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
164   *   *
165     * @package org.netfrag.glib
166     * @subpackage DataSource
167   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
168   *   *
169   */   */
   
   
170  class DataSource_Locator {  class DataSource_Locator {
171    
172    /**    /**
173      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
174        *
175      * which is built from some predefined rules      * which is built from some predefined rules
176      * using metadata from $_options and some      * using metadata from $_options and some
177      * other presets.      * other presets.
178      *      *
179      * @see function build, which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
180      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
181      * (main dispatching level)      * (main dispatching level)
182      *      *
183        * <pre>
184      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
     *  
185      * <code>      * <code>
186      *  $locator = array(      *  $locator = array(
187      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
# Line 137  class DataSource_Locator { Line 191  class DataSource_Locator {
191      *    [dsn => '<your dsn markup>'],      *    [dsn => '<your dsn markup>'],
192      *  );      *  );
193      * </code>      * </code>
194        * </pre>
195      *      *
196      * 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:
197      * <code>      * <code>
198        * <pre>
199      *  $locator = array(      *  $locator = array(
200      *    dsn => 'mysql://username:password@localhost/database',      *    dsn => 'mysql://username:password@localhost/database',
201      *  );      *  );
202        * </pre>
203      * </code>      * </code>
204      *      *
205      * 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):
# Line 203  class DataSource_Locator { Line 260  class DataSource_Locator {
260           * The constructor is used to pass in the           * The constructor is used to pass in the
261           * locator metadata hash.           * locator metadata hash.
262           *           *
263           * @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 => '' )  
264           */           */
265          function DataSource_Locator() {          function DataSource_Locator() {
266        $args_multi = func_get_args();        $args_multi = func_get_args();
# Line 280  class DataSource_Locator { Line 336  class DataSource_Locator {
336                    
337          /**          /**
338       * Set the locator metadata hash we will feed *partly*       * Set the locator metadata hash we will feed *partly*
339       * to an encapsulated Data::Driver::Proxy instance.       * to an encapsulated Data::Driver::Proxy instance
340       *       *
341       * @param LocatorMetadataHash array -       * @param LocatorMetadataHash array -
342       *       *
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.22
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed