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

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