/[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.5 by joko, Wed Mar 5 15:40:39 2003 UTC revision 1.10 by joko, Mon Mar 10 23:25:03 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>   * @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.10  2003/03/10 23:25:03  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.9  2003/03/10 22:31:55  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.8  2003/03/09 15:50:36  joko
34     * + additional metadata for Autodia
35     *
36     * Revision 1.7  2003/03/05 17:13:16  joko
37     * updated docu (phpDocumentor testing....)
38     *
39     * Revision 1.6  2003/03/05 16:10:08  joko
40     * updated docu (phpDocumentor testing....)
41     *
42   * Revision 1.5  2003/03/05 15:40:39  joko   * Revision 1.5  2003/03/05 15:40:39  joko
43   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
44   *   *
# Line 34  Line 53 
53   *   *
54   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
55   * + initial commit   * + initial commit
56     * </pre>
57   *   *
58   *   *
59   */   */
# Line 41  Line 61 
61  /**  /**
62   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
63   *   *
64   * - Pass-Through-Reference: php Object will get passed through all layers   * &lt;ul&gt;
65   * - Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Reference: php Object will get passed through all layers
66   * + Build-Locator: build locator from datasource-type and adapter-type   * o Pass-Through-Memory: reference to a memory area will get used
67   * - Use-Locator: directly use DataSource::Locator instance passed in   * x Build-Locator: build locator from datasource-type and adapter-type
68   * - Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Use-Locator: directly use DataSource::Locator instance passed in
69   * - Build-AutoLocator: use global constants making up our metadata   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
70     * o Build-AutoLocator: use global constants making up our metadata
71     * &lt;ul&gt;
72     *
73   *   *
74   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
75   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
76   * - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * &lt;ul&gt;
77   * + name of a Proxy module to use to *wrap/hide* the connection/transport-layer   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
78     * x name of a Proxy module to use to *wrap/hide* the connection/transport-layer
79   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
80   * + 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')
81   * - 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')
82   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
83   * - a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
84   *   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*
85   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
86   * + an adapter-type (of 'phpHtmlLib|pear')   * x an adapter-type (of 'phpHtmlLib|pear')
87   *   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*
88   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
89   * - names of global constants where to find these informations   * o names of global constants where to find these informations
90   * - datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
91     * &lt;ul&gt;
92   *   *
93   *   *
94   * <b>It can do</b>   * <b>It can do</b>
95   * + builds a larger locator from a minimum of information passed in via constructor-arguments   * - builds a larger locator from a minimum of information passed in via constructor-arguments
96   * o direct fallback mode to some predefined constant names if locator is empty and above method fails   * - direct fallback mode to some predefined constant names if locator is empty and above method fails
97   * o direct fallback mode to some predefined values if just *everything* fails   * - direct fallback mode to some predefined values if just *everything* fails
98   *   *
99   *   *
100   * <b>How to use?</b>   * <b>How to use?</b>
# Line 86  Line 111 
111   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
112   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
113   *    );   *    );
114   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
115   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
116   *    </code>   *    </code>
117   *   *
# Line 95  Line 120 
120   *    $locator = array(   *    $locator = array(
121   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
122   *    );   *    );
123   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
124   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
125   *    </code>   *    </code>
126   *   *
# Line 108  Line 133 
133   * @license GNU LGPL (GNU Lesser General Public License)   * @license GNU LGPL (GNU Lesser General Public License)
134   * @link http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
135   *   *
136     * @package org.netfrag.glib
137     * @subpackage DataSource
138   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
139   *   *
140   */   */
   
   
141  class DataSource_Locator {  class DataSource_Locator {
142    
143    /**    /**
# Line 203  class DataSource_Locator { Line 227  class DataSource_Locator {
227           * The constructor is used to pass in the           * The constructor is used to pass in the
228           * locator metadata hash.           * locator metadata hash.
229           *           *
230           * @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 => '' )  
231           */           */
232          function DataSource_Locator() {          function DataSource_Locator() {
233        $args_multi = func_get_args();        $args_multi = func_get_args();
# Line 280  class DataSource_Locator { Line 303  class DataSource_Locator {
303                    
304          /**          /**
305       * Set the locator metadata hash we will feed *partly*       * Set the locator metadata hash we will feed *partly*
306       * to an encapsulated Data::Driver::Proxy instance.       * to an encapsulated Data::Driver::Proxy instance
307       *       *
308       * @param LocatorMetadataHash array -       * @param LocatorMetadataHash array -
309       *       *
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.10
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed