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

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