/[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.9 by joko, Mon Mar 10 22:31:55 2003 UTC revision 1.28 by joko, Tue Mar 18 01:52:33 2003 UTC
# Line 14  Line 14 
14   * @name DataSource::Locator   * @name DataSource::Locator
15   *   *
16   *   *
17     */
18    
19    
20    /**
21   * <b>Cvs-Log:</b>   * <b>Cvs-Log:</b>
22   *   *
23   * <pre>   * <pre>
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.28  2003/03/18 01:52:33  joko
28     * minor update (mungling with phpDocumentor again)
29     *
30     * Revision 1.27  2003/03/11 16:44:59  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.26  2003/03/11 16:41:47  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.25  2003/03/11 16:28:25  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.24  2003/03/11 04:49:25  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.23  2003/03/11 04:15:01  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.22  2003/03/11 04:03:54  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.21  2003/03/11 03:23:36  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.20  2003/03/11 03:17:37  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.19  2003/03/11 03:05:01  joko
55     * + fixed metadata for phpDocumentor
56     *
57     * Revision 1.18  2003/03/11 02:42:51  joko
58     * + fixed metadata for phpDocumentor
59     *
60     * Revision 1.17  2003/03/11 02:34:55  joko
61     * + fixed metadata for phpDocumentor
62     *
63     * Revision 1.16  2003/03/11 02:28:12  joko
64     * + fixed metadata for phpDocumentor
65     *
66     * Revision 1.15  2003/03/11 02:23:03  joko
67     * + fixed metadata for phpDocumentor
68     *
69     * Revision 1.14  2003/03/11 02:14:24  joko
70     * + fixed metadata for phpDocumentor
71     *
72     * Revision 1.13  2003/03/11 02:04:37  joko
73     * + fixed metadata for phpDocumentor
74     *
75     * Revision 1.12  2003/03/11 01:10:00  joko
76     * + fixed metadata for phpDocumentor
77     *
78     * Revision 1.11  2003/03/11 00:12:49  joko
79     * + fixed metadata for phpDocumentor
80     *
81     * Revision 1.10  2003/03/10 23:25:03  joko
82     * + fixed metadata for phpDocumentor
83     *
84   * Revision 1.9  2003/03/10 22:31:55  joko   * Revision 1.9  2003/03/10 22:31:55  joko
85   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
86   *   *
# Line 54  Line 115 
115  /**  /**
116   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
117   *   *
118   * <ul>   * <b>Modes:</b> (these are proposals, more or less...)
119   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
120   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
121   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
122   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
123   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
124   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
  * </ul>  
  *  
125   *   *
126   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
127   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
  * <ul>  
128   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
129   * x 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
130   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
131   * x 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')
132   * 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')
133   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
134   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
135   *   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*
136   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
137   * x an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
138   *   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*
139   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
140   * o names of global constants where to find these informations   * o names of global constants where to find these informations
141   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * </ul>  
  *  
  *  
  * <b>It can do</b>  
  * <ul>  
  * # 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  
  * </ul>  
142   *   *
143     * <b>It can do:</b>
144     * - builds a larger locator from a minimum of information passed in via constructor-arguments
145     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
146     * - direct fallback mode to some predefined values if just *everything* fails
147   *   *
148   * <b>How to use?</b>   * <b>How to use?</b>
149   *   *
150   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
151   * This module takes care of the rest.   * This module takes care of the rest.
  *  
152   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
153   *   *
154   *  1. for doing rpc-calls....   * <pre>
155   *    <code>   *    // 1. for doing rpc-calls....
156   *    $locator = array(   *    $locator = array(
157   *      datasource_type => 'rpc',   *      datasource_type => 'rpc',
158   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
# Line 108  Line 160 
160   *    );   *    );
161   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
162   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
163   *    </code>   * </pre>
164   *   * <pre>
165   *  2. [proposal] for common/oldschool datahandles....   *    // 2. [proposal] for common/oldschool datahandles....
  *    <code>  
166   *    $locator = array(   *    $locator = array(
167   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
168   *    );   *    );
169   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
170   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
171   *    </code>   * </pre>
172   *   *
173   *   *
174   *   *
# Line 136  Line 187 
187  class DataSource_Locator {  class DataSource_Locator {
188    
189    /**    /**
190      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
191        *
192      * which is built from some predefined rules      * which is built from some predefined rules
193      * using metadata from $_options and some      * using metadata from $_options and some
194      * other presets.      * other presets.
195      *      *
196      * @see function build, which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
197      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
198      * (main dispatching level)      * (main dispatching level)
199      *      *
200      * The structure of a full blown locator looks like this:      * <br>
201      *      *
202        * The structure of a full blown locator looks like this:
203      * <code>      * <code>
204      *  $locator = array(      *  $locator = array(
205      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.28
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed