/[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.15 by joko, Tue Mar 11 02:23:03 2003 UTC revision 1.21 by joko, Tue Mar 11 03:23:36 2003 UTC
# Line 24  Line 24 
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.21  2003/03/11 03:23:36  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.20  2003/03/11 03:17:37  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.19  2003/03/11 03:05:01  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.18  2003/03/11 02:42:51  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.17  2003/03/11 02:34:55  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.16  2003/03/11 02:28:12  joko
43     * + fixed metadata for phpDocumentor
44     *
45   * Revision 1.15  2003/03/11 02:23:03  joko   * Revision 1.15  2003/03/11 02:23:03  joko
46   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
47   *   *
# Line 76  Line 94 
94  /**  /**
95   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
96   *   *
97     * <p>
98   * <b>Modes:</b> (these are proposals, more or less...)   * <b>Modes:</b> (these are proposals, more or less...)
99   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
100   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
# Line 83  Line 102 
102   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
103   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
104   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
105     * </p>
106   *   *
107   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
108   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
# Line 110  Line 130 
130   *   *
131   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
132   * This module takes care of the rest.   * This module takes care of the rest.
  *  
133   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
134   *   *
135   * <pre>   * 1. for doing rpc-calls....
136   *  1. for doing rpc-calls....   * <code>
  *    <code>  
137   *    $locator = array(   *    $locator = array(
138   *      datasource_type => 'rpc',   *      datasource_type => 'rpc',
139   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
# Line 123  Line 141 
141   *    );   *    );
142   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
143   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
144   *    </code>   * </code>
145   *   *
146   *  2. [proposal] for common/oldschool datahandles....   *  2. [proposal] for common/oldschool datahandles....
147   *    <code>   * <code>
148   *    $locator = array(   *    $locator = array(
149   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
150   *    );   *    );
151   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
152   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
153   *    </code>   * </code>
  * </pre>  
154   *   *
155   *   *
156   *   *
# Line 152  Line 169 
169  class DataSource_Locator {  class DataSource_Locator {
170    
171    /**    /**
172      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
173        *
174      * which is built from some predefined rules      * which is built from some predefined rules
175      * using metadata from $_options and some      * using metadata from $_options and some
176      * other presets.      * other presets.
177      *      *
178      * @see build, which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
179      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
180      * (main dispatching level)      * (main dispatching level)
181      *      *
182      * <pre>      * <pre>
183      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
     *  
184      * <code>      * <code>
185      *  $locator = array(      *  $locator = array(
186      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
# Line 173  class DataSource_Locator { Line 190  class DataSource_Locator {
190      *    [dsn => '<your dsn markup>'],      *    [dsn => '<your dsn markup>'],
191      *  );      *  );
192      * </code>      * </code>
193        * </pre>
194      *      *
195      * Example 1 - data is inside a rdbms, using a dsn to connect to it:      * Example 1 - data is inside a rdbms, using a dsn to connect to it:
196      * <code>      * <code>
197        * <pre>
198      *  $locator = array(      *  $locator = array(
199      *    dsn => 'mysql://username:password@localhost/database',      *    dsn => 'mysql://username:password@localhost/database',
200      *  );      *  );
201        * </pre>
202      * </code>      * </code>
203      *      *
204      * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):      * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
# Line 192  class DataSource_Locator { Line 212  class DataSource_Locator {
212      *    )      *    )
213      *  );      *  );
214      * </code>      * </code>
     * </pre>  
215      *      *
216      * @deprecated      * @deprecated
217      *      *
Legend:
Removed from v.1.15  
changed lines
  Added in v.1.21
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed