/[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.20 by joko, Tue Mar 11 03:17:37 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.20  2003/03/11 03:17:37  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.19  2003/03/11 03:05:01  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.18  2003/03/11 02:42:51  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.17  2003/03/11 02:34:55  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.16  2003/03/11 02:28:12  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.15  2003/03/11 02:23:03  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.14  2003/03/11 02:14:24  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.13  2003/03/11 02:04:37  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.12  2003/03/11 01:10:00  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.11  2003/03/11 00:12:49  joko
55     * + fixed metadata for phpDocumentor
56     *
57     * Revision 1.10  2003/03/10 23:25:03  joko
58     * + fixed metadata for phpDocumentor
59     *
60   * Revision 1.9  2003/03/10 22:31:55  joko   * Revision 1.9  2003/03/10 22:31:55  joko
61   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
62   *   *
# Line 54  Line 91 
91  /**  /**
92   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
93   *   *
94   * <ul>   * <p>
95     * <b>Modes:</b> (these are proposals, more or less...)
96   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
97   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
98   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
99   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
100   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
101   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
102   * </ul>   * </p>
  *  
103   *   *
104   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
105   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
  * <ul>  
106   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
107   * 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
108   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
109   * 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')
110   * 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')
111   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
112   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
113   *   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*
114   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
115   * x an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
116   *   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*
117   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
118   * o names of global constants where to find these informations   * o names of global constants where to find these informations
119   * 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>  
120   *   *
121     * <b>It can do:</b>
122     * - builds a larger locator from a minimum of information passed in via constructor-arguments
123     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
124     * - direct fallback mode to some predefined values if just *everything* fails
125   *   *
126   * <b>How to use?</b>   * <b>How to use?</b>
127   *   *
128   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
129   * This module takes care of the rest.   * This module takes care of the rest.
  *  
130   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
131   *   *
132   *  1. for doing rpc-calls....   * 1. for doing rpc-calls....
133   *    <code>   * <code>
134   *    $locator = array(   *    $locator = array(
135   *      datasource_type => 'rpc',   *      datasource_type => 'rpc',
136   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
# Line 108  Line 138 
138   *    );   *    );
139   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
140   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
141   *    </code>   * </code>
142   *   *
143   *  2. [proposal] for common/oldschool datahandles....   *  2. [proposal] for common/oldschool datahandles....
144   *    <code>   * <code>
145   *    $locator = array(   *    $locator = array(
146   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
147   *    );   *    );
148   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
149   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
150   *    </code>   * </code>
151   *   *
152   *   *
153   *   *
# Line 136  Line 166 
166  class DataSource_Locator {  class DataSource_Locator {
167    
168    /**    /**
169      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
170        *
171      * which is built from some predefined rules      * which is built from some predefined rules
172      * using metadata from $_options and some      * using metadata from $_options and some
173      * other presets.      * other presets.
174      *      *
175      * @see function build, which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
176      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
177      * (main dispatching level)      * (main dispatching level)
178      *      *
179      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
180      *      *
181      * <code>      * <code><pre>
182      *  $locator = array(      *  $locator = array(
183      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
184      *    metadata => array(      *    metadata => array(
# Line 155  class DataSource_Locator { Line 186  class DataSource_Locator {
186      *    ),      *    ),
187      *    [dsn => '<your dsn markup>'],      *    [dsn => '<your dsn markup>'],
188      *  );      *  );
189      * </code>      * </pre></code>
190      *      *
191      * 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:
192      * <code>      * <pre><code>
193      *  $locator = array(      *  $locator = array(
194      *    dsn => 'mysql://username:password@localhost/database',      *    dsn => 'mysql://username:password@localhost/database',
195      *  );      *  );
196      * </code>      * </code></pre>
197      *      *
198      * 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):
199      * <code>      * <code>
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.20
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed