/[cvs]/nfo/php/libs/org.netfrag.glib/DataSource/Locator.php

Diff of /nfo/php/libs/org.netfrag.glib/DataSource/Locator.php

Parent Directory | Revision Log | View Patch Patch

-revision 1.1 by joko,
Wed Mar  5 12:04:37 2003 UTC
+revision 1.32 by joko,
Fri Apr  4 21:21:16 2003 UTC
 Line 1
  <?php
  /**
-  * --- @about
-  *
   * 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::GenericDataSource
+  * 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
-  * @module DataSource::Locator
+  * @name DataSource::Locator
+  *
   *
   */
  /**
+  * <b>Cvs-Log:</b>
+  *
+  * <pre>
   * $Id$
   *
   * $Log$
+  * Revision 1.32  2003/04/04 21:21:16  joko
+  * new attributes in locator hash for rpc-connections: USER and PASS
+  *
+  * 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>
   *
   *
   */
  /**
-  * --- @description
+  * It helps DataSource::Generic working in different "operation modes".
-  *
-  * --- It helps GenericDataSource working in different "operation modes".
-  *
-  *    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
-  *
-  *
-  * --- It can/should contain (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)
-  *    x 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 GenericDataSource at runtime
-  *    x an adapter-type (of 'phpHtmlLib|pear')
-  *        this will be mapped to a module name and used as an *Adapter*
-  *        by the GenericDataSource at runtime
-  *    o names of global constants where to find these informations
-  *    o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
-  *
-  *
-  * --- It can do
-  *    x builds a larger locator from a minimum of information passed in via constructor-arguments
-  *    o direct fallback mode to some predefined constant names if locator is empty and above method fails
-  *    o direct fallback mode to some predefined values if just *everything* fails
   *
+  * <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
   *
-  * --- How to use?
+  * <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.)
   *
-  *  1. for doing rpc-calls....
+  * <pre>
+  *    // 1. for doing rpc-calls....
   *    $locator = array(
   *      datasource_type => 'rpc',
   *      [adapter_type => 'phpHtmlLib',]
   *      metadata => array( Host => 'localhost', Port => '8765' ),
   *    );
-  *    $source = new GenericDataSource($locator);
+  *    $source = ne w DataSource::Generic($locator);
   *    $this->set_data_source( &$source );
-  *
+  * </pre>
-  *  2. [proposal] for common/oldschool datahandles....
+  * <pre>
+  *    // 2. [proposal] for common/oldschool datahandles....
   *    $locator = array(
   *      dsn => 'known dsn markup',
   *    );
-  *    $source = new GenericDataSource($locator);
+  *    $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)
   *
-  * @author-url http://www.netfrag.org/~joko/
+  * @license GNU LGPL (GNU Lesser General Public License)
-  * @license-url http://www.gnu.org/licenses/lgpl.txt
+  * @link http://www.gnu.org/licenses/lgpl.txt
   *
-  * @author Andreas Motl <andreas.motl@ilo.de>
   * @package org.netfrag.glib
-  * @module DataSource::Locator
+  * @subpackage DataSource
+  * @name DataSource::Locator
   *
   */
  class DataSource_Locator {
    /**
-     * This var holds the locator metadata hash
+     * This var holds the locator metadata hash,
+     *
      * which is built from some predefined rules
      * using metadata from $_options and some
      * other presets.
      *
-     * See '_buildLocator' which acts as a dispatcher
+     * See {@link build}, which acts as a dispatcher
-     * depending on $_options[datasource].
+     * depending on $_options[datasource]. <br>
      * (main dispatching level)
      *
-     * The structure of a full blown locator looks like this:
+     * <br>
      *
+     * The structure of a full blown locator looks like this:
+     * <code>
      *  $locator = array(
      *    type => '<your type specifying the datasource-type>',
      *    metadata => array(
-Line 124 
 class DataSource_Locator {
+Line 220 
 class DataSource_Locator {
      *    ),
      *    [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(
-Line 139 
 class DataSource_Locator {
+Line 239 
 class DataSource_Locator {
      *      Port => '8765',
      *    )
      *  );
+     * </code>
+     *
+     * @deprecated
      *
      */
+     var $_locator_metadata = NULL;
-     //var $_locator_metadata = NULL;
-         /**
+    /**
-          * This var holds the arguments passed in to the constructor.
+     * This var holds the arguments passed in to the constructor.
-          * We will try to build full blown locator metadata information from that.
+     * We will try to build full blown locator metadata information from that.
-          *
+     *
-          */
+     * @deprecated
-         //var $_in = NULL;
+     *
+     */
+     var $_in = NULL;
-         /**
+    /**
-          * This var holds the locator metadata informations inside
+     * This var holds the locator metadata informations inside
-          * a single hash. This is returned from '->get()'.
+     * a single hash. This is returned from '->get()'.
-          *
+     *
-          */
+     * @deprecated
-         //var $_out = NULL;
+     *
+     */
+     var $_out = NULL;
          /**
-Line 171 
 class DataSource_Locator {
+Line 277 
 class DataSource_Locator {
      // name of an Adapter module
      var $_adapter_type;
-     // additional information required (passed on to the Proxy by GenericDataSource)
+     // additional information required (passed on to the Proxy by DataSource::Generic)
      var $_metadata = array();
      //var $_dsn;
-Line 181 
 class DataSource_Locator {
+Line 287 
 class DataSource_Locator {
           * The constructor is used to pass in the
           * locator metadata hash.
           *
-          * @param LocatorMetadataHash array - layout: array( type => '', metadata => '', dsn => '' )
+          * @param object(DataSource::Locator)|hash optional: a &$locator instance
-          * @param Query array - layout: array( type => '', metadata => '', dsn => '' )
           */
          function DataSource_Locator() {
        $args_multi = func_get_args();
-Line 258 
 class DataSource_Locator {
+Line 363 
 class DataSource_Locator {
          /**
       * Set the locator metadata hash we will feed *partly*
-      * to an encapsulated Data::Driver::Proxy instance.
+      * to an encapsulated Data::Driver::Proxy instance
       *
       * @param LocatorMetadataHash array -
       *
-Line 269 
 class DataSource_Locator {
+Line 374 
 class DataSource_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::GenericDataSource',
+           //package => 'DataSource::Generic',
            //package => 'DesignPattern::RemoteProxy',
-           Host => RPC_HOSTNAME,
+           'Host' => RPC_HOSTNAME,
-           Port => RPC_PORT,
+           '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:
        /*
-Line 326 
 class DataSource_Locator {
+Line 444 
 class DataSource_Locator {
      return 1;
    }
+   function get_call() {
+     return array(
+       method => $this->_call[_method],
+       args => $this->_call[_arguments],
+     );
+   }
  }
  ?>

 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.32
 Legend:



Removed from v.1.1
 


changed lines


 
Added in v.1.32
-Removed from v.1.1
+Added in v.1.32

MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26