24 |
* $Id$ |
* $Id$ |
25 |
* |
* |
26 |
* $Log$ |
* $Log$ |
27 |
|
* Revision 1.12 2003/03/11 01:10:00 joko |
28 |
|
* + fixed metadata for phpDocumentor |
29 |
|
* |
30 |
* Revision 1.11 2003/03/11 00:12:49 joko |
* Revision 1.11 2003/03/11 00:12:49 joko |
31 |
* + fixed metadata for phpDocumentor |
* + fixed metadata for phpDocumentor |
32 |
* |
* |
67 |
/** |
/** |
68 |
* It helps DataSource::Generic working in different "operation modes". |
* It helps DataSource::Generic working in different "operation modes". |
69 |
* |
* |
70 |
|
* <p> |
71 |
|
* <ul> |
72 |
* o Pass-Through-Reference: php Object will get passed through all layers |
* o Pass-Through-Reference: php Object will get passed through all layers |
73 |
* o Pass-Through-Memory: reference to a memory area will get used |
* o Pass-Through-Memory: reference to a memory area will get used |
74 |
* + Build-Locator: build locator from datasource-type and adapter-type |
* + Build-Locator: build locator from datasource-type and adapter-type |
75 |
* o Use-Locator: directly use DataSource::Locator instance passed in |
* o Use-Locator: directly use DataSource::Locator instance passed in |
76 |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
77 |
* o Build-AutoLocator: use global constants making up our metadata |
* o Build-AutoLocator: use global constants making up our metadata |
78 |
|
* </ul> |
79 |
|
* </p> |
80 |
* |
* |
81 |
* |
* <p> |
82 |
* <b>It can/should contain:</b> |
* <b>It can/should contain:</b> |
83 |
* (flexible, just some parameters are required for each operation mode) |
* (flexible, just some parameters are required for each operation mode) |
84 |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
95 |
* by the DataSource::Generic at runtime |
* by the DataSource::Generic at runtime |
96 |
* o names of global constants where to find these informations |
* o names of global constants where to find these informations |
97 |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
98 |
|
* </p> |
99 |
* |
* |
100 |
* |
* <p> |
101 |
* <b>It can do</b> |
* <b>It can do</b> |
102 |
* - 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 |
103 |
* - 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 |
104 |
* - direct fallback mode to some predefined values if just *everything* fails |
* - direct fallback mode to some predefined values if just *everything* fails |
105 |
|
* </p> |
106 |
* |
* |
107 |
* |
* <p> |
108 |
* <b>How to use?</b> |
* <b>How to use?</b> |
109 |
* |
* |
110 |
* Pass an array holding "locator metadata" to the constructor. |
* Pass an array holding "locator metadata" to the constructor. |
131 |
* $source = ne w DataSource::Generic($locator); |
* $source = ne w DataSource::Generic($locator); |
132 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
133 |
* </code> |
* </code> |
134 |
|
* </p> |
135 |
* |
* |
136 |
* |
* |
137 |
* |
* |
155 |
* using metadata from $_options and some |
* using metadata from $_options and some |
156 |
* other presets. |
* other presets. |
157 |
* |
* |
158 |
* @see function build, which acts as a dispatcher |
* @see build, which acts as a dispatcher |
159 |
* depending on $_options[datasource]. |
* depending on $_options[datasource]. |
160 |
* (main dispatching level) |
* (main dispatching level) |
161 |
* |
* |
162 |
|
* <pre> |
163 |
* The structure of a full blown locator looks like this: |
* The structure of a full blown locator looks like this: |
164 |
* |
* |
165 |
* <code> |
* <code> |
190 |
* ) |
* ) |
191 |
* ); |
* ); |
192 |
* </code> |
* </code> |
193 |
|
* </pre> |
194 |
* |
* |
195 |
* @deprecated |
* @deprecated |
196 |
* |
* |