/[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.18 by joko, Tue Mar 11 02:42:51 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.18  2003/03/11 02:42:51  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.17  2003/03/11 02:34:55  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.16  2003/03/11 02:28:12  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.15  2003/03/11 02:23:03  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.14  2003/03/11 02:14:24  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.13  2003/03/11 02:04:37  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.12  2003/03/11 01:10:00  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.11  2003/03/11 00:12:49  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.10  2003/03/10 23:25:03  joko
52     * + fixed metadata for phpDocumentor
53     *
54   * Revision 1.9  2003/03/10 22:31:55  joko   * Revision 1.9  2003/03/10 22:31:55  joko
55   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
56   *   *
# Line 54  Line 85 
85  /**  /**
86   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
87   *   *
88   * <ul>   * <p>
89     * <b>Modes:</b> (these are proposals, more or less...)
90   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
91   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
92   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
93   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
94   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
95   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
96   * </ul>   * </p>
  *  
97   *   *
98   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
99   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
  * <ul>  
100   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
101   * 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
102   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
103   * 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')
104   * 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')
105   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
106   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
107   *   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*
108   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
109   * x an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
110   *   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*
111   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
112   * o names of global constants where to find these informations   * o names of global constants where to find these informations
113   * 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>  
114   *   *
115     * <b>It can do:</b>
116     * - builds a larger locator from a minimum of information passed in via constructor-arguments
117     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
118     * - direct fallback mode to some predefined values if just *everything* fails
119   *   *
120   * <b>How to use?</b>   * <b>How to use?</b>
121   *   *
122   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
123   * This module takes care of the rest.   * This module takes care of the rest.
  *  
124   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
125   *   *
126     * <pre>
127   *  1. for doing rpc-calls....   *  1. for doing rpc-calls....
128   *    <code>   *    <code>
129   *    $locator = array(   *    $locator = array(
# Line 118  Line 143 
143   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
144   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
145   *    </code>   *    </code>
146     * </pre>
147   *   *
148   *   *
149   *   *
# Line 136  Line 162 
162  class DataSource_Locator {  class DataSource_Locator {
163    
164    /**    /**
165      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
166        *
167      * which is built from some predefined rules      * which is built from some predefined rules
168      * using metadata from $_options and some      * using metadata from $_options and some
169      * other presets.      * other presets.
170      *      *
171      * @see function build, which acts as a dispatcher      * {@see build}, which acts as a dispatcher
172      * depending on $_options[datasource].      * depending on $_options[datasource]. (main dispatching level)
173      * (main dispatching level)      *
174        * <p>
175      *      *
176      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
177      *      *
# Line 176  class DataSource_Locator { Line 204  class DataSource_Locator {
204      *  );      *  );
205      * </code>      * </code>
206      *      *
207        * </p>
208        *
209      * @deprecated      * @deprecated
210      *      *
211      */      */
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.18
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed