/[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.16 by joko, Tue Mar 11 02:28:12 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.16  2003/03/11 02:28:12  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.15  2003/03/11 02:23:03  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.14  2003/03/11 02:14:24  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.13  2003/03/11 02:04:37  joko
37     * + fixed metadata for phpDocumentor
38     *
39     * Revision 1.12  2003/03/11 01:10:00  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.11  2003/03/11 00:12:49  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.10  2003/03/10 23:25:03  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.9  2003/03/10 22:31:55  joko
49     * + fixed metadata for phpDocumentor
50     *
51   * Revision 1.8  2003/03/09 15:50:36  joko   * Revision 1.8  2003/03/09 15:50:36  joko
52   * + additional metadata for Autodia   * + additional metadata for Autodia
53   *   *
# Line 52  Line 79 
79  /**  /**
80   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
81   *   *
82   * <ul>   * <b>Modes:</b> (these are proposals, more or less...)
83   * o Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
84   * o Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
85   * x Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
86   * o Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
87   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
88   * o Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
  * </ul>  
  *  
89   *   *
90   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
91   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
  * <ul>  
92   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
93   * 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
94   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
95   * 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')
96   * 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')
97   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
98   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
99   *   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*
100   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
101   * x an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
102   *   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*
103   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
104   * o names of global constants where to find these informations   * o names of global constants where to find these informations
105   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
  * </ul>  
  *  
  *  
  * <b>It can do</b>  
  * <ul>  
  * # 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  
  * </ul>  
106   *   *
107     * <b>It can do:</b>
108     * - builds a larger locator from a minimum of information passed in via constructor-arguments
109     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
110     * - direct fallback mode to some predefined values if just *everything* fails
111   *   *
112   * <b>How to use?</b>   * <b>How to use?</b>
113   *   *
# Line 97  Line 116 
116   *   *
117   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
118   *   *
119     * <p>
120   *  1. for doing rpc-calls....   *  1. for doing rpc-calls....
121   *    <code>   *    <code>
122   *    $locator = array(   *    $locator = array(
# Line 116  Line 136 
136   *    $source = ne w DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
137   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
138   *    </code>   *    </code>
139     * </p>
140   *   *
141   *   *
142   *   *
# Line 134  Line 155 
155  class DataSource_Locator {  class DataSource_Locator {
156    
157    /**    /**
158      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
159        *
160      * which is built from some predefined rules      * which is built from some predefined rules
161      * using metadata from $_options and some      * using metadata from $_options and some
162      * other presets.      * other presets.
163      *      *
164      * @see function build, which acts as a dispatcher      * @see build, which acts as a dispatcher
165      * depending on $_options[datasource].      * depending on $_options[datasource]. (main dispatching level)
     * (main dispatching level)  
166      *      *
167        * <pre>
168      * The structure of a full blown locator looks like this:      * The structure of a full blown locator looks like this:
169      *      *
170      * <code>      * <code>
# Line 173  class DataSource_Locator { Line 195  class DataSource_Locator {
195      *    )      *    )
196      *  );      *  );
197      * </code>      * </code>
198        * </pre>
199      *      *
200      * @deprecated      * @deprecated
201      *      *

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.16

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed