/[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.24 by joko, Tue Mar 11 04:49:25 2003 UTC
# Line 24  Line 24 
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.24  2003/03/11 04:49:25  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.23  2003/03/11 04:15:01  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.22  2003/03/11 04:03:54  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.21  2003/03/11 03:23:36  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.20  2003/03/11 03:17:37  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.19  2003/03/11 03:05:01  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.18  2003/03/11 02:42:51  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.17  2003/03/11 02:34:55  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.16  2003/03/11 02:28:12  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.15  2003/03/11 02:23:03  joko
55     * + fixed metadata for phpDocumentor
56     *
57     * Revision 1.14  2003/03/11 02:14:24  joko
58     * + fixed metadata for phpDocumentor
59     *
60     * Revision 1.13  2003/03/11 02:04:37  joko
61     * + fixed metadata for phpDocumentor
62     *
63   * Revision 1.12  2003/03/11 01:10:00  joko   * Revision 1.12  2003/03/11 01:10:00  joko
64   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
65   *   *
# Line 67  Line 103 
103  /**  /**
104   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
105   *   *
106   * <p>   * <b>Modes:</b> (these are proposals, more or less...)
  * <ul>  
107   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
108   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
109   * + Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
110   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
111   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
112   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
  * </ul>  
  * </p>  
113   *   *
  * <p>  
114   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
115   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
116   * 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 127 
127   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
128   * o names of global constants where to find these informations   * o names of global constants where to find these informations
129   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * </p>  
130   *   *
131   * <p>   * <b>It can do:</b>
  * <b>It can do</b>  
132   * - 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
133   * - 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
134   * - direct fallback mode to some predefined values if just *everything* fails   * - direct fallback mode to some predefined values if just *everything* fails
  * </p>  
135   *   *
  * <p>  
136   * <b>How to use?</b>   * <b>How to use?</b>
137   *   *
138   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
139   * This module takes care of the rest.   * This module takes care of the rest.
  *  
140   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
141   *   *
142   *  1. for doing rpc-calls....   * <code>
143   *    <code>   *    // 1. for doing rpc-calls....
144   *    $locator = array(   *    $locator = array(
145   *      datasource_type => 'rpc',   *      datasource_type =&gt;&gt; 'rpc',
146   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
147   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
148   *    );   *    );
149   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
150   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
151   *    </code>   * </code>
152   *   * <code>
153   *  2. [proposal] for common/oldschool datahandles....   *    // 2. [proposal] for common/oldschool datahandles....
  *    <code>  
154   *    $locator = array(   *    $locator = array(
155   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
156   *    );   *    );
157   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
158   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
159   *    </code>   * </code>
  * </p>  
160   *   *
161   *   *
162   *   *
# Line 150  Line 175 
175  class DataSource_Locator {  class DataSource_Locator {
176    
177    /**    /**
178      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
179        *
180      * which is built from some predefined rules      * which is built from some predefined rules
181      * using metadata from $_options and some      * using metadata from $_options and some
182      * other presets.      * other presets.
183      *      *
184      * @see build, which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
185      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
186      * (main dispatching level)      * (main dispatching level)
187      *      *
188      * <pre>      * <br>
     * The structure of a full blown locator looks like this:  
189      *      *
190        * The structure of a full blown locator looks like this:
191      * <code>      * <code>
192      *  $locator = array(      *  $locator = array(
193      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
# Line 190  class DataSource_Locator { Line 216  class DataSource_Locator {
216      *    )      *    )
217      *  );      *  );
218      * </code>      * </code>
     * </pre>  
219      *      *
220      * @deprecated      * @deprecated
221      *      *
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.24
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed