IPub\ConfirmationDialog\Components\BaseControl

Complexity

Total Complexity

15

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

76%

Importance

Changes	4
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	injectTranslator()	0	4	1
B	setTemplateFilePath()	0	22	5
A	setTranslator()	0	4	1
A	getTranslator()	0	8	2
A	render()	0	15	3
A	transformToTemplateFilePath()	0	16	3

<?php
/**
 * BaseControl.php
 *
 * @copyright      More in license.md
 * @license        http://www.ipublikuj.eu
 * @author         Adam Kadlec http://www.ipublikuj.eu
 * @package        iPublikuj:ConfirmationDialog!
 * @subpackage     Components
 * @since          1.0.0
 *
 * @date           12.03.14
 */

declare(strict_types = 1);

namespace IPub\ConfirmationDialog\Components;

use Nette;
use Nette\Application;
use Nette\Localization;

use IPub;
use IPub\ConfirmationDialog\Exceptions;

/**
 * Abstract control definition
 *
 * @package        iPublikuj:ConfirmationDialog!
 * @subpackage     Components
 *
 * @property Application\UI\ITemplate $template
 */
abstract class BaseControl extends Application\UI\Control
{
	const TEMPLATE_LAYOUT = 'layout';
	const TEMPLATE_CONFIRMER = 'template';

	/**
	 * @var string|NULL
	 */
	protected $templateFile = NULL;

	/**
	 * @var string|NULL
	 */
	protected $layoutFile = NULL;

	/**
	 * @var Localization\ITranslator
	 */
	protected $translator;

	/**
	 * @param Localization\ITranslator $translator
	 */
	public function injectTranslator(Localization\ITranslator $translator = NULL)
	{
		$this->translator = $translator;
	}

	/**
	 * Change default control template path
	 *
	 * @param string $templateFile
	 * @param string $type
	 *
	 * @return void
	 * 
	 * @throws Exceptions\FileNotFoundException
	 * @throws Exceptions\InvalidArgumentException
	 */
	public function setTemplateFilePath(string $templateFile, string $type)
	{
		if (!in_array($type, [self::TEMPLATE_CONFIRMER, self::TEMPLATE_LAYOUT])) {
			throw new Exceptions\InvalidArgumentException('Wrong template type');
		}

		// Check if template file exists...
		if (!is_file($templateFile)) {
			$templateFile = $this->transformToTemplateFilePath($templateFile);
		}

		switch ($type)
		{
			case self::TEMPLATE_LAYOUT:
				$this->layoutFile = $templateFile;
				break;

			case self::TEMPLATE_CONFIRMER:
				$this->templateFile = $templateFile;
				break;
		}
	}

	/**
	 * @param Localization\ITranslator $translator
	 * 
	 * @return void
	 */
	public function setTranslator(Localization\ITranslator $translator)
	{
		$this->translator = $translator;
	}

	/**
	 * @return Localization\ITranslator|NULL
	 */
	public function getTranslator()
	{
		if ($this->translator instanceof Localization\ITranslator) {
			return $this->translator;
		}

		return NULL;
	}

	/**
	 * Render control
	 *
	 * @return Application\UI\ITemplate
	 *
	 * @throws Exceptions\InvalidStateException
	 */
	public function render()
	{
		// Check if control has template
		if ($this->template instanceof Nette\Bridges\ApplicationLatte\Template) {
			// Check if translator is available
			if ($this->getTranslator() instanceof Localization\ITranslator) {
				$this->template->setTranslator($this->getTranslator());
			}

			// Render component template
			return $this->template;
		}

		throw new Exceptions\InvalidStateException('Control is without template.');
	}

	/**
	 * @param string $templateFile
	 *
	 * @return string
	 */
	private function transformToTemplateFilePath(string $templateFile) : string
	{
		// Get component actual dir
		$dir = dirname($this->getReflection()->getFileName());

		// ...check if extension template is used
		if (is_file($dir . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile)) {
			return $dir . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile;

		} elseif (is_file($dir . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile . '.latte')) {
			return $dir . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile . '.latte';
		}

		// ...if not throw exception
		throw new Exceptions\FileNotFoundException(sprintf('Template file "%s" was not found.', $templateFile));
	}
}