library\components\BaseComponent

Complexity

Total Complexity

14

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	9
Bugs	2	Features	4

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	run()	0	4	1
A	render()	0	4	1
A	get()	0	4	1
B	renderTemplate()	0	23	6
A	includeTemplate()	0	9	3
A	getParameters()	0	4	1

<?php
namespace library\components
{

	use library\cc\Application;
	use library\cc\Request;
	use library\storage\Storage;

	class BaseComponent implements Component
	{
		/**
		 * @var string
		 */
		protected $template;
		/**
		 * @var Request
		 */
		protected $request;
		/**
		 * @var Storage
		 */
		protected $storage;
		/**
		 * @var mixed
		 */
		protected $renderedContent;
		/**
		 * @var array
		 */
		protected $parameters = array();
		/***
		 * @var \stdClass
		 */
		protected $matchedSitemapItem;

		/**
		 * BaseComponent constructor.
		 *
		 * @param string  $template
		 * @param Request $request
		 * @param array   $parameters
		 * @param         $matchedSitemapItem
		 */
		public function __construct($template='', Request $request, $parameters=array(), $matchedSitemapItem)
		{
			$this->template = $template;
			$this->request = $request;
			$this->parameters = (array) $parameters;
			$this->matchedSitemapItem = $matchedSitemapItem;
		}

		/**
		 * Hook for implementation in derived classes
		 *
		 * @param Storage $storage
		 * @return mixed|void
		 */
		public function run(Storage $storage)
		{
			$this->storage = $storage;
		}

		/**
		 * Renders the template
		 *
		 * @param null|Application $application
		 *
		 * @throws \Exception
		 */
		public function render($application=null)
		{
			$this->renderedContent = $this->renderTemplate($this->template, true, $application);
		}

		/**
		 * Returns the rendered content
		 *
		 * @return mixed
		 */
		public function get()
		{
			return $this->renderedContent;
		}

		/**
		 * Decoupled render method, for usage in derived classes
		 *
		 * @param string $template
		 *
		 * @param bool   $obClean
		 * @param null|Application   $application
		 *
		 * @return string
		 * @throws \Exception
		 */
		public function renderTemplate($template='', $obClean = true, $application=null)
		{
			$templatePath = __DIR__ . '/../../templates/' . $template . '.php';
			if (realpath($templatePath) !== false) {
				if ($obClean) {
					ob_clean();
				}
				$this->parameters['request'] = $this->request;
				if ($application !== null) {
					$acParameters = $application->getAllApplicationComponentParameters();
					foreach ($acParameters as $parameters) {
						extract($parameters);
					}
				}
				extract($this->parameters);
				include($templatePath);
				return ob_get_contents();
			} else {
				if ($template !== null) { // If template is null, its a application component, which doesnt have a template
					throw new \Exception('Couldnt find template ' . $templatePath);
				}
			}
		}

		/**
		 * Alias for renderTemplate for usage to include templates in other templates
		 *
		 * @param string $template
		 *
		 * @param array  $parameters
		 *
		 * @return string
		 * @throws \Exception
		 */
		public function includeTemplate($template='', $parameters = array())
		{
			if (is_array($parameters)) {
				foreach ($parameters as $name => $value) {
					$this->parameters[$name] = $value;
				}
			}
			return $this->renderTemplate($template, false);
		}

		public function getParameters()
		{
			return $this->parameters;
		}
	}
}