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

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