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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4 by joko, Wed Mar 5 15:26:23 2003 UTC revision 1.31 by joko, Fri Mar 28 06:46:00 2003 UTC
# Line 9  Line 9 
9   * to be informed about the most important stuff it   * to be informed about the most important stuff it
10   * has to do.   * has to do.
11   *   *
12   *   * @author Andreas Motl <andreas.motl@ilo.de>
13   * @package org.netfrag.glib   * @package org.netfrag.glib
14   * @module DataSource::Locator   * @name DataSource::Locator
15     *
16   *   *
17   */   */
18    
19    
20  /**  /**
21     * <b>Cvs-Log:</b>
22     *
23     * <pre>
24   * $Id$   * $Id$
25   *   *
26   * $Log$   * $Log$
27     * Revision 1.31  2003/03/28 06:46:00  joko
28     * new helper: 'function get_call'
29     *
30     * Revision 1.30  2003/03/28 03:02:50  joko
31     * propagating parameters for rpc-debugging and options here
32     *
33     * Revision 1.29  2003/03/18 02:01:47  joko
34     * minor update (mungling with phpDocumentor again)
35     *
36     * Revision 1.28  2003/03/18 01:52:33  joko
37     * minor update (mungling with phpDocumentor again)
38     *
39     * Revision 1.27  2003/03/11 16:44:59  joko
40     * + fixed metadata for phpDocumentor
41     *
42     * Revision 1.26  2003/03/11 16:41:47  joko
43     * + fixed metadata for phpDocumentor
44     *
45     * Revision 1.25  2003/03/11 16:28:25  joko
46     * + fixed metadata for phpDocumentor
47     *
48     * Revision 1.24  2003/03/11 04:49:25  joko
49     * + fixed metadata for phpDocumentor
50     *
51     * Revision 1.23  2003/03/11 04:15:01  joko
52     * + fixed metadata for phpDocumentor
53     *
54     * Revision 1.22  2003/03/11 04:03:54  joko
55     * + fixed metadata for phpDocumentor
56     *
57     * Revision 1.21  2003/03/11 03:23:36  joko
58     * + fixed metadata for phpDocumentor
59     *
60     * Revision 1.20  2003/03/11 03:17:37  joko
61     * + fixed metadata for phpDocumentor
62     *
63     * Revision 1.19  2003/03/11 03:05:01  joko
64     * + fixed metadata for phpDocumentor
65     *
66     * Revision 1.18  2003/03/11 02:42:51  joko
67     * + fixed metadata for phpDocumentor
68     *
69     * Revision 1.17  2003/03/11 02:34:55  joko
70     * + fixed metadata for phpDocumentor
71     *
72     * Revision 1.16  2003/03/11 02:28:12  joko
73     * + fixed metadata for phpDocumentor
74     *
75     * Revision 1.15  2003/03/11 02:23:03  joko
76     * + fixed metadata for phpDocumentor
77     *
78     * Revision 1.14  2003/03/11 02:14:24  joko
79     * + fixed metadata for phpDocumentor
80     *
81     * Revision 1.13  2003/03/11 02:04:37  joko
82     * + fixed metadata for phpDocumentor
83     *
84     * Revision 1.12  2003/03/11 01:10:00  joko
85     * + fixed metadata for phpDocumentor
86     *
87     * Revision 1.11  2003/03/11 00:12:49  joko
88     * + fixed metadata for phpDocumentor
89     *
90     * Revision 1.10  2003/03/10 23:25:03  joko
91     * + fixed metadata for phpDocumentor
92     *
93     * Revision 1.9  2003/03/10 22:31:55  joko
94     * + fixed metadata for phpDocumentor
95     *
96     * Revision 1.8  2003/03/09 15:50:36  joko
97     * + additional metadata for Autodia
98     *
99     * Revision 1.7  2003/03/05 17:13:16  joko
100     * updated docu (phpDocumentor testing....)
101     *
102     * Revision 1.6  2003/03/05 16:10:08  joko
103     * updated docu (phpDocumentor testing....)
104     *
105     * Revision 1.5  2003/03/05 15:40:39  joko
106     * updated docu (phpDocumentor testing....)
107     *
108   * Revision 1.4  2003/03/05 15:26:23  joko   * Revision 1.4  2003/03/05 15:26:23  joko
109   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
110   *   *
# Line 30  Line 116 
116   *   *
117   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
118   * + initial commit   * + initial commit
119     * </pre>
120   *   *
121   *   *
122   */   */
# Line 37  Line 124 
124  /**  /**
125   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
126   *   *
127   * - Pass-Through-Reference: php Object will get passed through all layers   * <b>Modes:</b> (these are proposals, more or less...)
128   * - Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Reference: php Object will get passed through all layers
129   * + Build-Locator: build locator from datasource-type and adapter-type   * o Pass-Through-Memory: reference to a memory area will get used
130   * - Use-Locator: directly use DataSource::Locator instance passed in   * + (x) Build-Locator: build locator from datasource-type and adapter-type
131   * - Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Use-Locator: directly use DataSource::Locator instance passed in
132   * - Build-AutoLocator: use global constants making up our metadata   * 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   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
136   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
137   * - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
138   * + name of a Proxy module to use to *wrap/hide* the connection/transport-layer   * + (x) name of a Proxy module to use to *wrap/hide* the connection/transport-layer
139   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
140   * + metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')   * + (x) metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port')
141   * - an instance of an already instantiated arbitrary datasource handler (e.g. 'source')   * o an instance of an already instantiated arbitrary datasource handler (e.g. 'source')
142   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
143   * - a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
144   *   this will be mapped to a module name and used as a *Proxy*   *   this will be mapped to a module name and used as a *Proxy*
145   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
146   * + an adapter-type (of 'phpHtmlLib|pear')   * + (x) an adapter-type (of 'phpHtmlLib|pear')
147   *   this will be mapped to a module name and used as an *Adapter*   *   this will be mapped to a module name and used as an *Adapter*
148   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
149   * - names of global constants where to find these informations   * o names of global constants where to find these informations
150   * - datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * 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  
  * 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  
151   *   *
152     * <b>It can do:</b>
153     * - 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   *   *
157   * <b>How to use?</b>   * <b>How to use?</b>
158   *   *
159   * Pass an array holding "locator metadata" to the constructor.   * Pass an array holding "locator metadata" to the constructor.
160   * This module takes care of the rest.   * This module takes care of the rest.
  *  
161   * Pass an array to the constructor: (e.g.)   * Pass an array to the constructor: (e.g.)
162   *   *
163   *  1. for doing rpc-calls....   * <pre>
164     *    // 1. for doing rpc-calls....
165   *    $locator = array(   *    $locator = array(
166   *      datasource_type => 'rpc',   *      datasource_type => 'rpc',
167   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
168   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
169   *    );   *    );
170   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
171   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
172   *   * </pre>
173   *  2. [proposal] for common/oldschool datahandles....   * <pre>
174     *    // 2. [proposal] for common/oldschool datahandles....
175   *    $locator = array(   *    $locator = array(
176   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
177   *    );   *    );
178   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
179   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
180     * </pre>
181   *   *
182   *   *
183   *   *
# Line 100  Line 188 
188   * @license GNU LGPL (GNU Lesser General Public License)   * @license GNU LGPL (GNU Lesser General Public License)
189   * @link http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
190   *   *
191     * @package org.netfrag.glib
192   * @subpackage DataSource   * @subpackage DataSource
193   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
194   *   *
195   */   */
   
   
196  class DataSource_Locator {  class DataSource_Locator {
197    
198    /**    /**
199      * This var holds the locator metadata hash      * This var holds the locator metadata hash,
200        *
201      * which is built from some predefined rules      * which is built from some predefined rules
202      * using metadata from $_options and some      * using metadata from $_options and some
203      * other presets.      * other presets.
204      *      *
205      * See '_buildLocator' which acts as a dispatcher      * See {@link build}, which acts as a dispatcher
206      * depending on $_options[datasource].      * depending on $_options[datasource]. <br>
207      * (main dispatching level)      * (main dispatching level)
208      *      *
209      * The structure of a full blown locator looks like this:      * <br>
210      *      *
211        * The structure of a full blown locator looks like this:
212        * <code>
213      *  $locator = array(      *  $locator = array(
214      *    type => '<your type specifying the datasource-type>',      *    type => '<your type specifying the datasource-type>',
215      *    metadata => array(      *    metadata => array(
# Line 128  class DataSource_Locator { Line 217  class DataSource_Locator {
217      *    ),      *    ),
218      *    [dsn => '<your dsn markup>'],      *    [dsn => '<your dsn markup>'],
219      *  );      *  );
220        * </code>
221      *      *
222      * Example 1 - data is inside a rdbms, using a dsn to connect to it:      * Example 1 - data is inside a rdbms, using a dsn to connect to it:
223        * <code>
224      *  $locator = array(      *  $locator = array(
225      *    dsn => 'mysql://username:password@localhost/database',      *    dsn => 'mysql://username:password@localhost/database',
226      *  );      *  );
227        * </code>
228      *      *
229      * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):      * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc):
230        * <code>
231      *  $locator = array(      *  $locator = array(
232      *    type => 'rpc',      *    type => 'rpc',
233      *    metadata => array(      *    metadata => array(
# Line 143  class DataSource_Locator { Line 236  class DataSource_Locator {
236      *      Port => '8765',      *      Port => '8765',
237      *    )      *    )
238      *  );      *  );
239        * </code>
240        *
241        * @deprecated
242      *      *
243      */      */
244            var $_locator_metadata = NULL;
     //var $_locator_metadata = NULL;  
245    
246    
247          /**     /**
248           * This var holds the arguments passed in to the constructor.      * This var holds the arguments passed in to the constructor.
249           * We will try to build full blown locator metadata information from that.      * We will try to build full blown locator metadata information from that.
250           *      *
251           */      * @deprecated
252          //var $_in = NULL;      *
253        */
254        var $_in = NULL;
255    
256          /**     /**
257           * This var holds the locator metadata informations inside      * This var holds the locator metadata informations inside
258           * a single hash. This is returned from '->get()'.      * a single hash. This is returned from '->get()'.
259           *      *
260           */      * @deprecated
261          //var $_out = NULL;      *
262        */
263        var $_out = NULL;
264    
265    
266          /**          /**
# Line 185  class DataSource_Locator { Line 284  class DataSource_Locator {
284           * The constructor is used to pass in the           * The constructor is used to pass in the
285           * locator metadata hash.           * locator metadata hash.
286           *           *
287           * @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 => '' )  
288           */           */
289          function DataSource_Locator() {          function DataSource_Locator() {
290        $args_multi = func_get_args();        $args_multi = func_get_args();
# Line 262  class DataSource_Locator { Line 360  class DataSource_Locator {
360                    
361          /**          /**
362       * Set the locator metadata hash we will feed *partly*       * Set the locator metadata hash we will feed *partly*
363       * to an encapsulated Data::Driver::Proxy instance.       * to an encapsulated Data::Driver::Proxy instance
364       *       *
365       * @param LocatorMetadataHash array -       * @param LocatorMetadataHash array -
366       *       *
# Line 273  class DataSource_Locator { Line 371  class DataSource_Locator {
371    
372      function &get_metadata() {      function &get_metadata() {
373          //return ($this->_out);          //return ($this->_out);
374            //print Dumper($this->_metadata);
375          return $this->_metadata;          return $this->_metadata;
376      }      }
377    
# Line 281  class DataSource_Locator { Line 380  class DataSource_Locator {
380            
381      // trace      // trace
382        //print Dumper($this);        //print Dumper($this);
383        
384      $good = 0;      $good = 0;
385      switch ($this->_datasource_type) {      switch ($this->_datasource_type) {
386        case 'rpc':        case 'rpc':
# Line 293  class DataSource_Locator { Line 392  class DataSource_Locator {
392            //package => 'DesignPattern::RemoteProxy',            //package => 'DesignPattern::RemoteProxy',
393            Host => RPC_HOSTNAME,            Host => RPC_HOSTNAME,
394            Port => RPC_PORT,            Port => RPC_PORT,
395              DEBUG => defined('RPC_DEBUG') ? RPC_DEBUG : null,
396              TRACE => defined('RPC_TRACE') ? RPC_TRACE : null,
397              DISCONNECT_ON_ERROR => defined('RPC_DISCONNECT_ON_ERROR') ? RPC_DISCONNECT_ON_ERROR : null,
398          );          );
399          $good = 1;          $good = 1;
400          break;          break;
# Line 330  class DataSource_Locator { Line 432  class DataSource_Locator {
432      return 1;      return 1;
433    }    }
434    
435          function get_call() {
436        return array(
437          method => $this->_call[_method],
438          args => $this->_call[_arguments],
439        );
440      }
441    
442  }  }
443    
444  ?>  ?>
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.31
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed