vsc\application\sitemaps\ControllerMapTrait

Complexity

Total Complexity

25

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

80%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	getModuleMap()	0	1	?
A	setMainTemplate()	0	3	1
A	getViewPath()	0	3	1
A	setMainTemplatePath()	0	12	3
B	getMainTemplatePath()	0	17	5
A	getMainTemplate()	0	13	4
A	setView()	0	10	3
B	getView()	0	19	8

<?php
namespace vsc\application\sitemaps;

use vsc\ExceptionPath;
use vsc\presentation\views\ViewA;

trait ControllerMapTrait {
	private $sMainTemplatePath;
	private $sMainTemplate;

	private $sViewPath;
	private $oView;

	/**
	 * @return ModuleMap
	 */
	abstract public function getModuleMap();

	/**
	 * @param string $sPath
	 * @return bool
	 * @throws \vsc\ExceptionPath
	 */
	public function setMainTemplatePath($sPath) {
		$sMainTemplatePath = realpath($sPath);
		if (!is_dir($sMainTemplatePath)) {
			$sMainTemplatePath = realpath($this->getModuleMap()->getModulePath() . DIRECTORY_SEPARATOR . $sPath);
		}
		if (!is_dir($sMainTemplatePath)) {
			throw new ExceptionPath(sprintf('Path [%s] does not exist', $sPath));
		}
		$this->sMainTemplatePath = $sMainTemplatePath;

		return true;
	}

	/**
	 * @return string
	 */
	public function getMainTemplatePath() {
		// if we didn't provide the controller with a main template path we check the module
		if (is_null($this->sMainTemplatePath)) {
			if ($this->getModuleMap() instanceof ContentTypeMappingInterface) {
				$this->sMainTemplatePath = $this->getModuleMap()->getMainTemplatePath();
			}
		}

		if (is_null($this->sMainTemplatePath)) {
			// back-up
			$this->sMainTemplatePath = VSC_RES_PATH . 'templates';
		}
		if (substr($this->sMainTemplatePath, -1) != DIRECTORY_SEPARATOR) {
			$this->sMainTemplatePath .= DIRECTORY_SEPARATOR;
		}
		return $this->sMainTemplatePath;
	}

	/**
	 * @param string $sPath
	 */
	public function setMainTemplate($sPath) {
		$this->sMainTemplate = $sPath;
	}

	/**
	 * @return string
	 */
	public function getMainTemplate() {
		// if we didn't provide the controller with a main template path we check the module
		if (is_null($this->sMainTemplate)) {
			if ($this->getModuleMap() instanceof ContentTypeMappingInterface) {
				$this->sMainTemplate = $this->getModuleMap()->getMainTemplate();
			}
		}
		if (is_null($this->sMainTemplate)) {
			// back-up
			$this->sMainTemplate = 'main.php';
		}
		return $this->sMainTemplate;
	}

	/**
	 *
	 * To allow a single controller type to return a different type of view
	 * @param string|object $mView
	 * @throws ExceptionPath
	 */
	public function setView($mView) {
		if (ViewA::isValid($mView)) {
			$this->oView = $mView;

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

			$this->sViewPath = get_class($mView);
		} elseif (ClassMap::isValidMap($mView)) {

It seems like $mView defined by parameter $mView on line 88 can also be of type object; however, vsc\application\sitemaps\ClassMap::isValidMap() does only seem to accept string, maybe add an additional type check?

			$this->sViewPath = $mView;
		} else {
			throw new ExceptionPath('View path [' . $mView . '] is not valid.');
		}
	}

	public function getViewPath() {

The return type could not be reliably inferred; please add a @return annotation.

		return $this->sViewPath;
	}

	public function getView() {

The return type could not be reliably inferred; please add a @return annotation.

		if (!ViewA::isValid($this->oView) && !is_null($this->sViewPath)) {
			if (stristr(basename($this->sViewPath), '.') === false && !is_file($this->sViewPath)) {
				$sClassName = $this->sViewPath;
			} elseif (is_file($this->sViewPath)) {
				$sViewPath = $this->getViewPath();
				try {
					include ($sViewPath);
				} catch (\Exception $e) {
					\vsc\_e($e);
				}
				$sClassName = SiteMapA::getClassName($sViewPath);
			}
		}
		if (!empty($sClassName)) {
			$this->oView = new $sClassName();
		}
		return $this->oView;
	}
}