org.netfrag.glib/DataSource/Locator.php

<?php
/**
 * This file contains the DataSource::Locator class.
 *
 * It acts as a container for DataSource connection 
 * metadata. Think of it as an enhanced dsn.
 *
 * It gets used by DataSource::Generic
 * to be informed about the most important stuff it
 * has to do.
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @package org.netfrag.glib
 * @name DataSource::Locator
 *
 *
 */


/**
 * <b>Cvs-Log:</b>
 *
 * <pre>
 * $Id: Locator.php,v 1.29 2003/03/18 02:01:47 joko Exp $
 *
 * $Log: Locator.php,v $
 * Revision 1.29  2003/03/18 02:01:47  joko
 * minor update (mungling with phpDocumentor again)
 *
 * Revision 1.28  2003/03/18 01:52:33  joko
 * minor update (mungling with phpDocumentor again)
 *
 * Revision 1.27  2003/03/11 16:44:59  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.26  2003/03/11 16:41:47  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.25  2003/03/11 16:28:25  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.24  2003/03/11 04:49:25  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.23  2003/03/11 04:15:01  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.22  2003/03/11 04:03:54  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.21  2003/03/11 03:23:36  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.20  2003/03/11 03:17:37  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.19  2003/03/11 03:05:01  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.18  2003/03/11 02:42:51  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.17  2003/03/11 02:34:55  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.16  2003/03/11 02:28:12  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.15  2003/03/11 02:23:03  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.14  2003/03/11 02:14:24  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.13  2003/03/11 02:04:37  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.12  2003/03/11 01:10:00  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.11  2003/03/11 00:12:49  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.10  2003/03/10 23:25:03  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.9  2003/03/10 22:31:55  joko
 * + fixed metadata for phpDocumentor
 *
 * Revision 1.8  2003/03/09 15:50:36  joko
 * + additional metadata for Autodia
 *
 * Revision 1.7  2003/03/05 17:13:16  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.6  2003/03/05 16:10:08  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.5  2003/03/05 15:40:39  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.4  2003/03/05 15:26:23  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.3  2003/03/05 15:21:54  joko
 * updated docu (phpDocumentor testing....)
 *
 * Revision 1.2  2003/03/05 15:01:10  joko
 * updated docu
 *
 * Revision 1.1  2003/03/05 12:04:37  joko
 * + initial commit
 * </pre>
 *
 *
 */

/**
 * It helps DataSource::Generic working in different "operation modes".
 *
 * <b>Modes:</b> (these are proposals, more or less...)
 * o Pass-Through-Reference: php Object will get passed through all layers
 * o Pass-Through-Memory: reference to a memory area will get used
 * + (x) Build-Locator: build locator from datasource-type and adapter-type
 * o Use-Locator: directly use DataSource::Locator instance passed in
 * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
 * o Build-AutoLocator: use global constants making up our metadata
 *
 * <b>It can/should contain:</b>
 * (flexible, just some parameters are required for each operation mode)
 * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
 * + (x) name of a Proxy module to use to *wrap/hide* the connection/transport-layer
 *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
 * + (x) metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')
 * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
 *   this will get propagated (pass-through-mode)
 * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
 *   this will be mapped to a module name and used as a *Proxy* 
 *   by the DataSource::Generic at runtime
 * + (x) an adapter-type (of 'phpHtmlLib|pear')
 *   this will be mapped to a module name and used as an *Adapter*
 *   by the DataSource::Generic at runtime
 * o names of global constants where to find these informations
 * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
 *
 * <b>It can do:</b>
 * - builds a larger locator from a minimum of information passed in via constructor-arguments
 * - direct fallback mode to some predefined constant names if locator is empty and above method fails
 * - direct fallback mode to some predefined values if just *everything* fails
 *
 * <b>How to use?</b>
 *
 * Pass an array holding "locator metadata" to the constructor.
 * This module takes care of the rest.
 * Pass an array to the constructor: (e.g.)
 *
 * <pre>
 *    // 1. for doing rpc-calls....
 *    $locator = array(
 *      datasource_type => 'rpc',
 *      [adapter_type => 'phpHtmlLib',]
 *      metadata => array( Host => 'localhost', Port => '8765' ),
 *    );
 *    $source = ne w DataSource::Generic($locator);
 *    $this->set_data_source( &$source );
 * </pre>
 * <pre>
 *    // 2. [proposal] for common/oldschool datahandles....
 *    $locator = array(
 *      dsn => 'known dsn markup',
 *    );
 *    $source = ne w DataSource::Generic($locator);
 *    $this->set_data_source( &$source );
 * </pre>
 *
 *
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @link http://www.netfrag.org/~joko/
 * @copyright (c) 2003 - All Rights reserved.
 *
 * @license GNU LGPL (GNU Lesser General Public License)
 * @link http://www.gnu.org/licenses/lgpl.txt
 *
 * @package org.netfrag.glib
 * @subpackage DataSource
 * @name DataSource::Locator
 *
 */
class DataSource_Locator {

  /**
    * This var holds the locator metadata hash,
    *
    * which is built from some predefined rules
    * using metadata from $_options and some
    * other presets.
    *
    * See {@link build}, which acts as a dispatcher
    * depending on $_options[datasource]. <br>
    * (main dispatching level)
    *
    * <br>
    *
    * The structure of a full blown locator looks like this:
    * <code>
    *  $locator = array(
    *    type => '<your type specifying the datasource-type>',
    *    metadata => array(
    *       ... your arbitrary deep metadata structure ...
    *    ),
    *    [dsn => '<your dsn markup>'],
    *  );
    * </code>
    *
    * Example 1 - data is inside a rdbms, using a dsn to connect to it:
    * <code>
    *  $locator = array(
    *    dsn => 'mysql://username:password@localhost/database',
    *  );
    * </code>
    *
    * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
    * <code>
    *  $locator = array(
    *    type => 'rpc',
    *    metadata => array(
    *      package => 'Data::Driver::Proxy',
    *      Host => 'localhost',
    *      Port => '8765',
    *    )
    *  );
    * </code>
    *
    * @deprecated
    *
    */
    var $_locator_metadata = NULL;


   /**
    * This var holds the arguments passed in to the constructor.
    * We will try to build full blown locator metadata information from that.
    *
    * @deprecated
    *
    */
    var $_in = NULL;

   /**
    * This var holds the locator metadata informations inside
    * a single hash. This is returned from '->get()'.
    *
    * @deprecated
    *
    */
    var $_out = NULL;


        /**
         * Locator metadata.
         *
         */

    // name of a Proxy module
    var $_datasource_type;
    
    // name of an Adapter module
    var $_adapter_type;
    
    // additional information required (passed on to the Proxy by DataSource::Generic)
    var $_metadata = array();
    
    //var $_dsn;
    

        /**
         * The constructor is used to pass in the
         * locator metadata hash.
         *
         * @param object(DataSource::Locator)|hash optional: a &$locator instance
         */
        function DataSource_Locator() {
      $args_multi = func_get_args();
      
      //php::array_shrink($args_multi);

      //print Dumper($args_multi);
      //exit;

      foreach ($args_multi as $args) {
        if (isset($args)) {
          $this->merge_args($args);
        }
      }

      $this->build();
      //$this->check();
        }
        
        function merge_args(&$args) {
          
          //print "args: " . Dumper($args);
          
                // check if passed in locator is already of type *me* ...
                // ... if so, merge it into current instance
                if (is_object($args) && get_class($args) == get_class($this)) {
                  $this->merge_to($this, $args);

                } else {
                
        // FIXME: handle locator merging here?
        //$this->_arguments = &$args;
        
        // FIXME: to php::merge_to($this, $locator) here!!!
        //$this->_data
        // for now: assume plain hash, so just iterate and overwrite!
        $this->merge_to($this, $args, '_');

      }
        }
        
        function merge_to(&$target, $source, $prefix_key = '') {

      //print "target: " . Dumper($target);
      //print "source: " . Dumper($source);

      // pre-flight checks
        if (!isset($target)) {
          user_error("variable passed as reference (merge target) is not set.");
          return;
        }
        //if (!is_hash($hash)) {
        if (!isset($source)) {
          user_error("variable passed as source is not set.");
          return;
        }

      // perform merge
        foreach ($source as $key => $val) {
          $name = $prefix_key . $key;
          if (is_object($target)) {
            $target->$name = $val;
          //} elseif (php::is_hash($target)) {
          } else {
            $target[$name] = $val;
          }
        }

      // indicate good
        return 1;

        }
        
        /**
     * Set the locator metadata hash we will feed *partly*
     * to an encapsulated Data::Driver::Proxy instance
     *
     * @param LocatorMetadataHash array - 
     *
     */
    function set( &$locator ) {
        $this->_out = &$locator;
    }

    function &get_metadata() {
        //return ($this->_out);
        //print Dumper($this->_metadata);
        return $this->_metadata;
    }


  function build( ) {
    
    // trace
      //print Dumper($this);

    $good = 0;
    switch ($this->_datasource_type) {
      case 'rpc':
        // get rpc connection information from global constants
        $metadata = array(
          //package => 'Data::Driver::Proxy',
          //package => 'DataSource::Proxy::XMLRPC',
          //package => 'DataSource::Generic',
          //package => 'DesignPattern::RemoteProxy',
          Host => RPC_HOSTNAME,
          Port => RPC_PORT,
          DEBUG => defined('RPC_DEBUG') ? RPC_DEBUG : null,
          TRACE => defined('RPC_TRACE') ? RPC_TRACE : null,
          DISCONNECT_ON_ERROR => defined('RPC_DISCONNECT_ON_ERROR') ? RPC_DISCONNECT_ON_ERROR : null,
        );
        $good = 1;
        break;
    }
    
    if ($good) {
      
      // V1:
      /*
      $this->_out = array(
        datasource_type => $datasource,
        adapter_type => 'Data',
        metadata => $metadata,
      );
      */

      // V2:
      //$this->_out = $metadata;
      
      // V3:
      $this->merge_to($this->_metadata, $metadata);
      
    }

    // trace
      //print Dumper($this);

  }
  
  function check() {  
    if (!sizeof($this->_metadata)) {
      user_error("DataSource::Locator::check() failed: " . "Locator metadata not established, please check configuration options.");
      return;
    }
    return 1;
  }

    
}

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