/[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.6 by joko, Wed Mar 5 16:10:08 2003 UTC revision 1.8 by joko, Sun Mar 9 15:50:36 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     * @filesource
16   *   *
17   */   *
18     * <b>Cvs-Log:</b>
19  /**   *
20     * <pre>
21   * $Id$   * $Id$
22   *   *
23   * $Log$   * $Log$
24     * Revision 1.8  2003/03/09 15:50:36  joko
25     * + additional metadata for Autodia
26     *
27     * Revision 1.7  2003/03/05 17:13:16  joko
28     * updated docu (phpDocumentor testing....)
29     *
30   * Revision 1.6  2003/03/05 16:10:08  joko   * Revision 1.6  2003/03/05 16:10:08  joko
31   * updated docu (phpDocumentor testing....)   * updated docu (phpDocumentor testing....)
32   *   *
# Line 37  Line 44 
44   *   *
45   * Revision 1.1  2003/03/05 12:04:37  joko   * Revision 1.1  2003/03/05 12:04:37  joko
46   * + initial commit   * + initial commit
47     * </pre>
48   *   *
49   *   *
50   */   */
# Line 44  Line 52 
52  /**  /**
53   * It helps DataSource::Generic working in different "operation modes".   * It helps DataSource::Generic working in different "operation modes".
54   *   *
55   * - Pass-Through-Reference: php Object will get passed through all layers   * <ul>
56   * - Pass-Through-Memory: reference to a memory area will get used   * o Pass-Through-Reference: php Object will get passed through all layers
57   * + Build-Locator: build locator from datasource-type and adapter-type   * o Pass-Through-Memory: reference to a memory area will get used
58   * - Use-Locator: directly use DataSource::Locator instance passed in   * x Build-Locator: build locator from datasource-type and adapter-type
59   * - Merge-Locators: merge metadata of two or more DataSource::Locator instances   * o Use-Locator: directly use DataSource::Locator instance passed in
60   * - Build-AutoLocator: use global constants making up our metadata   * o Merge-Locators: merge metadata of two or more DataSource::Locator instances
61     * o Build-AutoLocator: use global constants making up our metadata
62     * </ul>
63   *   *
  * <b>It can/should contain:</b>  
64   *   *
65   * <pre>   * <b>It can/should contain:</b>
66   * (flexible, just some parameters are required for each operation mode)   * (flexible, just some parameters are required for each operation mode)
67   * - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR)   * <ul>
68   * + 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)
69     * x name of a Proxy module to use to *wrap/hide* the connection/transport-layer
70   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)   *   (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy)
71   * + 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')
72   * - 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')
73   *   this will get propagated (pass-through-mode)   *   this will get propagated (pass-through-mode)
74   * - a datasource-type (of 'rpc|mysql|csv-file|xml-file')   * o a datasource-type (of 'rpc|mysql|csv-file|xml-file')
75   *   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*
76   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
77   * + an adapter-type (of 'phpHtmlLib|pear')   * x an adapter-type (of 'phpHtmlLib|pear')
78   *   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*
79   *   by the DataSource::Generic at runtime   *   by the DataSource::Generic at runtime
80   * - names of global constants where to find these informations   * o names of global constants where to find these informations
81   * - datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')   * o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms')
82   * </pre>   * </ul>
83   *   *
84   *   *
85   * <b>It can do</b>   * <b>It can do</b>
86   * + builds a larger locator from a minimum of information passed in via constructor-arguments   * <ul>
87     * # builds a larger locator from a minimum of information passed in via constructor-arguments
88   * o direct fallback mode to some predefined constant names if locator is empty and above method fails   * o direct fallback mode to some predefined constant names if locator is empty and above method fails
89   * o direct fallback mode to some predefined values if just *everything* fails   * o direct fallback mode to some predefined values if just *everything* fails
90     * </ul>
91   *   *
92   *   *
93   * <b>How to use?</b>   * <b>How to use?</b>
# Line 92  Line 104 
104   *      [adapter_type => 'phpHtmlLib',]   *      [adapter_type => 'phpHtmlLib',]
105   *      metadata => array( Host => 'localhost', Port => '8765' ),   *      metadata => array( Host => 'localhost', Port => '8765' ),
106   *    );   *    );
107   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
108   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
109   *    </code>   *    </code>
110   *   *
# Line 101  Line 113 
113   *    $locator = array(   *    $locator = array(
114   *      dsn => 'known dsn markup',   *      dsn => 'known dsn markup',
115   *    );   *    );
116   *    $source = new DataSource::Generic($locator);   *    $source = ne w DataSource::Generic($locator);
117   *    $this->set_data_source( &$source );   *    $this->set_data_source( &$source );
118   *    </code>   *    </code>
119   *   *
# Line 114  Line 126 
126   * @license GNU LGPL (GNU Lesser General Public License)   * @license GNU LGPL (GNU Lesser General Public License)
127   * @link http://www.gnu.org/licenses/lgpl.txt   * @link http://www.gnu.org/licenses/lgpl.txt
128   *   *
129     * @package org.netfrag.glib
130     * @subpackage DataSource
131   * @name DataSource::Locator   * @name DataSource::Locator
  * @filesource  
132   *   *
133   */   */
   
   
134  class DataSource_Locator {  class DataSource_Locator {
135    
136    /**    /**
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.8
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed