/[cvs]/nfo/php/libs/org.netfrag.glib/DataSource/Locator.php
ViewVC logotype

Annotation of /nfo/php/libs/org.netfrag.glib/DataSource/Locator.php

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.29 - (hide annotations)
Tue Mar 18 02:01:47 2003 UTC (21 years, 4 months ago) by joko
Branch: MAIN
Changes since 1.28: +5 -2 lines
minor update (mungling with phpDocumentor again)

1 joko 1.1 <?php
2     /**
3 joko 1.2 * This file contains the DataSource::Locator class.
4 joko 1.1 *
5     * It acts as a container for DataSource connection
6     * metadata. Think of it as an enhanced dsn.
7     *
8 joko 1.3 * It gets used by DataSource::Generic
9 joko 1.1 * to be informed about the most important stuff it
10     * has to do.
11     *
12 joko 1.5 * @author Andreas Motl <andreas.motl@ilo.de>
13 joko 1.1 * @package org.netfrag.glib
14 joko 1.7 * @name DataSource::Locator
15     *
16     *
17 joko 1.10 */
18    
19    
20     /**
21 joko 1.7 * <b>Cvs-Log:</b>
22 joko 1.1 *
23 joko 1.7 * <pre>
24 joko 1.29 * $Id: Locator.php,v 1.28 2003/03/18 01:52:33 joko Exp $
25 joko 1.2 *
26     * $Log: Locator.php,v $
27 joko 1.29 * Revision 1.28 2003/03/18 01:52:33 joko
28     * minor update (mungling with phpDocumentor again)
29     *
30 joko 1.28 * Revision 1.27 2003/03/11 16:44:59 joko
31     * + fixed metadata for phpDocumentor
32     *
33 joko 1.27 * Revision 1.26 2003/03/11 16:41:47 joko
34     * + fixed metadata for phpDocumentor
35     *
36 joko 1.26 * Revision 1.25 2003/03/11 16:28:25 joko
37     * + fixed metadata for phpDocumentor
38     *
39 joko 1.25 * Revision 1.24 2003/03/11 04:49:25 joko
40     * + fixed metadata for phpDocumentor
41     *
42 joko 1.24 * Revision 1.23 2003/03/11 04:15:01 joko
43     * + fixed metadata for phpDocumentor
44     *
45 joko 1.23 * Revision 1.22 2003/03/11 04:03:54 joko
46     * + fixed metadata for phpDocumentor
47     *
48 joko 1.22 * Revision 1.21 2003/03/11 03:23:36 joko
49     * + fixed metadata for phpDocumentor
50     *
51 joko 1.21 * Revision 1.20 2003/03/11 03:17:37 joko
52     * + fixed metadata for phpDocumentor
53     *
54 joko 1.20 * Revision 1.19 2003/03/11 03:05:01 joko
55     * + fixed metadata for phpDocumentor
56     *
57 joko 1.19 * Revision 1.18 2003/03/11 02:42:51 joko
58     * + fixed metadata for phpDocumentor
59     *
60 joko 1.18 * Revision 1.17 2003/03/11 02:34:55 joko
61     * + fixed metadata for phpDocumentor
62     *
63 joko 1.17 * Revision 1.16 2003/03/11 02:28:12 joko
64     * + fixed metadata for phpDocumentor
65     *
66 joko 1.16 * Revision 1.15 2003/03/11 02:23:03 joko
67     * + fixed metadata for phpDocumentor
68     *
69 joko 1.15 * Revision 1.14 2003/03/11 02:14:24 joko
70     * + fixed metadata for phpDocumentor
71     *
72 joko 1.14 * Revision 1.13 2003/03/11 02:04:37 joko
73     * + fixed metadata for phpDocumentor
74     *
75 joko 1.13 * Revision 1.12 2003/03/11 01:10:00 joko
76     * + fixed metadata for phpDocumentor
77     *
78 joko 1.12 * Revision 1.11 2003/03/11 00:12:49 joko
79     * + fixed metadata for phpDocumentor
80     *
81 joko 1.11 * Revision 1.10 2003/03/10 23:25:03 joko
82     * + fixed metadata for phpDocumentor
83     *
84 joko 1.10 * Revision 1.9 2003/03/10 22:31:55 joko
85     * + fixed metadata for phpDocumentor
86     *
87 joko 1.9 * Revision 1.8 2003/03/09 15:50:36 joko
88     * + additional metadata for Autodia
89     *
90 joko 1.8 * Revision 1.7 2003/03/05 17:13:16 joko
91     * updated docu (phpDocumentor testing....)
92     *
93 joko 1.7 * Revision 1.6 2003/03/05 16:10:08 joko
94     * updated docu (phpDocumentor testing....)
95     *
96 joko 1.6 * Revision 1.5 2003/03/05 15:40:39 joko
97     * updated docu (phpDocumentor testing....)
98     *
99 joko 1.5 * Revision 1.4 2003/03/05 15:26:23 joko
100     * updated docu (phpDocumentor testing....)
101     *
102 joko 1.4 * Revision 1.3 2003/03/05 15:21:54 joko
103     * updated docu (phpDocumentor testing....)
104     *
105 joko 1.3 * Revision 1.2 2003/03/05 15:01:10 joko
106     * updated docu
107     *
108 joko 1.2 * Revision 1.1 2003/03/05 12:04:37 joko
109     * + initial commit
110 joko 1.7 * </pre>
111 joko 1.1 *
112     *
113     */
114    
115     /**
116 joko 1.3 * It helps DataSource::Generic working in different "operation modes".
117 joko 1.1 *
118 joko 1.13 * <b>Modes:</b> (these are proposals, more or less...)
119 joko 1.7 * o Pass-Through-Reference: php Object will get passed through all layers
120     * o Pass-Through-Memory: reference to a memory area will get used
121 joko 1.29 * + (x) Build-Locator: build locator from datasource-type and adapter-type
122 joko 1.7 * o Use-Locator: directly use DataSource::Locator instance passed in
123     * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
124     * o Build-AutoLocator: use global constants making up our metadata
125     *
126 joko 1.4 * <b>It can/should contain:</b>
127     * (flexible, just some parameters are required for each operation mode)
128 joko 1.7 * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
129 joko 1.11 * + (x) name of a Proxy module to use to *wrap/hide* the connection/transport-layer
130 joko 1.2 * (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
131 joko 1.11 * + (x) metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')
132 joko 1.7 * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
133 joko 1.2 * this will get propagated (pass-through-mode)
134 joko 1.7 * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
135 joko 1.2 * this will be mapped to a module name and used as a *Proxy*
136 joko 1.3 * by the DataSource::Generic at runtime
137 joko 1.11 * + (x) an adapter-type (of 'phpHtmlLib|pear')
138 joko 1.2 * this will be mapped to a module name and used as an *Adapter*
139 joko 1.3 * by the DataSource::Generic at runtime
140 joko 1.7 * o names of global constants where to find these informations
141     * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
142 joko 1.1 *
143 joko 1.14 * <b>It can do:</b>
144 joko 1.10 * - builds a larger locator from a minimum of information passed in via constructor-arguments
145     * - direct fallback mode to some predefined constant names if locator is empty and above method fails
146     * - direct fallback mode to some predefined values if just *everything* fails
147 joko 1.1 *
148 joko 1.4 * <b>How to use?</b>
149 joko 1.1 *
150     * Pass an array holding "locator metadata" to the constructor.
151     * This module takes care of the rest.
152     * Pass an array to the constructor: (e.g.)
153     *
154 joko 1.28 * <pre>
155 joko 1.22 * // 1. for doing rpc-calls....
156 joko 1.1 * $locator = array(
157 joko 1.28 * datasource_type => 'rpc',
158 joko 1.1 * [adapter_type => 'phpHtmlLib',]
159     * metadata => array( Host => 'localhost', Port => '8765' ),
160     * );
161 joko 1.8 * $source = ne w DataSource::Generic($locator);
162 joko 1.1 * $this->set_data_source( &$source );
163 joko 1.28 * </pre>
164     * <pre>
165 joko 1.22 * // 2. [proposal] for common/oldschool datahandles....
166 joko 1.1 * $locator = array(
167     * dsn => 'known dsn markup',
168     * );
169 joko 1.8 * $source = ne w DataSource::Generic($locator);
170 joko 1.1 * $this->set_data_source( &$source );
171 joko 1.28 * </pre>
172 joko 1.1 *
173     *
174     *
175     * @author Andreas Motl <andreas.motl@ilo.de>
176 joko 1.2 * @link http://www.netfrag.org/~joko/
177 joko 1.1 * @copyright (c) 2003 - All Rights reserved.
178 joko 1.2 *
179 joko 1.1 * @license GNU LGPL (GNU Lesser General Public License)
180 joko 1.2 * @link http://www.gnu.org/licenses/lgpl.txt
181 joko 1.1 *
182 joko 1.7 * @package org.netfrag.glib
183     * @subpackage DataSource
184 joko 1.2 * @name DataSource::Locator
185 joko 1.1 *
186     */
187     class DataSource_Locator {
188    
189     /**
190 joko 1.16 * This var holds the locator metadata hash,
191     *
192 joko 1.1 * which is built from some predefined rules
193     * using metadata from $_options and some
194     * other presets.
195     *
196 joko 1.20 * See {@link build}, which acts as a dispatcher
197     * depending on $_options[datasource]. <br>
198     * (main dispatching level)
199 joko 1.1 *
200 joko 1.23 * <br>
201     *
202 joko 1.1 * The structure of a full blown locator looks like this:
203 joko 1.21 * <code>
204 joko 1.1 * $locator = array(
205     * type => '<your type specifying the datasource-type>',
206     * metadata => array(
207     * ... your arbitrary deep metadata structure ...
208     * ),
209     * [dsn => '<your dsn markup>'],
210     * );
211 joko 1.21 * </code>
212 joko 1.1 *
213     * Example 1 - data is inside a rdbms, using a dsn to connect to it:
214 joko 1.21 * <code>
215 joko 1.1 * $locator = array(
216     * dsn => 'mysql://username:password@localhost/database',
217     * );
218 joko 1.21 * </code>
219 joko 1.1 *
220     * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
221 joko 1.5 * <code>
222 joko 1.1 * $locator = array(
223     * type => 'rpc',
224     * metadata => array(
225     * package => 'Data::Driver::Proxy',
226     * Host => 'localhost',
227     * Port => '8765',
228     * )
229     * );
230 joko 1.5 * </code>
231     *
232     * @deprecated
233 joko 1.1 *
234     */
235 joko 1.5 var $_locator_metadata = NULL;
236 joko 1.1
237    
238 joko 1.5 /**
239     * This var holds the arguments passed in to the constructor.
240     * We will try to build full blown locator metadata information from that.
241     *
242     * @deprecated
243     *
244     */
245     var $_in = NULL;
246    
247     /**
248     * This var holds the locator metadata informations inside
249     * a single hash. This is returned from '->get()'.
250     *
251     * @deprecated
252     *
253     */
254     var $_out = NULL;
255 joko 1.1
256    
257     /**
258     * Locator metadata.
259     *
260     */
261    
262     // name of a Proxy module
263     var $_datasource_type;
264    
265     // name of an Adapter module
266     var $_adapter_type;
267    
268 joko 1.3 // additional information required (passed on to the Proxy by DataSource::Generic)
269 joko 1.1 var $_metadata = array();
270    
271     //var $_dsn;
272    
273    
274     /**
275     * The constructor is used to pass in the
276     * locator metadata hash.
277     *
278 joko 1.6 * @param object(DataSource::Locator)|hash optional: a &$locator instance
279 joko 1.1 */
280     function DataSource_Locator() {
281     $args_multi = func_get_args();
282    
283     //php::array_shrink($args_multi);
284    
285     //print Dumper($args_multi);
286     //exit;
287    
288     foreach ($args_multi as $args) {
289     if (isset($args)) {
290     $this->merge_args($args);
291     }
292     }
293    
294     $this->build();
295     //$this->check();
296     }
297    
298     function merge_args(&$args) {
299    
300     //print "args: " . Dumper($args);
301    
302     // check if passed in locator is already of type *me* ...
303     // ... if so, merge it into current instance
304     if (is_object($args) && get_class($args) == get_class($this)) {
305     $this->merge_to($this, $args);
306    
307     } else {
308    
309     // FIXME: handle locator merging here?
310     //$this->_arguments = &$args;
311    
312     // FIXME: to php::merge_to($this, $locator) here!!!
313     //$this->_data
314     // for now: assume plain hash, so just iterate and overwrite!
315     $this->merge_to($this, $args, '_');
316    
317     }
318     }
319    
320     function merge_to(&$target, $source, $prefix_key = '') {
321    
322     //print "target: " . Dumper($target);
323     //print "source: " . Dumper($source);
324    
325     // pre-flight checks
326     if (!isset($target)) {
327     user_error("variable passed as reference (merge target) is not set.");
328     return;
329     }
330     //if (!is_hash($hash)) {
331     if (!isset($source)) {
332     user_error("variable passed as source is not set.");
333     return;
334     }
335    
336     // perform merge
337     foreach ($source as $key => $val) {
338     $name = $prefix_key . $key;
339     if (is_object($target)) {
340     $target->$name = $val;
341     //} elseif (php::is_hash($target)) {
342     } else {
343     $target[$name] = $val;
344     }
345     }
346    
347     // indicate good
348     return 1;
349    
350     }
351    
352     /**
353     * Set the locator metadata hash we will feed *partly*
354 joko 1.6 * to an encapsulated Data::Driver::Proxy instance
355 joko 1.1 *
356     * @param LocatorMetadataHash array -
357     *
358     */
359     function set( &$locator ) {
360     $this->_out = &$locator;
361     }
362    
363     function &get_metadata() {
364     //return ($this->_out);
365     return $this->_metadata;
366     }
367    
368    
369     function build( ) {
370    
371     // trace
372     //print Dumper($this);
373    
374     $good = 0;
375     switch ($this->_datasource_type) {
376     case 'rpc':
377     // get rpc connection information from global constants
378     $metadata = array(
379     //package => 'Data::Driver::Proxy',
380     //package => 'DataSource::Proxy::XMLRPC',
381 joko 1.3 //package => 'DataSource::Generic',
382 joko 1.1 //package => 'DesignPattern::RemoteProxy',
383     Host => RPC_HOSTNAME,
384     Port => RPC_PORT,
385     );
386     $good = 1;
387     break;
388     }
389    
390     if ($good) {
391    
392     // V1:
393     /*
394     $this->_out = array(
395     datasource_type => $datasource,
396     adapter_type => 'Data',
397     metadata => $metadata,
398     );
399     */
400    
401     // V2:
402     //$this->_out = $metadata;
403    
404     // V3:
405     $this->merge_to($this->_metadata, $metadata);
406    
407     }
408    
409     // trace
410     //print Dumper($this);
411    
412     }
413    
414     function check() {
415     if (!sizeof($this->_metadata)) {
416     user_error("DataSource::Locator::check() failed: " . "Locator metadata not established, please check configuration options.");
417     return;
418     }
419     return 1;
420     }
421    
422    
423     }
424    
425     ?>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed