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

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