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.31 2003/03/28 06:46:00 joko Exp $
 *
 * $Log: Locator.php,v $
 * Revision 1.31  2003/03/28 06:46:00  joko
 * new helper: 'function get_call'
 *
 * Revision 1.30  2003/03/28 03:02:50  joko
 * propagating parameters for rpc-debugging and options here
 *
 * 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( ) {

    //print "locator - build!<br/>";
    
    // trace
      //print Dumper($this);

    $good = 0;
    switch ($this->_datasource_type) {
      
      // TODO: dispatch Host, Port, User and Pass by transport here!!!
      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' => constants::get('RPC_DEBUG'),
          'TRACE' => constants::get('RPC_TRACE'),
          'DISCONNECT_ON_ERROR' => constants::get('RPC_DISCONNECT_ON_ERROR'),
          // FIXME!!! 'ws_admin' is hardcoded here!!!
          'USER' => $_SESSION[ws_admin][user],
          'PASS' => $_SESSION[ws_admin][pass],
        );
        $good = 1;
        break;
    }
    
    if ($good) {

      //print Dumper($metadata);
      
      // 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;
  }

  function get_call() {
    return array(
      method => $this->_call[_method],
      args => $this->_call[_arguments],
    );
  }

}

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