/[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.8 by joko, Sun Mar 9 15:50:36 2003 UTC revision 1.12 by joko, Tue Mar 11 01:10:00 2003 UTC
# Line 12  Line 12 
12   * @author Andreas Motl <andreas.motl@ilo.de>   * @author Andreas Motl <andreas.motl@ilo.de>
13   * @package org.netfrag.glib   * @package org.netfrag.glib
14   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
15   *   *
16   *   *
17     */
18    
19    
20    /**
21   * <b>Cvs-Log:</b>   * <b>Cvs-Log:</b>
22   *   *
23   * <pre>   * <pre>
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.12  2003/03/11 01:10:00  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.11  2003/03/11 00:12:49  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.10  2003/03/10 23:25:03  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.9  2003/03/10 22:31:55  joko
37     * + fixed metadata for phpDocumentor
38     *
39   * Revision 1.8  2003/03/09 15:50:36  joko   * Revision 1.8  2003/03/09 15:50:36  joko
40   * + additional metadata for Autodia   * + additional metadata for Autodia
41   *   *
# Line 52  Line 67 
67  /**  /**
68   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
69   *   *
70     * <p>
71   * <ul>   * <ul>
72   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
73   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
74   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
75   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
76   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
77   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
78   * </ul>   * </ul>
79     * </p>
80   *   *
81   *   * <p>
82   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
83   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
  * <ul>  
84   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
85   * x name of a Proxy module to use to *wrap/hide* the connection/transport-layer   * + (x) name of a Proxy module to use to *wrap/hide* the connection/transport-layer
86   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
87   * x metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')   * + (x) metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')
88   * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')   * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
89   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
90   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
91   *   this will be mapped to a module name and used as a *Proxy*   *   this will be mapped to a module name and used as a *Proxy*
92   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
93   * x an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
94   *   this will be mapped to a module name and used as an *Adapter*   *   this will be mapped to a module name and used as an *Adapter*
95   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
96   * o names of global constants where to find these informations   * o names of global constants where to find these informations
97   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
98   * </ul>   * </p>
  *  
99   *   *
100     * <p>
101   * <b>It can do</b>   * <b>It can do</b>
102   * <ul>   * - builds a larger locator from a minimum of information passed in via constructor-arguments
103   * # builds a larger locator from a minimum of information passed in via constructor-arguments   * - direct fallback mode to some predefined constant names if locator is empty and above method fails
104   * o direct fallback mode to some predefined constant names if locator is empty and above method fails   * - direct fallback mode to some predefined values if just *everything* fails
105   * o direct fallback mode to some predefined values if just *everything* fails   * </p>
  * </ul>  
  *  
106   *   *
107     * <p>
108   * <b>How to use?</b>   * <b>How to use?</b>
109   *   *
110   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
# Line 116  Line 131 
131   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
132   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
133   *    </code>   *    </code>
134     * </p>
135   *   *
136   *   *
137   *   *
# Line 139  class DataSource_Locator { Line 155  class DataSource_Locator {
155      * using metadata from $_options and some      * using metadata from $_options and some
156      * other presets.      * other presets.
157      *      *
158      * @see function build, which acts as a dispatcher      * @see build, which acts as a dispatcher
159      * depending on $_options[datasource].      * depending on $_options[datasource].
160      * (main dispatching level)      * (main dispatching level)
161      *      *
162        * <pre>
163      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
164      *      *
165      * <code>      * <code>
# Line 173  class DataSource_Locator { Line 190  class DataSource_Locator {
190      *    )      *    )
191      *  );      *  );
192      * </code>      * </code>
193        * </pre>
194      *      *
195      * @deprecated      * @deprecated
196      *      *
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.12
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed