/[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.27 - (hide annotations)
Tue Mar 11 16:44:59 2003 UTC (21 years, 4 months ago) by joko
Branch: MAIN
Changes since 1.26: +7 -4 lines
+ fixed metadata for phpDocumentor

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

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