5 |
* It acts as a container for DataSource connection |
* It acts as a container for DataSource connection |
6 |
* metadata. Think of it as an enhanced dsn. |
* metadata. Think of it as an enhanced dsn. |
7 |
* |
* |
8 |
* It gets used by DataSource::GenericDataSource |
* It gets used by DataSource::Generic |
9 |
* to be informed about the most important stuff it |
* to be informed about the most important stuff it |
10 |
* has to do. |
* has to do. |
11 |
* |
* |
12 |
* |
* @author Andreas Motl <andreas.motl@ilo.de> |
13 |
* @package org.netfrag.glib |
* @package org.netfrag.glib |
14 |
* @module DataSource::Locator |
* @name DataSource::Locator |
15 |
|
* @filesource |
16 |
* |
* |
17 |
*/ |
* |
18 |
|
* <b>Cvs-Log:</b> |
19 |
/** |
* |
20 |
|
* <pre> |
21 |
* $Id$ |
* $Id$ |
22 |
* |
* |
23 |
* $Log$ |
* $Log$ |
24 |
|
* Revision 1.7 2003/03/05 17:13:16 joko |
25 |
|
* updated docu (phpDocumentor testing....) |
26 |
|
* |
27 |
|
* Revision 1.6 2003/03/05 16:10:08 joko |
28 |
|
* updated docu (phpDocumentor testing....) |
29 |
|
* |
30 |
|
* Revision 1.5 2003/03/05 15:40:39 joko |
31 |
|
* updated docu (phpDocumentor testing....) |
32 |
|
* |
33 |
|
* Revision 1.4 2003/03/05 15:26:23 joko |
34 |
|
* updated docu (phpDocumentor testing....) |
35 |
|
* |
36 |
|
* Revision 1.3 2003/03/05 15:21:54 joko |
37 |
|
* updated docu (phpDocumentor testing....) |
38 |
|
* |
39 |
* Revision 1.2 2003/03/05 15:01:10 joko |
* Revision 1.2 2003/03/05 15:01:10 joko |
40 |
* updated docu |
* updated docu |
41 |
* |
* |
42 |
* Revision 1.1 2003/03/05 12:04:37 joko |
* Revision 1.1 2003/03/05 12:04:37 joko |
43 |
* + initial commit |
* + initial commit |
44 |
|
* </pre> |
45 |
* |
* |
46 |
* |
* |
47 |
*/ |
*/ |
48 |
|
|
49 |
/** |
/** |
50 |
* It helps GenericDataSource working in different "operation modes". |
* It helps DataSource::Generic working in different "operation modes". |
|
* |
|
|
* o Pass-Through-Reference: php Object will get passed through all layers |
|
|
* o Pass-Through-Memory: reference to a memory area will get used |
|
|
* x Build-Locator: build locator from datasource-type and adapter-type |
|
|
* o Use-Locator: directly use DataSource::Locator instance passed in |
|
|
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
|
|
* o Build-AutoLocator: use global constants making up our metadata |
|
51 |
* |
* |
52 |
|
* <ul> |
53 |
|
* o Pass-Through-Reference: php Object will get passed through all layers |
54 |
|
* o Pass-Through-Memory: reference to a memory area will get used |
55 |
|
* x Build-Locator: build locator from datasource-type and adapter-type |
56 |
|
* o Use-Locator: directly use DataSource::Locator instance passed in |
57 |
|
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
58 |
|
* o Build-AutoLocator: use global constants making up our metadata |
59 |
|
* </ul> |
60 |
* |
* |
|
* It can/should contain (flexible, just some parameters are required for each operation mode) |
|
61 |
* |
* |
62 |
|
* <b>It can/should contain:</b> |
63 |
|
* (flexible, just some parameters are required for each operation mode) |
64 |
|
* <ul> |
65 |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
66 |
* + 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 |
67 |
* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy) |
* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy) |
68 |
* + 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') |
69 |
* 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') |
70 |
* this will get propagated (pass-through-mode) |
* this will get propagated (pass-through-mode) |
71 |
* + a datasource-type (of 'rpc|mysql|csv-file|xml-file') |
* o a datasource-type (of 'rpc|mysql|csv-file|xml-file') |
72 |
* 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* |
73 |
* by the GenericDataSource at runtime |
* by the DataSource::Generic at runtime |
74 |
* + an adapter-type (of 'phpHtmlLib|pear') |
* x an adapter-type (of 'phpHtmlLib|pear') |
75 |
* 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* |
76 |
* by the GenericDataSource at runtime |
* by the DataSource::Generic at runtime |
77 |
* o names of global constants where to find these informations |
* o names of global constants where to find these informations |
78 |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
79 |
|
* </ul> |
80 |
* |
* |
81 |
* |
* |
82 |
* --- It can do |
* <b>It can do</b> |
83 |
* x builds a larger locator from a minimum of information passed in via constructor-arguments |
* <ul> |
84 |
* o direct fallback mode to some predefined constant names if locator is empty and above method fails |
* # builds a larger locator from a minimum of information passed in via constructor-arguments |
85 |
* o direct fallback mode to some predefined values if just *everything* fails |
* o direct fallback mode to some predefined constant names if locator is empty and above method fails |
86 |
|
* o direct fallback mode to some predefined values if just *everything* fails |
87 |
|
* </ul> |
88 |
* |
* |
89 |
* |
* |
90 |
* --- How to use? |
* <b>How to use?</b> |
91 |
* |
* |
92 |
* Pass an array holding "locator metadata" to the constructor. |
* Pass an array holding "locator metadata" to the constructor. |
93 |
* This module takes care of the rest. |
* This module takes care of the rest. |
95 |
* Pass an array to the constructor: (e.g.) |
* Pass an array to the constructor: (e.g.) |
96 |
* |
* |
97 |
* 1. for doing rpc-calls.... |
* 1. for doing rpc-calls.... |
98 |
|
* <code> |
99 |
* $locator = array( |
* $locator = array( |
100 |
* datasource_type => 'rpc', |
* datasource_type => 'rpc', |
101 |
* [adapter_type => 'phpHtmlLib',] |
* [adapter_type => 'phpHtmlLib',] |
102 |
* metadata => array( Host => 'localhost', Port => '8765' ), |
* metadata => array( Host => 'localhost', Port => '8765' ), |
103 |
* ); |
* ); |
104 |
* $source = new GenericDataSource($locator); |
* $source = new DataSource::Generic($locator); |
105 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
106 |
|
* </code> |
107 |
* |
* |
108 |
* 2. [proposal] for common/oldschool datahandles.... |
* 2. [proposal] for common/oldschool datahandles.... |
109 |
|
* <code> |
110 |
* $locator = array( |
* $locator = array( |
111 |
* dsn => 'known dsn markup', |
* dsn => 'known dsn markup', |
112 |
* ); |
* ); |
113 |
* $source = new GenericDataSource($locator); |
* $source = new DataSource::Generic($locator); |
114 |
* $this->set_data_source( &$source ); |
* $this->set_data_source( &$source ); |
115 |
|
* </code> |
116 |
* |
* |
117 |
* |
* |
118 |
* |
* |
123 |
* @license GNU LGPL (GNU Lesser General Public License) |
* @license GNU LGPL (GNU Lesser General Public License) |
124 |
* @link http://www.gnu.org/licenses/lgpl.txt |
* @link http://www.gnu.org/licenses/lgpl.txt |
125 |
* |
* |
126 |
|
* @package org.netfrag.glib |
127 |
* @subpackage DataSource |
* @subpackage DataSource |
128 |
* @name DataSource::Locator |
* @name DataSource::Locator |
|
* @filesource |
|
129 |
* |
* |
130 |
*/ |
*/ |
|
|
|
|
|
|
131 |
class DataSource_Locator { |
class DataSource_Locator { |
132 |
|
|
133 |
/** |
/** |
136 |
* using metadata from $_options and some |
* using metadata from $_options and some |
137 |
* other presets. |
* other presets. |
138 |
* |
* |
139 |
* See '_buildLocator' which acts as a dispatcher |
* @see function build, which acts as a dispatcher |
140 |
* depending on $_options[datasource]. |
* depending on $_options[datasource]. |
141 |
* (main dispatching level) |
* (main dispatching level) |
142 |
* |
* |
143 |
* The structure of a full blown locator looks like this: |
* The structure of a full blown locator looks like this: |
144 |
* |
* |
145 |
|
* <code> |
146 |
* $locator = array( |
* $locator = array( |
147 |
* type => '<your type specifying the datasource-type>', |
* type => '<your type specifying the datasource-type>', |
148 |
* metadata => array( |
* metadata => array( |
150 |
* ), |
* ), |
151 |
* [dsn => '<your dsn markup>'], |
* [dsn => '<your dsn markup>'], |
152 |
* ); |
* ); |
153 |
|
* </code> |
154 |
* |
* |
155 |
* 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: |
156 |
|
* <code> |
157 |
* $locator = array( |
* $locator = array( |
158 |
* dsn => 'mysql://username:password@localhost/database', |
* dsn => 'mysql://username:password@localhost/database', |
159 |
* ); |
* ); |
160 |
|
* </code> |
161 |
* |
* |
162 |
* 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): |
163 |
|
* <code> |
164 |
* $locator = array( |
* $locator = array( |
165 |
* type => 'rpc', |
* type => 'rpc', |
166 |
* metadata => array( |
* metadata => array( |
169 |
* Port => '8765', |
* Port => '8765', |
170 |
* ) |
* ) |
171 |
* ); |
* ); |
172 |
|
* </code> |
173 |
|
* |
174 |
|
* @deprecated |
175 |
* |
* |
176 |
*/ |
*/ |
177 |
|
var $_locator_metadata = NULL; |
|
//var $_locator_metadata = NULL; |
|
178 |
|
|
179 |
|
|
180 |
/** |
/** |
181 |
* This var holds the arguments passed in to the constructor. |
* This var holds the arguments passed in to the constructor. |
182 |
* We will try to build full blown locator metadata information from that. |
* We will try to build full blown locator metadata information from that. |
183 |
* |
* |
184 |
*/ |
* @deprecated |
185 |
//var $_in = NULL; |
* |
186 |
|
*/ |
187 |
|
var $_in = NULL; |
188 |
|
|
189 |
/** |
/** |
190 |
* This var holds the locator metadata informations inside |
* This var holds the locator metadata informations inside |
191 |
* a single hash. This is returned from '->get()'. |
* a single hash. This is returned from '->get()'. |
192 |
* |
* |
193 |
*/ |
* @deprecated |
194 |
//var $_out = NULL; |
* |
195 |
|
*/ |
196 |
|
var $_out = NULL; |
197 |
|
|
198 |
|
|
199 |
/** |
/** |
207 |
// name of an Adapter module |
// name of an Adapter module |
208 |
var $_adapter_type; |
var $_adapter_type; |
209 |
|
|
210 |
// additional information required (passed on to the Proxy by GenericDataSource) |
// additional information required (passed on to the Proxy by DataSource::Generic) |
211 |
var $_metadata = array(); |
var $_metadata = array(); |
212 |
|
|
213 |
//var $_dsn; |
//var $_dsn; |
217 |
* The constructor is used to pass in the |
* The constructor is used to pass in the |
218 |
* locator metadata hash. |
* locator metadata hash. |
219 |
* |
* |
220 |
* @param LocatorMetadataHash array - layout: array( type => '', metadata => '', dsn => '' ) |
* @param object(DataSource::Locator)|hash optional: a &$locator instance |
|
* @param Query array - layout: array( type => '', metadata => '', dsn => '' ) |
|
221 |
*/ |
*/ |
222 |
function DataSource_Locator() { |
function DataSource_Locator() { |
223 |
$args_multi = func_get_args(); |
$args_multi = func_get_args(); |
293 |
|
|
294 |
/** |
/** |
295 |
* Set the locator metadata hash we will feed *partly* |
* Set the locator metadata hash we will feed *partly* |
296 |
* to an encapsulated Data::Driver::Proxy instance. |
* to an encapsulated Data::Driver::Proxy instance |
297 |
* |
* |
298 |
* @param LocatorMetadataHash array - |
* @param LocatorMetadataHash array - |
299 |
* |
* |
320 |
$metadata = array( |
$metadata = array( |
321 |
//package => 'Data::Driver::Proxy', |
//package => 'Data::Driver::Proxy', |
322 |
//package => 'DataSource::Proxy::XMLRPC', |
//package => 'DataSource::Proxy::XMLRPC', |
323 |
//package => 'DataSource::GenericDataSource', |
//package => 'DataSource::Generic', |
324 |
//package => 'DesignPattern::RemoteProxy', |
//package => 'DesignPattern::RemoteProxy', |
325 |
Host => RPC_HOSTNAME, |
Host => RPC_HOSTNAME, |
326 |
Port => RPC_PORT, |
Port => RPC_PORT, |