One class per file: framework/Data (continue)

2 files changed, 377 insertions, 0 deletions

diff --git a/framework/Data/DataGateway/TDataGatewayCommand.php b/framework/Data/DataGateway/TDataGatewayCommand.php
new file mode 100644
index 00000000..7f92dbf5
--- /dev/null
+++ b/framework/Data/DataGateway/TDataGatewayCommand.php
@@ -0,0 +1,185 @@
+<?php
+/**
+ * TDataGatewayCommand, TDataGatewayEventParameter and TDataGatewayResultEventParameter class file.
+ *
+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright &copy; 2005-2014 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Id$
+ * @package System.Data.DataGateway
+ */
+
+/**
+ * TDataGatewayCommand is command builder and executor class for
+ * TTableGateway and TActiveRecordGateway.
+ *
+ * TDataGatewayCommand builds the TDbCommand for TTableGateway
+ * and TActiveRecordGateway commands such as find(), update(), insert(), etc,
+ * using the TDbCommandBuilder classes (database specific TDbCommandBuilder
+ * classes are used).
+ *
+ * Once the command is built and the query parameters are binded, the
+ * {@link OnCreateCommand} event is raised. Event handlers for the OnCreateCommand
+ * event should not alter the Command property nor the Criteria property of the
+ * TDataGatewayEventParameter.
+ *
+ * TDataGatewayCommand excutes the TDbCommands and returns the result obtained from the
+ * database (returned value depends on the method executed). The
+ * {@link OnExecuteCommand} event is raised after the command is executed and resulting
+ * data is set in the TDataGatewayResultEventParameter object's Result property.
+ *
+ * @author Wei Zhuo <weizho[at]gmail[dot]com>
+ * @version $Id$
+ * @package System.Data.DataGateway
+ * @since 3.1
+ */
+class TDataGatewayCommand extends TComponent
+{
+	private $_builder;
+
+	/**
+	 * @param TDbCommandBuilder database specific database command builder.
+	 */
+	public function __construct($builder)
+	{
+		$this->_builder = $builder;
+	}
+
+	/**
+	 * @return TDbTableInfo
+	 */
+	public function getTableInfo()
+	{
+		return $this->_builder->getTableInfo();
+	}
+
+	/**
+	 * @return TDbConnection
+	 */
+	public function getDbConnection()
+	{
+		return $this->_builder->getDbConnection();
+	}
+
+	/**
+	 * @return TDbCommandBuilder
+	 */
+	public function getBuilder()
+	{
+		return $this->_builder;
+	}
+
+	/**
+	 * Executes a delete command.
+	 * @param TSqlCriteria delete conditions and parameters.
+	 * @return integer number of records affected.
+	 */
+	public function delete($criteria)
+	{
+		$where = $criteria->getCondition();
+		$parameters = $criteria->getParameters()->toArray();
+		$command = $this->getBuilder()->createDeleteCommand($where, $parameters);
+		$this->onCreateCommand($command,$criteria);
+		$command->prepare();
+		return $command->execute();
+	}
+
+	/**
+	 * Updates the table with new data.
+	 * @param array date for update.
+	 * @param TSqlCriteria update conditions and parameters.
+	 * @return integer number of records affected.
+	 */
+	public function update($data, $criteria)
+	{
+		$where = $criteria->getCondition();
+		$parameters = $criteria->getParameters()->toArray();
+		$command = $this->getBuilder()->createUpdateCommand($data,$where, $parameters);
+		$this->onCreateCommand($command,$criteria);
+		$command->prepare();
+		return $this->onExecuteCommand($command, $command->execute());
+	}
+
+	/**
+	 * @param array update for update
+	 * @param array primary key-value name pairs.
+	 * @return integer number of records affected.
+	 */
+	public function updateByPk($data, $keys)
+	{
+		list($where, $parameters) = $this->getPrimaryKeyCondition((array)$keys);
+		return $this->update($data, new TSqlCriteria($where, $parameters));
+	}
+
+	/**
+	 * Find one record matching the critera.
+	 * @param TSqlCriteria find conditions and parameters.
+	 * @return array matching record.
+	 */
+	public function find($criteria)
+	{
+		$command = $this->getFindCommand($criteria);
+		return $this->onExecuteCommand($command, $command->queryRow());
+	}
+
+	/**
+	 * Find one or more matching records.
+	 * @param TSqlCriteria $criteria
+	 * @return TDbDataReader record reader.
+	 */
+	public function findAll($criteria)
+	{
+		$command = $this->getFindCommand($criteria);
+		return $this->onExecuteCommand($command, $command->query());
+	}
+
+	/**
+	 * Build the find command from the criteria. Limit, Offset and Ordering are applied if applicable.
+	 * @param TSqlCriteria $criteria
+	 * @return TDbCommand.
+	 */
+	protected function getFindCommand($criteria)
+	{
+		if($criteria===null)
+			return $this->getBuilder()->createFindCommand();
+		$where = $criteria->getCondition();
+		$parameters = $criteria->getParameters()->toArray();
+		$ordering = $criteria->getOrdersBy();
+		$limit = $criteria->getLimit();
+		$offset = $criteria->getOffset();
+		$select = $criteria->getSelect();
+		$command = $this->getBuilder()->createFindCommand($where,$parameters,$ordering,$limit,$offset,$select);
+		$this->onCreateCommand($command, $criteria);
+		return $command;
+	}
+
+	/**
+	 * @param mixed primary key value, or composite key values as array.
+	 * @return array matching record.
+	 */
+	public function findByPk($keys)
+	{
+		list($where, $parameters) = $this->getPrimaryKeyCondition((array)$keys);
+		$command = $this->getBuilder()->createFindCommand($where, $parameters);
+		$this->onCreateCommand($command, new TSqlCriteria($where,$parameters));
+		return $this->onExecuteCommand($command, $command->queryRow());
+	}
+
+	/**
+	 * @param array multiple primary key values or composite value arrays
+	 * @return TDbDataReader record reader.
+	 */
+	public function findAllByPk($keys)
+	{
+		$where = $this->getCompositeKeyCondition((array)$keys);
+		$command = $this->getBuilder()->createFindCommand($where);
+		$this->onCreateCommand($command, new TSqlCriteria($where,$keys));
+		return $this->onExecuteCommand($command,$command->query());
+	}
+
+	public function findAllByIndex($criteria,$fields,$values)
+	{
+		$index = $this->getIndexKeyCondition($this->getTableInfo(),$fields,$values);
+		if(strlen($where = $criteria->getCondition())>0)
+			$criteria->setCondition("({$index}) AND ({$where}
\ No newline at end of file
diff --git a/framework/Data/SqlMap/Configuration/TSqlMapXmlConfiguration.php b/framework/Data/SqlMap/Configuration/TSqlMapXmlConfiguration.php
new file mode 100644
index 00000000..bd2070bb
--- /dev/null
+++ b/framework/Data/SqlMap/Configuration/TSqlMapXmlConfiguration.php
@@ -0,0 +1,192 @@
+<?php
+/**
+ * TSqlMapXmlConfigBuilder, TSqlMapXmlConfiguration, TSqlMapXmlMappingConfiguration classes file.
+ *
+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright &copy; 2005-2014 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @package System.Data.SqlMap.Configuration
+ */']";
+			foreach($document->xpath($xpath) as $node)
+				return $node;
+		}
+	}
+
+	/**
+	 * @return string configuration file.
+	 */
+	protected abstract function getConfigFile();
+}
+
+/**
+ * TSqlMapXmlConfig class.
+ *
+ * Configures the TSqlMapManager using xml configuration file.
+ *
+ * @author Wei Zhuo <weizho[at]gmail[dot]com>
+ * @package System.Data.SqlMap.Configuration
+ * @since 3.1
+ */
+class TSqlMapXmlConfiguration extends TSqlMapXmlConfigBuilder
+{
+	/**
+	 * @var TSqlMapManager manager
+	 */
+	private $_manager;
+	/**
+	 * @var string configuration file.
+	 */
+	private $_configFile;
+	/**
+	 * @var array global properties.
+	 */
+	private $_properties=array();
+
+	/**
+	 * @param TSqlMapManager manager instance.
+	 */
+	public function __construct($manager)
+	{
+		$this->_manager=$manager;
+	}
+
+	public function getManager()
+	{
+		return $this->_manager;
+	}
+
+	protected function getConfigFile()
+	{
+		return $this->_configFile;
+	}
+
+	/**
+	 * Configure the TSqlMapManager using the given xml file.
+	 * @param string SqlMap configuration xml file.
+	 */
+	public function configure($filename=null)
+	{
+		$this->_configFile=$filename;
+		$document = $this->loadXmlDocument($filename,$this);
+
+		foreach($document->xpath('//property') as $property)
+			$this->loadGlobalProperty($property);
+
+		foreach($document->xpath('//typeHandler') as $handler)
+			$this->loadTypeHandler($handler);
+
+		foreach($document->xpath('//connection[last()]') as $conn)
+			$this->loadDatabaseConnection($conn);
+
+		//try to load configuration in the current config file.
+		$mapping = new TSqlMapXmlMappingConfiguration($this);
+		$mapping->configure($filename);
+
+		foreach($document->xpath('//sqlMap') as $sqlmap)
+			$this->loadSqlMappingFiles($sqlmap);
+
+		$this->resolveResultMapping();
+		$this->attachCacheModels();
+	}
+
+	/**
+	 * Load global replacement property.
+	 * @param SimpleXmlElement property node.
+	 */
+	protected function loadGlobalProperty($node)
+	{
+		$this->_properties[(string)$node['name']] = (string)$node['value'];
+	}
+
+	/**
+	 * Load the type handler configurations.
+	 * @param SimpleXmlElement type handler node
+	 */
+	protected function loadTypeHandler($node)
+	{
+		$handler = $this->createObjectFromNode($node);
+		$this->_manager->getTypeHandlers()->registerTypeHandler($handler);
+	}
+
+	/**
+	 * Load the database connection tag.
+	 * @param SimpleXmlElement connection node.
+	 */
+	protected function loadDatabaseConnection($node)
+	{
+		$conn = $this->createObjectFromNode($node);
+		$this->_manager->setDbConnection($conn);
+	}
+
+	/**
+	 * Load SqlMap mapping configuration.
+	 * @param unknown_type $node
+	 */
+	protected function loadSqlMappingFiles($node)
+	{
+		if(strlen($resource = (string)$node['resource']) > 0)
+		{
+			if( strpos($resource, '${') !== false)
+				$resource = $this->replaceProperties($resource);
+
+			$mapping = new TSqlMapXmlMappingConfiguration($this);
+			$filename = $this->getAbsoluteFilePath($this->_configFile, $resource);
+			$mapping->configure($filename);
+		}
+	}
+
+	/**
+	 * Resolve nest result mappings.
+	 */
+	protected function resolveResultMapping()
+	{
+		$maps = $this->_manager->getResultMaps();
+		foreach($maps as $entry)
+		{
+			foreach($entry->getColumns() as $item)
+			{
+				$resultMap = $item->getResultMapping();
+				if(strlen($resultMap) > 0)
+				{
+					if($maps->contains($resultMap))
+						$item->setNestedResultMap($maps[$resultMap]);
+					else
+						throw new TSqlMapConfigurationException(
+							'sqlmap_unable_to_find_result_mapping',
+								$resultMap, $this->_configFile, $entry->getID());
+				}
+			}
+			if($entry->getDiscriminator()!==null)
+				$entry->getDiscriminator()->initialize($this->_manager);
+		}
+	}
+
+	/**
+	 * Set the cache for each statement having a cache model property.
+	 */
+	protected function attachCacheModels()
+	{
+		foreach($this->_manager->getMappedStatements() as $mappedStatement)
+		{
+			if(strlen($model = $mappedStatement->getStatement()->getCacheModel()) > 0)
+			{
+				$cache = $this->_manager->getCacheModel($model);
+				$mappedStatement->getStatement()->setCache($cache);
+			}
+		}
+	}
+
+	/**
+	 * Replace the place holders ${name} in text with properties the
+	 * corresponding global property value.
+	 * @param string original string.
+	 * @return string string with global property replacement.
+	 */
+	public function replaceProperties($string)
+	{
+		foreach($this->_properties as $find => $replace)
+			$string = str_replace('${'.$find.'}', $replace, $string);
+		return $string;
+	}
+}
\ No newline at end of file