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