/[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.10 by joko, Mon Mar 10 23:25:03 2003 UTC revision 1.19 by joko, Tue Mar 11 03:05:01 2003 UTC
# Line 24  Line 24 
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   * Revision 1.10  2003/03/10 23:25:03  joko
55   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
56   *   *
# Line 61  Line 88 
88  /**  /**
89   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
90   *   *
91   * &lt;ul&gt;   * <p>
92     * <b>Modes:</b> (these are proposals, more or less...)
93   * o Pass-Through-Reference: php Object will get passed through all layers   * 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   * o Pass-Through-Memory: reference to a memory area will get used
95   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
96   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
97   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
98   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
99   * &lt;ul&gt;   * </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)
  * &lt;ul&gt;  
103   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
104   * 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
105   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
106   * 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')
107   * 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')
108   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
109   * o 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   * x 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   * o names of global constants where to find these informations   * o names of global constants where to find these informations
116   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * &lt;ul&gt;  
  *  
117   *   *
118   * <b>It can do</b>   * <b>It can do:</b>
119   * - builds a larger locator from a minimum of information passed in via constructor-arguments   * - 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   * - 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   * - 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',]
# Line 113  Line 135 
135   *    );   *    );
136   *    $source = ne w 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 = ne w 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 141  Line 163 
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      *      *
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.19
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed