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

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