Prado\Data\SqlMap\Configuration\TSqlMapXmlConfiguration

Complexity

Total Complexity

25

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Test Coverage

Coverage

48.53%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	replaceProperties()	0	6	2
A	getConfigFile()	0	3	1
A	loadTypeHandler()	0	4	1
A	attachCacheModels()	0	6	3
A	loadGlobalProperty()	0	3	1
A	resolveResultMapping()	0	21	6
A	getManager()	0	3	1
A	__construct()	0	3	1
A	configure()	0	27	5
A	loadDatabaseConnection()	0	4	1
A	loadSqlMappingFiles()	0	10	3

<?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
 * @package Prado\Data\SqlMap\Configuration
 */

namespace Prado\Data\SqlMap\Configuration;

use Prado\Data\SqlMap\DataMapper\TSqlMapConfigurationException;

/**
 * TSqlMapXmlConfig class.
 *
 * Configures the TSqlMapManager using xml configuration file.
 *
 * @author Wei Zhuo <weizho[at]gmail[dot]com>
 * @package Prado\Data\SqlMap\Configuration
 * @since 3.1
 */
class TSqlMapXmlConfiguration extends TSqlMapXmlConfigBuilder
{
	/**
	 * @var TSqlMapManager manager

The type Prado\Data\SqlMap\Configuration\TSqlMapManager was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	private $_manager;
	/**
	 * @var string configuration file.
	 */
	private $_configFile;
	/**
	 * @var array global properties.
	 */
	private $_properties = [];

	/**
	 * @param TSqlMapManager $manager 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 $filename 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 $node property node.

The type Prado\Data\SqlMap\Configuration\SimpleXmlElement was not found. Did you mean SimpleXmlElement? If so, make sure to prefix the type with \.

	 */
	protected function loadGlobalProperty($node)
	{
		$this->_properties[(string) $node['name']] = (string) $node['value'];
	}

	/**
	 * Load the type handler configurations.
	 * @param SimpleXmlElement $node type handler node
	 */
	protected function loadTypeHandler($node)
	{
		$handler = $this->createObjectFromNode($node);
		$this->_manager->getTypeHandlers()->registerTypeHandler($handler);
	}

	/**
	 * Load the database connection tag.
	 * @param SimpleXmlElement $node connection node.
	 */
	protected function loadDatabaseConnection($node)
	{
		$conn = $this->createObjectFromNode($node);
		$this->_manager->setDbConnection($conn);
	}

	/**
	 * Load SqlMap mapping configuration.
	 * @param unknown_type $node

The type Prado\Data\SqlMap\Configuration\unknown_type was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	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 $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;
	}
}