--- nfo/php/libs/org.netfrag.glib/DataSource/Locator.php 2003/03/05 15:26:23 1.4 +++ nfo/php/libs/org.netfrag.glib/DataSource/Locator.php 2003/03/05 15:40:39 1.5 @@ -10,15 +10,19 @@ * has to do. * * + * @author Andreas Motl * @package org.netfrag.glib * @module DataSource::Locator * */ /** - * $Id: Locator.php,v 1.4 2003/03/05 15:26:23 joko Exp $ + * $Id: Locator.php,v 1.5 2003/03/05 15:40:39 joko Exp $ * * $Log: Locator.php,v $ + * 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....) * @@ -76,6 +80,7 @@ * Pass an array to the constructor: (e.g.) * * 1. for doing rpc-calls.... + * * $locator = array( * datasource_type => 'rpc', * [adapter_type => 'phpHtmlLib',] @@ -83,13 +88,16 @@ * ); * $source = new DataSource::Generic($locator); * $this->set_data_source( &$source ); + * * * 2. [proposal] for common/oldschool datahandles.... + * * $locator = array( * dsn => 'known dsn markup', * ); * $source = new DataSource::Generic($locator); * $this->set_data_source( &$source ); + * * * * @@ -100,7 +108,6 @@ * @license GNU LGPL (GNU Lesser General Public License) * @link http://www.gnu.org/licenses/lgpl.txt * - * @subpackage DataSource * @name DataSource::Locator * @filesource * @@ -115,12 +122,13 @@ * using metadata from $_options and some * other presets. * - * See '_buildLocator' which acts as a dispatcher + * @see function build, which acts as a dispatcher * depending on $_options[datasource]. * (main dispatching level) * * The structure of a full blown locator looks like this: * + * * $locator = array( * type => '', * metadata => array( @@ -128,13 +136,17 @@ * ), * [dsn => ''], * ); + * * * Example 1 - data is inside a rdbms, using a dsn to connect to it: + * * $locator = array( * dsn => 'mysql://username:password@localhost/database', * ); + * * * Example 2 - data is inside an odbms, reachable by doing remote procedure calls (rpc): + * * $locator = array( * type => 'rpc', * metadata => array( @@ -143,25 +155,31 @@ * Port => '8765', * ) * ); + * + * + * @deprecated * */ - - //var $_locator_metadata = NULL; + var $_locator_metadata = NULL; - /** - * This var holds the arguments passed in to the constructor. - * We will try to build full blown locator metadata information from that. - * - */ - //var $_in = NULL; + /** + * This var holds the arguments passed in to the constructor. + * We will try to build full blown locator metadata information from that. + * + * @deprecated + * + */ + var $_in = NULL; - /** - * This var holds the locator metadata informations inside - * a single hash. This is returned from '->get()'. - * - */ - //var $_out = NULL; + /** + * This var holds the locator metadata informations inside + * a single hash. This is returned from '->get()'. + * + * @deprecated + * + */ + var $_out = NULL; /**