diff options
author | ctrlaltca <> | 2012-07-12 11:21:01 +0000 |
---|---|---|
committer | ctrlaltca <> | 2012-07-12 11:21:01 +0000 |
commit | 903ae8a581fac1e6917fc3e31d2ad8fb91df80c3 (patch) | |
tree | e08bf04f0823650a231227ac3499121270172a23 /framework/Data/TDataSourceConfig.php | |
parent | 3e4e6e66aeb3f8fea4e1eb4237498ef9d2358f63 (diff) |
standardize the use of unix eol; use svn properties to enforce native eol
Diffstat (limited to 'framework/Data/TDataSourceConfig.php')
-rw-r--r-- | framework/Data/TDataSourceConfig.php | 334 |
1 files changed, 167 insertions, 167 deletions
diff --git a/framework/Data/TDataSourceConfig.php b/framework/Data/TDataSourceConfig.php index a880c522..84d23dc6 100644 --- a/framework/Data/TDataSourceConfig.php +++ b/framework/Data/TDataSourceConfig.php @@ -1,167 +1,167 @@ -<?php
-/**
- * TDataSourceConfig class file.
- *
- * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
- * @link http://www.pradosoft.com/
- * @copyright Copyright © 2005-2012 PradoSoft
- * @license http://www.pradosoft.com/license/
- * @version $Id$
- * @package System.Data
- */
-
-Prado::using('System.Data.TDbConnection');
-
-/**
- * TDataSourceConfig module class provides <module> configuration for database connections.
- *
- * Example usage: mysql connection
- * <code>
- * <modules>
- * <module id="db1">
- * <database ConnectionString="mysqli:host=localhost;dbname=test"
- * username="dbuser" password="dbpass" />
- * </module>
- * </modules>
- * </code>
- *
- * Usage in php:
- * <code>
- * class Home extends TPage
- * {
- * function onLoad($param)
- * {
- * $db = $this->Application->Modules['db1']->DbConnection;
- * $db->createCommand('...'); //...
- * }
- * }
- * </code>
- *
- * The properties of <connection> are those of the class TDbConnection.
- * Set {@link setConnectionClass} attribute for a custom database connection class
- * that extends the TDbConnection class.
- *
- * @author Wei Zhuo <weizho[at]gmail[dot]com>
- * @version $Id$
- * @package System.Data
- * @since 3.1
- */
-class TDataSourceConfig extends TModule
-{
- private $_connID='';
- private $_conn;
- private $_connClass='System.Data.TDbConnection';
-
- /**
- * Initalize the database connection properties from attributes in <database> tag.
- * @param TXmlDocument xml configuration.
- */
- public function init($xml)
- {
- if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
- {
- if(isset($xml['database']) && is_array($xml['database']))
- {
- $db=$this->getDbConnection();
- foreach($xml['database'] as $name=>$value)
- $db->setSubProperty($name,$value);
- }
- }
- else
- {
- if($prop=$xml->getElementByTagName('database'))
- {
- $db=$this->getDbConnection();
- foreach($prop->getAttributes() as $name=>$value)
- $db->setSubproperty($name,$value);
- }
- }
- }
-
- /**
- * The module ID of another TDataSourceConfig. The {@link getDbConnection DbConnection}
- * property of this configuration will equal to {@link getDbConnection DbConnection}
- * of the given TDataSourceConfig module.
- * @param string module ID.
- */
- public function setConnectionID($value)
- {
- $this->_connID=$value;
- }
-
- /**
- * @return string connection module ID.
- */
- public function getConnectionID()
- {
- return $this->_connID;
- }
-
- /**
- * Gets the TDbConnection from another module if {@link setConnectionID ConnectionID}
- * is supplied and valid. Otherwise, a connection of type given by
- * {@link setConnectionClass ConnectionClass} is created.
- * @return TDbConnection database connection.
- */
- public function getDbConnection()
- {
- if($this->_conn===null)
- {
- if($this->_connID!=='')
- $this->_conn = $this->findConnectionByID($this->getConnectionID());
- else
- $this->_conn = Prado::createComponent($this->getConnectionClass());
- }
- return $this->_conn;
- }
-
- /**
- * Alias for getDbConnection().
- * @return TDbConnection database connection.
- */
- public function getDatabase()
- {
- return $this->getDbConnection();
- }
-
- /**
- * @param string Database connection class name to be created.
- */
- public function getConnectionClass()
- {
- return $this->_connClass;
- }
-
- /**
- * The database connection class name to be created when {@link getDbConnection}
- * method is called <b>and</b> {@link setConnectionID ConnectionID} is null. The
- * {@link setConnectionClass ConnectionClass} property must be set before
- * calling {@link getDbConnection} if you wish to create the connection using the
- * given class name.
- * @param string Database connection class name.
- * @throws TConfigurationException when database connection is already established.
- */
- public function setConnectionClass($value)
- {
- if($this->_conn!==null)
- throw new TConfigurationException('datasource_dbconnection_exists', $value);
- $this->_connClass=$value;
- }
-
- /**
- * Finds the database connection instance from the Application modules.
- * @param string Database connection module ID.
- * @return TDbConnection database connection.
- * @throws TConfigurationException when module is not of TDbConnection or TDataSourceConfig.
- */
- protected function findConnectionByID($id)
- {
- $conn = $this->getApplication()->getModule($id);
- if($conn instanceof TDbConnection)
- return $conn;
- else if($conn instanceof TDataSourceConfig)
- return $conn->getDbConnection();
- else
- throw new TConfigurationException('datasource_dbconnection_invalid',$id);
- }
-}
+<?php +/** + * TDataSourceConfig class file. + * + * @author Wei Zhuo <weizhuo[at]gmail[dot]com> + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2005-2012 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Id$ + * @package System.Data + */ + +Prado::using('System.Data.TDbConnection'); + +/** + * TDataSourceConfig module class provides <module> configuration for database connections. + * + * Example usage: mysql connection + * <code> + * <modules> + * <module id="db1"> + * <database ConnectionString="mysqli:host=localhost;dbname=test" + * username="dbuser" password="dbpass" /> + * </module> + * </modules> + * </code> + * + * Usage in php: + * <code> + * class Home extends TPage + * { + * function onLoad($param) + * { + * $db = $this->Application->Modules['db1']->DbConnection; + * $db->createCommand('...'); //... + * } + * } + * </code> + * + * The properties of <connection> are those of the class TDbConnection. + * Set {@link setConnectionClass} attribute for a custom database connection class + * that extends the TDbConnection class. + * + * @author Wei Zhuo <weizho[at]gmail[dot]com> + * @version $Id$ + * @package System.Data + * @since 3.1 + */ +class TDataSourceConfig extends TModule +{ + private $_connID=''; + private $_conn; + private $_connClass='System.Data.TDbConnection'; + + /** + * Initalize the database connection properties from attributes in <database> tag. + * @param TXmlDocument xml configuration. + */ + public function init($xml) + { + if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP) + { + if(isset($xml['database']) && is_array($xml['database'])) + { + $db=$this->getDbConnection(); + foreach($xml['database'] as $name=>$value) + $db->setSubProperty($name,$value); + } + } + else + { + if($prop=$xml->getElementByTagName('database')) + { + $db=$this->getDbConnection(); + foreach($prop->getAttributes() as $name=>$value) + $db->setSubproperty($name,$value); + } + } + } + + /** + * The module ID of another TDataSourceConfig. The {@link getDbConnection DbConnection} + * property of this configuration will equal to {@link getDbConnection DbConnection} + * of the given TDataSourceConfig module. + * @param string module ID. + */ + public function setConnectionID($value) + { + $this->_connID=$value; + } + + /** + * @return string connection module ID. + */ + public function getConnectionID() + { + return $this->_connID; + } + + /** + * Gets the TDbConnection from another module if {@link setConnectionID ConnectionID} + * is supplied and valid. Otherwise, a connection of type given by + * {@link setConnectionClass ConnectionClass} is created. + * @return TDbConnection database connection. + */ + public function getDbConnection() + { + if($this->_conn===null) + { + if($this->_connID!=='') + $this->_conn = $this->findConnectionByID($this->getConnectionID()); + else + $this->_conn = Prado::createComponent($this->getConnectionClass()); + } + return $this->_conn; + } + + /** + * Alias for getDbConnection(). + * @return TDbConnection database connection. + */ + public function getDatabase() + { + return $this->getDbConnection(); + } + + /** + * @param string Database connection class name to be created. + */ + public function getConnectionClass() + { + return $this->_connClass; + } + + /** + * The database connection class name to be created when {@link getDbConnection} + * method is called <b>and</b> {@link setConnectionID ConnectionID} is null. The + * {@link setConnectionClass ConnectionClass} property must be set before + * calling {@link getDbConnection} if you wish to create the connection using the + * given class name. + * @param string Database connection class name. + * @throws TConfigurationException when database connection is already established. + */ + public function setConnectionClass($value) + { + if($this->_conn!==null) + throw new TConfigurationException('datasource_dbconnection_exists', $value); + $this->_connClass=$value; + } + + /** + * Finds the database connection instance from the Application modules. + * @param string Database connection module ID. + * @return TDbConnection database connection. + * @throws TConfigurationException when module is not of TDbConnection or TDataSourceConfig. + */ + protected function findConnectionByID($id) + { + $conn = $this->getApplication()->getModule($id); + if($conn instanceof TDbConnection) + return $conn; + else if($conn instanceof TDataSourceConfig) + return $conn->getDbConnection(); + else + throw new TConfigurationException('datasource_dbconnection_invalid',$id); + } +} |