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