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