/[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.6 by joko, Wed Mar 5 16:10:08 2003 UTC revision 1.15 by joko, Tue Mar 11 02:23:03 2003 UTC
# Line 9  Line 9 
9   * to be informed about the most important stuff it   * to be informed about the most important stuff it
10   * has to do.   * has to do.
11   *   *
  *  
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   * @module DataSource::Locator   * @name DataSource::Locator
15     *
16   *   *
17   */   */
18    
19    
20  /**  /**
21     * <b>Cvs-Log:</b>
22     *
23     * <pre>
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.15  2003/03/11 02:23:03  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.14  2003/03/11 02:14:24  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.13  2003/03/11 02:04:37  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.12  2003/03/11 01:10:00  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.11  2003/03/11 00:12:49  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.10  2003/03/10 23:25:03  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.9  2003/03/10 22:31:55  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.8  2003/03/09 15:50:36  joko
49     * + additional metadata for Autodia
50     *
51     * Revision 1.7  2003/03/05 17:13:16  joko
52     * updated docu (phpDocumentor testing....)
53     *
54   * Revision 1.6  2003/03/05 16:10:08  joko   * Revision 1.6  2003/03/05 16:10:08  joko
55   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
56   *   *
# Line 37  Line 68 
68   *   *
69   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
70   * + initial commit   * + initial commit
71     * </pre>
72   *   *
73   *   *
74   */   */
# Line 44  Line 76 
76  /**  /**
77   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
78   *   *
79   * - Pass-Through-Reference: php Object will get passed through all layers   * <b>Modes:</b> (these are proposals, more or less...)
80   * - Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Reference: php Object will get passed through all layers
81     * o Pass-Through-Memory: reference to a memory area will get used
82   * + Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
83   * - Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
84   * - Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
85   * - Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
86   *   *
87   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
  *  
  * <pre>  
88   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
89   * - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
90   * + 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
91   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
92   * + 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')
93   * - 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')
94   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
95   * - a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
96   *   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*
97   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
98   * + an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
99   *   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*
100   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
101   * - names of global constants where to find these informations   * o names of global constants where to find these informations
102   * - datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * </pre>  
  *  
  *  
  * <b>It can do</b>  
  * + builds a larger locator from a minimum of information passed in via constructor-arguments  
  * o direct fallback mode to some predefined constant names if locator is empty and above method fails  
  * o direct fallback mode to some predefined values if just *everything* fails  
103   *   *
104     * <b>It can do:</b>
105     * - builds a larger locator from a minimum of information passed in via constructor-arguments
106     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
107     * - direct fallback mode to some predefined values if just *everything* fails
108   *   *
109   * <b>How to use?</b>   * <b>How to use?</b>
110   *   *
# Line 85  Line 113 
113   *   *
114   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
115   *   *
116     * <pre>
117   *  1. for doing rpc-calls....   *  1. for doing rpc-calls....
118   *    <code>   *    <code>
119   *    $locator = array(   *    $locator = array(
# Line 92  Line 121 
121   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
122   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
123   *    );   *    );
124   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
125   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
126   *    </code>   *    </code>
127   *   *
# Line 101  Line 130 
130   *    $locator = array(   *    $locator = array(
131   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
132   *    );   *    );
133   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
134   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
135   *    </code>   *    </code>
136     * </pre>
137   *   *
138   *   *
139   *   *
# Line 114  Line 144 
144   * @license GNU LGPL (GNU Lesser General Public License)   * @license GNU LGPL (GNU Lesser General Public License)
145   * @link http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
146   *   *
147     * @package org.netfrag.glib
148     * @subpackage DataSource
149   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
150   *   *
151   */   */
   
   
152  class DataSource_Locator {  class DataSource_Locator {
153    
154    /**    /**
# Line 128  class DataSource_Locator { Line 157  class DataSource_Locator {
157      * using metadata from $_options and some      * using metadata from $_options and some
158      * other presets.      * other presets.
159      *      *
160      * @see function build, which acts as a dispatcher      * @see build, which acts as a dispatcher
161      * depending on $_options[datasource].      * depending on $_options[datasource].
162      * (main dispatching level)      * (main dispatching level)
163      *      *
164        * <pre>
165      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
166      *      *
167      * <code>      * <code>
# Line 162  class DataSource_Locator { Line 192  class DataSource_Locator {
192      *    )      *    )
193      *  );      *  );
194      * </code>      * </code>
195        * </pre>
196      *      *
197      * @deprecated      * @deprecated
198      *      *
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.15
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed