/[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.7 by joko, Wed Mar 5 17:13:16 2003 UTC revision 1.13 by joko, Tue Mar 11 02:04:37 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.13  2003/03/11 02:04:37  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.12  2003/03/11 01:10:00  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.11  2003/03/11 00:12:49  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.10  2003/03/10 23:25:03  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.9  2003/03/10 22:31:55  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.8  2003/03/09 15:50:36  joko
43     * + additional metadata for Autodia
44     *
45   * Revision 1.7  2003/03/05 17:13:16  joko   * Revision 1.7  2003/03/05 17:13:16  joko
46   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
47   *   *
# Line 49  Line 70 
70  /**  /**
71   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
72   *   *
73   * <ul>   * <b>Modes:</b> (these are proposals, more or less...)
74   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
75   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
76   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
77   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
78   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
79   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
  * </ul>  
  *  
80   *   *
81   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
82   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
  * <ul>  
83   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
84   * 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
85   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
86   * 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')
87   * 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')
88   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
89   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
90   *   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*
91   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
92   * x an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
93   *   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*
94   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
95   * o names of global constants where to find these informations   * o names of global constants where to find these informations
96   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * </ul>  
  *  
97   *   *
98   * <b>It can do</b>   * <b>It can do</b>
99   * <ul>   * - builds a larger locator from a minimum of information passed in via constructor-arguments
100   * # 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
101   * 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
  * o direct fallback mode to some predefined values if just *everything* fails  
  * </ul>  
  *  
102   *   *
103   * <b>How to use?</b>   * <b>How to use?</b>
104   *   *
# Line 101  Line 114 
114   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
115   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
116   *    );   *    );
117   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
118   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
119   *    </code>   *    </code>
120   *   *
# Line 110  Line 123 
123   *    $locator = array(   *    $locator = array(
124   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
125   *    );   *    );
126   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
127   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
128   *    </code>   *    </code>
129   *   *
# Line 136  class DataSource_Locator { Line 149  class DataSource_Locator {
149      * using metadata from $_options and some      * using metadata from $_options and some
150      * other presets.      * other presets.
151      *      *
152      * @see function build, which acts as a dispatcher      * @see build, which acts as a dispatcher
153      * depending on $_options[datasource].      * depending on $_options[datasource].
154      * (main dispatching level)      * (main dispatching level)
155      *      *
156        * <pre>
157      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
158      *      *
159      * <code>      * <code>
# Line 170  class DataSource_Locator { Line 184  class DataSource_Locator {
184      *    )      *    )
185      *  );      *  );
186      * </code>      * </code>
187        * </pre>
188      *      *
189      * @deprecated      * @deprecated
190      *      *
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.13
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed