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.22 2003/03/11 04:03:54 joko |
28 |
|
* + fixed metadata for phpDocumentor |
29 |
|
* |
30 |
|
* Revision 1.21 2003/03/11 03:23:36 joko |
31 |
|
* + fixed metadata for phpDocumentor |
32 |
|
* |
33 |
|
* Revision 1.20 2003/03/11 03:17:37 joko |
34 |
|
* + fixed metadata for phpDocumentor |
35 |
|
* |
36 |
|
* Revision 1.19 2003/03/11 03:05:01 joko |
37 |
|
* + fixed metadata for phpDocumentor |
38 |
|
* |
39 |
|
* Revision 1.18 2003/03/11 02:42:51 joko |
40 |
|
* + fixed metadata for phpDocumentor |
41 |
|
* |
42 |
|
* Revision 1.17 2003/03/11 02:34:55 joko |
43 |
|
* + fixed metadata for phpDocumentor |
44 |
|
* |
45 |
|
* Revision 1.16 2003/03/11 02:28:12 joko |
46 |
|
* + fixed metadata for phpDocumentor |
47 |
|
* |
48 |
|
* Revision 1.15 2003/03/11 02:23:03 joko |
49 |
|
* + fixed metadata for phpDocumentor |
50 |
|
* |
51 |
|
* Revision 1.14 2003/03/11 02:14:24 joko |
52 |
|
* + fixed metadata for phpDocumentor |
53 |
|
* |
54 |
|
* Revision 1.13 2003/03/11 02:04:37 joko |
55 |
|
* + fixed metadata for phpDocumentor |
56 |
|
* |
57 |
|
* Revision 1.12 2003/03/11 01:10:00 joko |
58 |
|
* + fixed metadata for phpDocumentor |
59 |
|
* |
60 |
|
* Revision 1.11 2003/03/11 00:12:49 joko |
61 |
|
* + fixed metadata for phpDocumentor |
62 |
|
* |
63 |
|
* Revision 1.10 2003/03/10 23:25:03 joko |
64 |
|
* + fixed metadata for phpDocumentor |
65 |
|
* |
66 |
|
* Revision 1.9 2003/03/10 22:31:55 joko |
67 |
|
* + fixed metadata for phpDocumentor |
68 |
|
* |
69 |
* Revision 1.8 2003/03/09 15:50:36 joko |
* Revision 1.8 2003/03/09 15:50:36 joko |
70 |
* + additional metadata for Autodia |
* + additional metadata for Autodia |
71 |
* |
* |
97 |
/** |
/** |
98 |
* It helps DataSource::Generic working in different "operation modes". |
* It helps DataSource::Generic working in different "operation modes". |
99 |
* |
* |
100 |
* <ul> |
* <b>Modes:</b> (these are proposals, more or less...) |
101 |
* o Pass-Through-Reference: php Object will get passed through all layers |
* o Pass-Through-Reference: php Object will get passed through all layers |
102 |
* o Pass-Through-Memory: reference to a memory area will get used |
* o Pass-Through-Memory: reference to a memory area will get used |
103 |
* x Build-Locator: build locator from datasource-type and adapter-type |
* + Build-Locator: build locator from datasource-type and adapter-type |
104 |
* o Use-Locator: directly use DataSource::Locator instance passed in |
* o Use-Locator: directly use DataSource::Locator instance passed in |
105 |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
106 |
* o Build-AutoLocator: use global constants making up our metadata |
* o Build-AutoLocator: use global constants making up our metadata |
|
* </ul> |
|
|
* |
|
107 |
* |
* |
108 |
* <b>It can/should contain:</b> |
* <b>It can/should contain:</b> |
109 |
* (flexible, just some parameters are required for each operation mode) |
* (flexible, just some parameters are required for each operation mode) |
|
* <ul> |
|
110 |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
111 |
* 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 |
112 |
* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy) |
* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy) |
113 |
* 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') |
114 |
* 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') |
115 |
* this will get propagated (pass-through-mode) |
* this will get propagated (pass-through-mode) |
116 |
* o a datasource-type (of 'rpc|mysql|csv-file|xml-file') |
* o a datasource-type (of 'rpc|mysql|csv-file|xml-file') |
117 |
* 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* |
118 |
* by the DataSource::Generic at runtime |
* by the DataSource::Generic at runtime |
119 |
* x an adapter-type (of 'phpHtmlLib|pear') |
* + (x) an adapter-type (of 'phpHtmlLib|pear') |
120 |
* 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* |
121 |
* by the DataSource::Generic at runtime |
* by the DataSource::Generic at runtime |
122 |
* o names of global constants where to find these informations |
* o names of global constants where to find these informations |
123 |
* 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> |
|
124 |
* |
* |
125 |
|
* <b>It can do:</b> |
126 |
|
* - builds a larger locator from a minimum of information passed in via constructor-arguments |
127 |
|
* - direct fallback mode to some predefined constant names if locator is empty and above method fails |
128 |
|
* - direct fallback mode to some predefined values if just *everything* fails |
129 |
* |
* |
130 |
* <b>How to use?</b> |
* <b>How to use?</b> |
131 |
* |
* |
132 |
* Pass an array holding "locator metadata" to the constructor. |
* Pass an array holding "locator metadata" to the constructor. |
133 |
* This module takes care of the rest. |
* This module takes care of the rest. |
|
* |
|
134 |
* Pass an array to the constructor: (e.g.) |
* Pass an array to the constructor: (e.g.) |
135 |
* |
* |
136 |
* 1. for doing rpc-calls.... |
* <code> |
137 |
* <code> |
* // 1. for doing rpc-calls.... |
138 |
* $locator = array( |
* $locator = array( |
139 |
* datasource_type => 'rpc', |
* datasource_type => 'rpc', |
140 |
* [adapter_type => 'phpHtmlLib',] |
* [adapter_type => 'phpHtmlLib',] |
142 |
* ); |
* ); |
143 |
* $source = ne w DataSource::Generic($locator); |
* $source = ne w DataSource::Generic($locator); |
144 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
145 |
* </code> |
* </code> |
146 |
* |
* |
147 |
* 2. [proposal] for common/oldschool datahandles.... |
* <code> |
148 |
* <code> |
* // 2. [proposal] for common/oldschool datahandles.... |
149 |
* $locator = array( |
* $locator = array( |
150 |
* dsn => 'known dsn markup', |
* dsn => 'known dsn markup', |
151 |
* ); |
* ); |
152 |
* $source = ne w DataSource::Generic($locator); |
* $source = ne w DataSource::Generic($locator); |
153 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
154 |
* </code> |
* </code> |
155 |
* |
* |
156 |
* |
* |
157 |
* |
* |
170 |
class DataSource_Locator { |
class DataSource_Locator { |
171 |
|
|
172 |
/** |
/** |
173 |
* This var holds the locator metadata hash |
* This var holds the locator metadata hash, |
174 |
|
* |
175 |
* which is built from some predefined rules |
* which is built from some predefined rules |
176 |
* using metadata from $_options and some |
* using metadata from $_options and some |
177 |
* other presets. |
* other presets. |
178 |
* |
* |
179 |
* @see function build, which acts as a dispatcher |
* See {@link build}, which acts as a dispatcher |
180 |
* depending on $_options[datasource]. |
* depending on $_options[datasource]. <br> |
181 |
* (main dispatching level) |
* (main dispatching level) |
182 |
* |
* |
183 |
|
* <pre> |
184 |
* The structure of a full blown locator looks like this: |
* The structure of a full blown locator looks like this: |
|
* |
|
185 |
* <code> |
* <code> |
186 |
* $locator = array( |
* $locator = array( |
187 |
* type => '<your type specifying the datasource-type>', |
* type => '<your type specifying the datasource-type>', |
191 |
* [dsn => '<your dsn markup>'], |
* [dsn => '<your dsn markup>'], |
192 |
* ); |
* ); |
193 |
* </code> |
* </code> |
194 |
|
* </pre> |
195 |
* |
* |
196 |
* Example 1 - data is inside a rdbms, using a dsn to connect to it: |
* Example 1 - data is inside a rdbms, using a dsn to connect to it: |
197 |
* <code> |
* <code> |
198 |
|
* <pre> |
199 |
* $locator = array( |
* $locator = array( |
200 |
* dsn => 'mysql://username:password@localhost/database', |
* dsn => 'mysql://username:password@localhost/database', |
201 |
* ); |
* ); |
202 |
|
* </pre> |
203 |
* </code> |
* </code> |
204 |
* |
* |
205 |
* Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc): |
* Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc): |