Prado\Data\SqlMap\Configuration\TSqlMapXmlMappingConfiguration

Complexity

Total Complexity

83

Size/Duplication

Total Lines	529
Duplicated Lines	0 %

Test Coverage

Coverage

31.58%

Importance

Changes	1
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
B	createResultMap()	0	39	6
A	loadStatementTag()	0	7	1
A	createParameterMap()	0	10	2
A	loadSelectKeyTag()	0	10	1
A	loadDeleteTag()	0	7	1
A	createInsertStatement()	0	8	2
A	loadUpdateTag()	0	7	1
A	__construct()	0	4	1
A	loadFlushOnCache()	0	9	4
A	processSqlStatement()	0	20	4
A	loadProcedureTag()	0	2	1
B	loadResultMap()	0	30	7
F	configure()	0	54	12
A	applyInlineParameterMap()	0	24	4
A	registerCacheTriggers()	0	7	3
B	loadFlushInterval()	0	27	9
A	loadSelectTag()	0	12	3
B	loadCacheModel()	0	36	10
A	getConfigFile()	0	3	1
B	loadParameterMap()	0	27	7
A	prepareSql()	0	14	2
A	loadInsertTag()	0	6	1

<?php

/**
 * TSqlMapXmlConfigBuilder, TSqlMapXmlConfiguration, TSqlMapXmlMappingConfiguration classes file.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Data\SqlMap\Configuration;

use Prado\Caching\TFileCacheDependency;
use Prado\Data\SqlMap\DataMapper\TPropertyAccess;
use Prado\Data\SqlMap\DataMapper\TSqlMapConfigurationException;
use Prado\Data\SqlMap\Statements\TCachingStatement;
use Prado\Data\SqlMap\Statements\TDeleteMappedStatement;
use Prado\Data\SqlMap\Statements\TInsertMappedStatement;
use Prado\Data\SqlMap\Statements\TMappedStatement;
use Prado\Data\SqlMap\Statements\TSimpleDynamicSql;
use Prado\Data\SqlMap\Statements\TStaticSql;
use Prado\Data\SqlMap\Statements\TUpdateMappedStatement;
use Prado\Prado;

/**
 * Loads the statements, result maps, parameters maps from xml configuration.
 *
 * description
 *
 * @author Wei Zhuo <weizho[at]gmail[dot]com>
 * @since 3.1
 */
class TSqlMapXmlMappingConfiguration extends TSqlMapXmlConfigBuilder
{
	private $_xmlConfig;
	private $_configFile;
	private $_manager;

	private $_document;

	private $_FlushOnExecuteStatements = [];

	/**
	 * Regular expressions for escaping simple/inline parameter symbols
	 */
	public const SIMPLE_MARK = '$';
	public const INLINE_SYMBOL = '#';
	public const ESCAPED_SIMPLE_MARK_REGEXP = '/\$\$/';
	public const ESCAPED_INLINE_SYMBOL_REGEXP = '/\#\#/';
	public const SIMPLE_PLACEHOLDER = '`!!`';
	public const INLINE_PLACEHOLDER = '`!!!`';

	/**
	 * @param TSqlMapXmlConfiguration $xmlConfig parent xml configuration.
	 */
	public function __construct(TSqlMapXmlConfiguration $xmlConfig)
	{
		$this->_xmlConfig = $xmlConfig;
		$this->_manager = $xmlConfig->getManager();
	}

	protected function getConfigFile()
	{
		return $this->_configFile;
	}

	/**
	 * Configure an XML mapping.
	 * @param string $filename xml mapping filename.
	 */
	public function configure($filename)
	{
		$this->_configFile = $filename;
		$document = $this->loadXmlDocument($filename, $this->_xmlConfig);
		$this->_document = $document;

		static $bCacheDependencies;
		if ($bCacheDependencies === null) {
			$bCacheDependencies = true;
		} //Prado::getApplication()->getMode() !== TApplicationMode::Performance;

		if ($bCacheDependencies) {
			$this->_manager->getCacheDependencies()
				->getDependencies()
				->add(new TFileCacheDependency($filename));
		}

		foreach ($document->xpath('//resultMap') as $node) {
			$this->loadResultMap($node);
		}

		foreach ($document->xpath('//parameterMap') as $node) {
			$this->loadParameterMap($node);
		}

		foreach ($document->xpath('//statement') as $node) {
			$this->loadStatementTag($node);
		}

		foreach ($document->xpath('//select') as $node) {
			$this->loadSelectTag($node);
		}

		foreach ($document->xpath('//insert') as $node) {
			$this->loadInsertTag($node);
		}

		foreach ($document->xpath('//update') as $node) {
			$this->loadUpdateTag($node);
		}

		foreach ($document->xpath('//delete') as $node) {
			$this->loadDeleteTag($node);
		}

		foreach ($document->xpath('//procedure') as $node) {
			$this->loadProcedureTag($node);
		}

		foreach ($document->xpath('//cacheModel') as $node) {
			$this->loadCacheModel($node);
		}

		$this->registerCacheTriggers();
	}

	/**
	 * Load the result maps.
	 * @param \SimpleXmlElement $node result map node.
	 */
	protected function loadResultMap($node)
	{
		$resultMap = $this->createResultMap($node);

		//find extended result map.
		$extendMap = $resultMap->getExtends();
		if ($extendMap !== null && strlen($extendMap) > 0) {
			if (!$this->_manager->getResultMaps()->contains($extendMap)) {
				$extendNode = $this->getElementByIdValue($this->_document, 'resultMap', $extendMap);
				if ($extendNode !== null) {
					$this->loadResultMap($extendNode);
				}
			}

			if (!$this->_manager->getResultMaps()->contains($extendMap)) {
				throw new TSqlMapConfigurationException(
					'sqlmap_unable_to_find_parent_result_map',
					$node,
					$this->_configFile,
					$extendMap
				);
			}

			$superMap = $this->_manager->getResultMap($extendMap);
			$resultMap->getColumns()->mergeWith($superMap->getColumns());
		}

		//add the result map
		if (!$this->_manager->getResultMaps()->contains($resultMap->getID())) {
			$this->_manager->addResultMap($resultMap);
		}
	}

	/**
	 * Create a new result map and its associated result properties,
	 * disciminiator and sub maps.
	 * @param \SimpleXmlElement $node result map node
	 * @return TResultMap SqlMap result mapping.
	 */
	protected function createResultMap($node)
	{
		$resultMap = new TResultMap();
		$this->setObjectPropFromNode($resultMap, $node);

		//result nodes
		foreach ($node->result as $result) {
			$property = new TResultProperty($resultMap);
			$this->setObjectPropFromNode($property, $result);
			$resultMap->addResultProperty($property);
		}

		//create the discriminator
		$discriminator = null;
		if (isset($node->discriminator)) {
			$discriminator = new TDiscriminator();
			$this->setObjectPropFromNode($discriminator, $node->discriminator);
			$discriminator->initMapping($resultMap);
		}

		foreach ($node->xpath('subMap') as $subMapNode) {
			if ($discriminator === null) {
				throw new TSqlMapConfigurationException(
					'sqlmap_undefined_discriminator',
					$node,
					$this->_configFile,
					$subMapNode
				);
			}
			$subMap = new TSubMap();
			$this->setObjectPropFromNode($subMap, $subMapNode);
			$discriminator->addSubMap($subMap);
		}

		if ($discriminator !== null) {
			$resultMap->setDiscriminator($discriminator);
		}

		return $resultMap;
	}

	/**
	 * Load parameter map from xml.
	 *
	 * @param \SimpleXmlElement $node parameter map node.
	 */
	protected function loadParameterMap($node)
	{
		$parameterMap = $this->createParameterMap($node);
		$extendMap = $parameterMap->getExtends();
		if ($extendMap !== null && strlen($extendMap) > 0) {
			if (!$this->_manager->getParameterMaps()->contains($extendMap)) {
				$extendNode = $this->getElementByIdValue($this->_document, 'parameterMap', $extendMap);
				if ($extendNode !== null) {
					$this->loadParameterMap($extendNode);
				}
			}

			if (!$this->_manager->getParameterMaps()->contains($extendMap)) {
				throw new TSqlMapConfigurationException(
					'sqlmap_unable_to_find_parent_parameter_map',
					$node,
					$this->_configFile,
					$extendMap
				);
			}
			$superMap = $this->_manager->getParameterMap($extendMap);
			$index = 0;
			foreach ($superMap->getPropertyNames() as $propertyName) {
				$parameterMap->insertProperty($index++, $superMap->getProperty($propertyName));
			}
		}
		$this->_manager->addParameterMap($parameterMap);
	}

	/**
	 * Create a new parameter map from xml node.
	 * @param \SimpleXmlElement $node parameter map node.
	 * @return TParameterMap new parameter mapping.
	 */
	protected function createParameterMap($node)
	{
		$parameterMap = new TParameterMap();
		$this->setObjectPropFromNode($parameterMap, $node);
		foreach ($node->parameter as $parameter) {
			$property = new TParameterProperty();
			$this->setObjectPropFromNode($property, $parameter);
			$parameterMap->addProperty($property);
		}
		return $parameterMap;
	}

	/**
	 * Load statement mapping from xml configuration file.
	 * @param \SimpleXmlElement $node statement node.
	 */
	protected function loadStatementTag($node)
	{
		$statement = new TSqlMapStatement();
		$this->setObjectPropFromNode($statement, $node);
		$this->processSqlStatement($statement, $node);
		$mappedStatement = new TMappedStatement($this->_manager, $statement);
		$this->_manager->addMappedStatement($mappedStatement);
	}

	/**
	 * Load extended SQL statements if application. Replaces global properties
	 * in the sql text. Extracts inline parameter maps.
	 * @param TSqlMapStatement $statement mapped statement.
	 * @param \SimpleXmlElement $node statement node.
	 */
	protected function processSqlStatement($statement, $node)
	{
		$commandText = (string) $node;
		$extend = $statement->getExtends();
		if ($extend !== null && strlen($extend) > 0) {
			$superNode = $this->getElementByIdValue($this->_document, '*', $extend);
			if ($superNode !== null) {
				$commandText = (string) $superNode . $commandText;
			} else {
				throw new TSqlMapConfigurationException(
					'sqlmap_unable_to_find_parent_sql',
					$extend,
					$this->_configFile,
					$node
				);
			}
		}
		//$commandText = $this->_xmlConfig->replaceProperties($commandText);
		$statement->initialize($this->_manager);
		$this->applyInlineParameterMap($statement, $commandText, $node);
	}

	/**
	 * Extract inline parameter maps.
	 * @param TSqlMapStatement $statement statement object.
	 * @param string $sqlStatement sql text
	 * @param \SimpleXmlElement $node statement node.
	 */
	protected function applyInlineParameterMap($statement, $sqlStatement, $node)
	{
		$scope['file'] = $this->_configFile;

$scope was never initialized. Although not strictly required by PHP, it is generally a good practice to add $scope = array(); before regardless.

		$scope['node'] = $node;

		$sqlStatement = preg_replace(self::ESCAPED_INLINE_SYMBOL_REGEXP, self::INLINE_PLACEHOLDER, $sqlStatement);
		if ($statement->parameterMap() === null) {
			// Build a Parametermap with the inline parameters.
			// if they exist. Then delete inline infos from sqltext.
			$parameterParser = new TInlineParameterMapParser();
			$sqlText = $parameterParser->parse($sqlStatement, $scope);
			if (count($sqlText['parameters']) > 0) {
				$map = new TParameterMap();
				$map->setID($statement->getID() . '-InLineParameterMap');
				$statement->setInlineParameterMap($map);
				foreach ($sqlText['parameters'] as $property) {
					$map->addProperty($property);
				}
			}
			$sqlStatement = $sqlText['sql'];
		}
		$sqlStatement = preg_replace('/' . self::INLINE_PLACEHOLDER . '/', self::INLINE_SYMBOL, $sqlStatement);

		$this->prepareSql($statement, $sqlStatement, $node);
	}

	/**
	 * Prepare the sql text (may extend to dynamic sql).
	 * @param TSqlMapStatement $statement mapped statement.
	 * @param string $sqlStatement sql text.
	 * @param \SimpleXmlElement $node statement node.
	 * @todo Extend to dynamic sql.
	 */
	protected function prepareSql($statement, $sqlStatement, $node)
	{
		$simpleDynamic = new TSimpleDynamicParser();
		$sqlStatement = preg_replace(self::ESCAPED_SIMPLE_MARK_REGEXP, self::SIMPLE_PLACEHOLDER, $sqlStatement);
		$dynamics = $simpleDynamic->parse($sqlStatement);
		if (count($dynamics['parameters']) > 0) {
			$sql = new TSimpleDynamicSql($dynamics['parameters']);
			$sqlStatement = $dynamics['sql'];
		} else {
			$sql = new TStaticSql();
		}
		$sqlStatement = preg_replace('/' . self::SIMPLE_PLACEHOLDER . '/', self::SIMPLE_MARK, $sqlStatement);
		$sql->buildPreparedStatement($statement, $sqlStatement);
		$statement->setSqlText($sql);
	}

	/**
	 * Load select statement from xml mapping.
	 * @param \SimpleXmlElement $node select node.
	 */
	protected function loadSelectTag($node)
	{
		$select = new TSqlMapSelect();
		$this->setObjectPropFromNode($select, $node);
		$this->processSqlStatement($select, $node);
		$mappedStatement = new TMappedStatement($this->_manager, $select);
		$cacheModel = $select->getCacheModel();
		if ($cacheModel !== null && strlen($cacheModel) > 0) {
			$mappedStatement = new TCachingStatement($mappedStatement);
		}

		$this->_manager->addMappedStatement($mappedStatement);
	}

	/**
	 * Load insert statement from xml mapping.
	 * @param \SimpleXmlElement $node insert node.
	 */
	protected function loadInsertTag($node)
	{
		$insert = $this->createInsertStatement($node);
		$this->processSqlStatement($insert, $node);
		$mappedStatement = new TInsertMappedStatement($this->_manager, $insert);
		$this->_manager->addMappedStatement($mappedStatement);
	}

	/**
	 * Create new insert statement from xml node.
	 * @param \SimpleXmlElement $node insert node.
	 * @return TSqlMapInsert insert statement.
	 */
	protected function createInsertStatement($node)
	{
		$insert = new TSqlMapInsert();
		$this->setObjectPropFromNode($insert, $node);
		if (isset($node->selectKey)) {
			$this->loadSelectKeyTag($insert, $node->selectKey);
		}
		return $insert;
	}

	/**
	 * Load the selectKey statement from xml mapping.
	 * @param mixed $insert
	 * @param \SimpleXmlElement $node selectkey node
	 */
	protected function loadSelectKeyTag($insert, $node)
	{
		$selectKey = new TSqlMapSelectKey();
		$this->setObjectPropFromNode($selectKey, $node);
		$selectKey->setID($insert->getID());
		$selectKey->setID($insert->getID() . '.SelectKey');
		$this->processSqlStatement($selectKey, $node);
		$insert->setSelectKey($selectKey);
		$mappedStatement = new TMappedStatement($this->_manager, $selectKey);
		$this->_manager->addMappedStatement($mappedStatement);
	}

	/**
	 * Load update statement from xml mapping.
	 * @param \SimpleXmlElement $node update node.
	 */
	protected function loadUpdateTag($node)
	{
		$update = new TSqlMapUpdate();
		$this->setObjectPropFromNode($update, $node);
		$this->processSqlStatement($update, $node);
		$mappedStatement = new TUpdateMappedStatement($this->_manager, $update);
		$this->_manager->addMappedStatement($mappedStatement);
	}

	/**
	 * Load delete statement from xml mapping.
	 * @param \SimpleXmlElement $node delete node.
	 */
	protected function loadDeleteTag($node)
	{
		$delete = new TSqlMapDelete();
		$this->setObjectPropFromNode($delete, $node);
		$this->processSqlStatement($delete, $node);
		$mappedStatement = new TDeleteMappedStatement($this->_manager, $delete);
		$this->_manager->addMappedStatement($mappedStatement);
	}

	/**
	 * Load procedure statement from xml mapping.
	 * @todo Implement loading procedure
	 * @param \SimpleXmlElement $node procedure node
	 */
	protected function loadProcedureTag($node)
	{
		//var_dump('todo: add load procedure');
	}

	/**
	 * Load cache models from xml mapping.
	 * @param \SimpleXmlElement $node cache node.
	 */
	protected function loadCacheModel($node)
	{
		$cacheModel = new TSqlMapCacheModel();
		$properties = ['id', 'implementation'];
		foreach ($node->attributes() as $name => $value) {
			if (in_array(strtolower($name), $properties)) {
				$cacheModel->{'set' . $name}((string) $value);
			}
		}
		$cache = Prado::createComponent($cacheModel->getImplementationClass(), $cacheModel);
		$this->setObjectPropFromNode($cache, $node, $properties);

		foreach ($node->xpath('property') as $propertyNode) {
			$name = $propertyNode->attributes()->name;
			if ($name === null || $name === '') {
				continue;
			}

			$value = $propertyNode->attributes()->value;
			if ($value === null || $value === '') {
				continue;
			}

			if (!TPropertyAccess::has($cache, $name)) {
				continue;
			}

			TPropertyAccess::set($cache, $name, $value);
		}

		$this->loadFlushInterval($cacheModel, $node);

		$cacheModel->initialize($cache);
		$this->_manager->addCacheModel($cacheModel);
		foreach ($node->xpath('flushOnExecute') as $flush) {
			$this->loadFlushOnCache($cacheModel, $node, $flush);
		}
	}

	/**
	 * Load the flush interval
	 * @param TSqlMapCacheModel $cacheModel cache model
	 * @param \SimpleXmlElement $node cache node
	 */
	protected function loadFlushInterval($cacheModel, $node)
	{
		$flushInterval = $node->xpath('flushInterval');
		if ($flushInterval === null || count($flushInterval) === 0) {
			return;
		}
		$duration = 0;
		foreach ($flushInterval[0]->attributes() as $name => $value) {
			switch (strToLower($name)) {
				case 'seconds':
					$duration += (int) $value;
					break;
				case 'minutes':
					$duration += 60 * (int) $value;
					break;
				case 'hours':
					$duration += 3600 * (int) $value;
					break;
				case 'days':
					$duration += 86400 * (int) $value;
					break;
				case 'duration':
					$duration = (int) $value;
					break 2; // switch, foreach
			}
		}
		$cacheModel->setFlushInterval($duration);
	}

	/**
	 * Load the flush on cache properties.
	 * @param TSqlMapCacheModel $cacheModel cache model
	 * @param \SimpleXmlElement $parent parent node.
	 * @param \SimpleXmlElement $node flush node.
	 */
	protected function loadFlushOnCache($cacheModel, $parent, $node)
	{
		$id = $cacheModel->getID();
		if (!isset($this->_FlushOnExecuteStatements[$id])) {
			$this->_FlushOnExecuteStatements[$id] = [];
		}
		foreach ($node->attributes() as $name => $value) {
			if (strtolower($name) === 'statement') {
				$this->_FlushOnExecuteStatements[$id][] = (string) $value;
			}
		}
	}

	/**
	 * Attach CacheModel to statement and register trigger statements for cache models
	 */
	protected function registerCacheTriggers()
	{
		foreach ($this->_FlushOnExecuteStatements as $cacheID => $statementIDs) {
			$cacheModel = $this->_manager->getCacheModel($cacheID);
			foreach ($statementIDs as $statementID) {
				$statement = $this->_manager->getMappedStatement($statementID);
				$cacheModel->registerTriggerStatement($statement);
			}
		}
	}
}