/[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.11 by joko, Tue Mar 11 00:12:49 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.11  2003/03/11 00:12:49  joko
28     * + fixed metadata for phpDocumentor
29     *
30     * Revision 1.10  2003/03/10 23:25:03  joko
31     * + fixed metadata for phpDocumentor
32     *
33     * Revision 1.9  2003/03/10 22:31:55  joko
34     * + fixed metadata for phpDocumentor
35     *
36     * Revision 1.8  2003/03/09 15:50:36  joko
37     * + additional metadata for Autodia
38     *
39     * Revision 1.7  2003/03/05 17:13:16  joko
40     * updated docu (phpDocumentor testing....)
41     *
42     * Revision 1.6  2003/03/05 16:10:08  joko
43     * updated docu (phpDocumentor testing....)
44     *
45   * Revision 1.5  2003/03/05 15:40:39  joko   * Revision 1.5  2003/03/05 15:40:39  joko
46   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
47   *   *
# Line 34  Line 56 
56   *   *
57   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
58   * + initial commit   * + initial commit
59     * </pre>
60   *   *
61   *   *
62   */   */
# Line 41  Line 64 
64  /**  /**
65   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
66   *   *
67   * - Pass-Through-Reference: php Object will get passed through all layers   * o Pass-Through-Reference: php Object will get passed through all layers
68   * - Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Memory: reference to a memory area will get used
69   * + Build-Locator: build locator from datasource-type and adapter-type   * + Build-Locator: build locator from datasource-type and adapter-type
70   * - Use-Locator: directly use DataSource::Locator instance passed in   * o Use-Locator: directly use DataSource::Locator instance passed in
71   * - Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
72   * - Build-AutoLocator: use global constants making up our metadata   * o Build-AutoLocator: use global constants making up our metadata
73     *
74   *   *
75   * <b>It can/should contain:</b>   * <b>It can/should contain:</b>
76   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
77   * - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)
78   * + 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
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   *   *
92   *   *
93   * <b>It can do</b>   * <b>It can do</b>
94   * + 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
95   * 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
96   * o direct fallback mode to some predefined values if just *everything* fails   * - direct fallback mode to some predefined values if just *everything* fails
97   *   *
98   *   *
99   * <b>How to use?</b>   * <b>How to use?</b>
# Line 86  Line 110 
110   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
111   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
112   *    );   *    );
113   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
114   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
115   *    </code>   *    </code>
116   *   *
# Line 95  Line 119 
119   *    $locator = array(   *    $locator = array(
120   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
121   *    );   *    );
122   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
123   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
124   *    </code>   *    </code>
125   *   *
# Line 108  Line 132 
132   * @license GNU LGPL (GNU Lesser General Public License)   * @license GNU LGPL (GNU Lesser General Public License)
133   * @link http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
134   *   *
135     * @package org.netfrag.glib
136     * @subpackage DataSource
137   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
138   *   *
139   */   */
   
   
140  class DataSource_Locator {  class DataSource_Locator {
141    
142    /**    /**
# Line 203  class DataSource_Locator { Line 226  class DataSource_Locator {
226           * The constructor is used to pass in the           * The constructor is used to pass in the
227           * locator metadata hash.           * locator metadata hash.
228           *           *
229           * @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 => '' )  
230           */           */
231          function DataSource_Locator() {          function DataSource_Locator() {
232        $args_multi = func_get_args();        $args_multi = func_get_args();
# Line 280  class DataSource_Locator { Line 302  class DataSource_Locator {
302                    
303          /**          /**
304       * Set the locator metadata hash we will feed *partly*       * Set the locator metadata hash we will feed *partly*
305       * to an encapsulated Data::Driver::Proxy instance.       * to an encapsulated Data::Driver::Proxy instance
306       *       *
307       * @param LocatorMetadataHash array -       * @param LocatorMetadataHash array -
308       *       *
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.11
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed