/[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.13 by joko, Tue Mar 11 02:04:37 2003 UTC revision 1.23 by joko, Tue Mar 11 04:15:01 2003 UTC
# Line 24  Line 24 
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.23  2003/03/11 04:15:01  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.22  2003/03/11 04:03:54  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.21  2003/03/11 03:23:36  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.20  2003/03/11 03:17:37  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.19  2003/03/11 03:05:01  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.18  2003/03/11 02:42:51  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.17  2003/03/11 02:34:55  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.16  2003/03/11 02:28:12  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.15  2003/03/11 02:23:03  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.14  2003/03/11 02:14:24  joko
55     * + fixed metadata for phpDocumentor
56     *
57   * Revision 1.13  2003/03/11 02:04:37  joko   * Revision 1.13  2003/03/11 02:04:37  joko
58   * + fixed metadata for phpDocumentor   * + fixed metadata for phpDocumentor
59   *   *
# Line 95  Line 125 
125   * o names of global constants where to find these informations   * o names of global constants where to find these informations
126   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
127   *   *
128   * <b>It can do</b>   * <b>It can do:</b>
129   * - 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
130   * - 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
131   * - direct fallback mode to some predefined values if just *everything* fails   * - direct fallback mode to some predefined values if just *everything* fails
# Line 104  Line 134 
134   *   *
135   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
136   * This module takes care of the rest.   * This module takes care of the rest.
  *  
137   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
138   *   *
139   *  1. for doing rpc-calls....   * <code>
140   *    <code>   *    // 1. for doing rpc-calls....
141   *    $locator = array(   *    $locator = array(
142   *      datasource_type => 'rpc',   *      datasource_type =&gt; 'rpc',
143   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
144   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
145   *    );   *    );
146   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
147   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
148   *    </code>   * </code>
149   *   * <code>
150   *  2. [proposal] for common/oldschool datahandles....   *    // 2. [proposal] for common/oldschool datahandles....
  *    <code>  
151   *    $locator = array(   *    $locator = array(
152   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
153   *    );   *    );
154   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
155   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
156   *    </code>   * </code>
157   *   *
158   *   *
159   *   *
# Line 144  Line 172 
172  class DataSource_Locator {  class DataSource_Locator {
173    
174    /**    /**
175      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
176        *
177      * which is built from some predefined rules      * which is built from some predefined rules
178      * using metadata from $_options and some      * using metadata from $_options and some
179      * other presets.      * other presets.
180      *      *
181      * @see build, which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
182      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
183      * (main dispatching level)      * (main dispatching level)
184      *      *
185      * <pre>      * <br>
     * The structure of a full blown locator looks like this:  
186      *      *
187        * The structure of a full blown locator looks like this:
188      * <code>      * <code>
189      *  $locator = array(      *  $locator = array(
190      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
# Line 184  class DataSource_Locator { Line 213  class DataSource_Locator {
213      *    )      *    )
214      *  );      *  );
215      * </code>      * </code>
     * </pre>  
216      *      *
217      * @deprecated      * @deprecated
218      *      *
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.23
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed