24 |
* $Id$ |
* $Id$ |
25 |
* |
* |
26 |
* $Log$ |
* $Log$ |
27 |
|
* Revision 1.25 2003/03/11 16:28:25 joko |
28 |
|
* + fixed metadata for phpDocumentor |
29 |
|
* |
30 |
|
* Revision 1.24 2003/03/11 04:49:25 joko |
31 |
|
* + fixed metadata for phpDocumentor |
32 |
|
* |
33 |
|
* Revision 1.23 2003/03/11 04:15:01 joko |
34 |
|
* + fixed metadata for phpDocumentor |
35 |
|
* |
36 |
|
* Revision 1.22 2003/03/11 04:03:54 joko |
37 |
|
* + fixed metadata for phpDocumentor |
38 |
|
* |
39 |
|
* Revision 1.21 2003/03/11 03:23:36 joko |
40 |
|
* + fixed metadata for phpDocumentor |
41 |
|
* |
42 |
|
* Revision 1.20 2003/03/11 03:17:37 joko |
43 |
|
* + fixed metadata for phpDocumentor |
44 |
|
* |
45 |
|
* Revision 1.19 2003/03/11 03:05:01 joko |
46 |
|
* + fixed metadata for phpDocumentor |
47 |
|
* |
48 |
|
* Revision 1.18 2003/03/11 02:42:51 joko |
49 |
|
* + fixed metadata for phpDocumentor |
50 |
|
* |
51 |
|
* Revision 1.17 2003/03/11 02:34:55 joko |
52 |
|
* + fixed metadata for phpDocumentor |
53 |
|
* |
54 |
|
* Revision 1.16 2003/03/11 02:28:12 joko |
55 |
|
* + fixed metadata for phpDocumentor |
56 |
|
* |
57 |
|
* Revision 1.15 2003/03/11 02:23:03 joko |
58 |
|
* + fixed metadata for phpDocumentor |
59 |
|
* |
60 |
|
* Revision 1.14 2003/03/11 02:14:24 joko |
61 |
|
* + fixed metadata for phpDocumentor |
62 |
|
* |
63 |
|
* Revision 1.13 2003/03/11 02:04:37 joko |
64 |
|
* + fixed metadata for phpDocumentor |
65 |
|
* |
66 |
* Revision 1.12 2003/03/11 01:10:00 joko |
* Revision 1.12 2003/03/11 01:10:00 joko |
67 |
* + fixed metadata for phpDocumentor |
* + fixed metadata for phpDocumentor |
68 |
* |
* |
106 |
/** |
/** |
107 |
* It helps DataSource::Generic working in different "operation modes". |
* It helps DataSource::Generic working in different "operation modes". |
108 |
* |
* |
109 |
* <p> |
* <b>Modes:</b> (these are proposals, more or less...) |
|
* <ul> |
|
110 |
* o Pass-Through-Reference: php Object will get passed through all layers |
* o Pass-Through-Reference: php Object will get passed through all layers |
111 |
* o Pass-Through-Memory: reference to a memory area will get used |
* o Pass-Through-Memory: reference to a memory area will get used |
112 |
* + Build-Locator: build locator from datasource-type and adapter-type |
* + Build-Locator: build locator from datasource-type and adapter-type |
113 |
* o Use-Locator: directly use DataSource::Locator instance passed in |
* o Use-Locator: directly use DataSource::Locator instance passed in |
114 |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
115 |
* o Build-AutoLocator: use global constants making up our metadata |
* o Build-AutoLocator: use global constants making up our metadata |
|
* </ul> |
|
|
* </p> |
|
116 |
* |
* |
|
* <p> |
|
117 |
* <b>It can/should contain:</b> |
* <b>It can/should contain:</b> |
118 |
* (flexible, just some parameters are required for each operation mode) |
* (flexible, just some parameters are required for each operation mode) |
119 |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
130 |
* by the DataSource::Generic at runtime |
* by the DataSource::Generic at runtime |
131 |
* o names of global constants where to find these informations |
* o names of global constants where to find these informations |
132 |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
|
* </p> |
|
133 |
* |
* |
134 |
* <p> |
* <b>It can do:</b> |
|
* <b>It can do</b> |
|
135 |
* - 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 |
136 |
* - 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 |
137 |
* - direct fallback mode to some predefined values if just *everything* fails |
* - direct fallback mode to some predefined values if just *everything* fails |
|
* </p> |
|
138 |
* |
* |
|
* <p> |
|
139 |
* <b>How to use?</b> |
* <b>How to use?</b> |
140 |
* |
* |
141 |
* Pass an array holding "locator metadata" to the constructor. |
* Pass an array holding "locator metadata" to the constructor. |
142 |
* This module takes care of the rest. |
* This module takes care of the rest. |
|
* |
|
143 |
* Pass an array to the constructor: (e.g.) |
* Pass an array to the constructor: (e.g.) |
144 |
* |
* |
145 |
* 1. for doing rpc-calls.... |
* <code> |
146 |
* <code> |
* <?php |
147 |
|
* // 1. for doing rpc-calls.... |
148 |
* $locator = array( |
* $locator = array( |
149 |
* datasource_type => 'rpc', |
* datasource_type =>> 'rpc', |
150 |
* [adapter_type => 'phpHtmlLib',] |
* [adapter_type => 'phpHtmlLib',] |
151 |
* metadata => array( Host => 'localhost', Port => '8765' ), |
* metadata => array( Host => 'localhost', Port => '8765' ), |
152 |
* ); |
* ); |
153 |
* $source = ne w DataSource::Generic($locator); |
* $source = ne w DataSource::Generic($locator); |
154 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
155 |
* </code> |
* ?> |
156 |
* |
* </code> |
157 |
* 2. [proposal] for common/oldschool datahandles.... |
* <code> |
158 |
* <code> |
* <?php |
159 |
|
* // 2. [proposal] for common/oldschool datahandles.... |
160 |
* $locator = array( |
* $locator = array( |
161 |
* dsn => 'known dsn markup', |
* dsn => 'known dsn markup', |
162 |
* ); |
* ); |
163 |
* $source = ne w DataSource::Generic($locator); |
* $source = ne w DataSource::Generic($locator); |
164 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
165 |
* </code> |
* ?> |
166 |
* </p> |
* </code> |
167 |
* |
* |
168 |
* |
* |
169 |
* |
* |
182 |
class DataSource_Locator { |
class DataSource_Locator { |
183 |
|
|
184 |
/** |
/** |
185 |
* This var holds the locator metadata hash |
* This var holds the locator metadata hash, |
186 |
|
* |
187 |
* which is built from some predefined rules |
* which is built from some predefined rules |
188 |
* using metadata from $_options and some |
* using metadata from $_options and some |
189 |
* other presets. |
* other presets. |
190 |
* |
* |
191 |
* @see build, which acts as a dispatcher |
* See {@link build}, which acts as a dispatcher |
192 |
* depending on $_options[datasource]. |
* depending on $_options[datasource]. <br> |
193 |
* (main dispatching level) |
* (main dispatching level) |
194 |
* |
* |
195 |
* <pre> |
* <br> |
|
* The structure of a full blown locator looks like this: |
|
196 |
* |
* |
197 |
|
* The structure of a full blown locator looks like this: |
198 |
* <code> |
* <code> |
199 |
* $locator = array( |
* $locator = array( |
200 |
* type => '<your type specifying the datasource-type>', |
* type => '<your type specifying the datasource-type>', |
223 |
* ) |
* ) |
224 |
* ); |
* ); |
225 |
* </code> |
* </code> |
|
* </pre> |
|
226 |
* |
* |
227 |
* @deprecated |
* @deprecated |
228 |
* |
* |