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 |
* Revision 1.13 2003/03/11 02:04:37 joko |
55 |
* + fixed metadata for phpDocumentor |
* + fixed metadata for phpDocumentor |
56 |
* |
* |
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') |
124 |
* |
* |
125 |
* <b>It can do</b> |
* <b>It can do:</b> |
126 |
* - builds a larger locator from a minimum of information passed in via constructor-arguments |
* - 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 |
* - 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 |
* - direct fallback mode to some predefined values if just *everything* fails |
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 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> |
* <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): |
213 |
* ) |
* ) |
214 |
* ); |
* ); |
215 |
* </code> |
* </code> |
|
* </pre> |
|
216 |
* |
* |
217 |
* @deprecated |
* @deprecated |
218 |
* |
* |