/[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.12 by joko, Tue Mar 11 01:10:00 2003 UTC revision 1.17 by joko, Tue Mar 11 02:34:55 2003 UTC
# Line 24  Line 24 
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.17  2003/03/11 02:34:55  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.16  2003/03/11 02:28:12  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.15  2003/03/11 02:23:03  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.14  2003/03/11 02:14:24  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.13  2003/03/11 02:04:37  joko
40     * + fixed metadata for phpDocumentor
41     *
42   * Revision 1.12  2003/03/11 01:10:00  joko   * Revision 1.12  2003/03/11 01:10:00  joko
43   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
44   *   *
# Line 67  Line 82 
82  /**  /**
83   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
84   *   *
85   * <p>   * <b>Modes:</b> (these are proposals, more or less...)
  * <ul>  
86   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
87   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
88   * + Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
89   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
90   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
91   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
  * </ul>  
  * </p>  
92   *   *
  * <p>  
93   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
94   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
95   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
# Line 95  Line 106 
106   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
107   * o names of global constants where to find these informations   * o names of global constants where to find these informations
108   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * </p>  
109   *   *
110   * <p>   * <b>It can do:</b>
  * <b>It can do</b>  
111   * - 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
112   * - 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
113   * - direct fallback mode to some predefined values if just *everything* fails   * - direct fallback mode to some predefined values if just *everything* fails
  * </p>  
114   *   *
  * <p>  
115   * <b>How to use?</b>   * <b>How to use?</b>
116   *   *
117   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
118   * This module takes care of the rest.   * This module takes care of the rest.
  *  
119   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
120   *   *
121     * <pre>
122   *  1. for doing rpc-calls....   *  1. for doing rpc-calls....
123   *    <code>   *    <code>
124   *    $locator = array(   *    $locator = array(
# Line 131  Line 138 
138   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
139   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
140   *    </code>   *    </code>
141   * </p>   * </pre>
142   *   *
143   *   *
144   *   *
# Line 150  Line 157 
157  class DataSource_Locator {  class DataSource_Locator {
158    
159    /**    /**
160      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
161        *
162      * which is built from some predefined rules      * which is built from some predefined rules
163      * using metadata from $_options and some      * using metadata from $_options and some
164      * other presets.      * other presets.
165      *      *
166      * @see build, which acts as a dispatcher      * @see build, which acts as a dispatcher
167      * depending on $_options[datasource].      * depending on $_options[datasource]. (main dispatching level)
168      * (main dispatching level)      *
169        * <p>
170      *      *
     * <pre>  
171      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
172      *      *
173      * <code>      * <code>
# Line 190  class DataSource_Locator { Line 198  class DataSource_Locator {
198      *    )      *    )
199      *  );      *  );
200      * </code>      * </code>
201      * </pre>      *
202        * </p>
203      *      *
204      * @deprecated      * @deprecated
205      *      *
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.17
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed