IPub\ConfirmationDialog\Components\Control

Complexity

Total Complexity

36

Size/Duplication

Total Lines	298
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	9

Test Coverage

Coverage

72.15%

Importance

Changes	20
Bugs	2	Features	5

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfirmer()	0	8	4
A	injectFactories()	0	5	1
A	__construct()	0	16	3
A	setLayoutFile()	0	6	1
A	setTemplateFile()	0	6	1
A	getTemplateFile()	0	5	2
A	formatSignalMethod()	0	8	2
B	addConfirmer()	0	22	5
A	resetConfirmer()	0	9	1
A	createComponentConfirmer()	0	23	3
A	showConfirm()	0	13	4
A	handleShowConfirmer()	0	20	3
A	enableAjax()	0	6	1
A	disableAjax()	0	6	1
B	render()	0	24	4

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

namespace IPub\ConfirmationDialog\Components;

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

use IPub;
use IPub\ConfirmationDialog\Exceptions;

/**
 * Confirmation dialog control
 *
 * @package		iPublikuj:ConfirmationDialog!
 * @subpackage	Components
 */
class Control extends BaseControl
{
	const CLASSNAME = __CLASS__;

	/**
	 * @var IConfirmer
	 */
	protected $confirmerFactory;

	/**
	 * @var Confirmer
	 */
	protected $confirmer;

	/**
	 * @var bool
	 */
	protected $useAjax = TRUE;

	/**
	 * @param IConfirmer $confirmerFactory
	 */
	public function injectFactories(IConfirmer $confirmerFactory)
	{
		// Get confirmer component factory
		$this->confirmerFactory = $confirmerFactory;
	}

	/**
	 * @param NULL|string $layoutFile
	 * @param NULL|string $templateFile
	 * @param Nette\ComponentModel\IContainer $parent
	 * @param null $name
	 */
	public function __construct(
		$layoutFile = NULL,
		$templateFile = NULL,
		Nette\ComponentModel\IContainer $parent = NULL, $name = NULL

The parameter $parent is not used and could be removed.

The parameter $name is not used and could be removed.

	) {
		// TODO: remove, only for tests
		parent::__construct(NULL, NULL);

		if ($layoutFile !== NULL) {
			$this->setLayoutFile($layoutFile);
		}

		if ($templateFile !== NULL) {
			$this->setTemplateFile($templateFile);
		}
	}

	/**
	 * Change default dialog layout path
	 *
	 * @param string $layoutFile
	 *
	 * @return $this
	 */
	public function setLayoutFile($layoutFile)
	{
		$this->setTemplateFilePath($layoutFile, self::TEMPLATE_LAYOUT);

		return $this;
	}

	/**
	 * Change default confirmer template path
	 *
	 * @param string $layoutFile
	 *
	 * @return $this
	 */
	public function setTemplateFile($layoutFile)
	{
		$this->setTemplateFilePath($layoutFile, self::TEMPLATE_CONFIRMER);

		return $this;
	}

	/**
	 * @return string
	 */
	public function getTemplateFile()
	{
		// ...try to get default component layout file
		return !empty($this->templateFile) ? $this->templateFile : __DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR .'default.latte';
	}

	/**
	 * Overrides signal method formatter
	 * This provide "dynamically named signals"
	 *
	 * @param string $signal
	 *
	 * @return string
	 */
	public static function formatSignalMethod($signal)
	{
		if (Utils\Strings::startsWith($signal, 'confirm')) {
			return 'handleShowConfirmer';
		}

		return parent::formatSignalMethod($signal);
	}

	/**
	 * Add confirmation handler to "dynamicaly named signals"
	 *
	 * @param string $name Confirmation/signal name
	 * @param callback|Nette\Callback $handler Callback called when confirmation succeed
	 * @param callback|string $question Callback ($confirmer, $params) or string containing question text
	 * @param callback|string $heading Callback ($confirmer, $params) or string containing heading text
	 *
	 * @return $this
	 *
	 * @throws Exceptions\InvalidArgumentException
	 */
	public function addConfirmer($name, $handler, $question, $heading)
	{
		// Confirmer name could be only A-z
		if (!preg_match('/[A-Za-z_]+/', $name)) {
			throw new Exceptions\InvalidArgumentException("Confirmation control name contain invalid characters.");

		// Check confirmer
		} else if ((!$confirmer = $this->getComponent('confirmer-'. $name)) || !$confirmer instanceof Confirmer || $confirmer->isConfigured()) {
			throw new Exceptions\InvalidArgumentException("Confirmation control '$name' could not be created.");

		} else {
			$confirmer
				// Set confirmer handler
				->setHandler($handler)
				// Set confirmer heading
				->setHeading($heading)
				// Set confirmer question
				->setQuestion($question);
		}

		return $this;
	}

	/**
	 * @param string $name
	 *
	 * @return Confirmer
	 *
	 * @throws Exceptions\InvalidArgumentException
	 */
	public function getConfirmer($name)
	{
		if ((!$confirmer = $this->getComponent('confirmer-'. $name)) || !$confirmer instanceof Confirmer || !$confirmer->isConfigured()) {
			throw new Exceptions\InvalidArgumentException("Confirmation control '$name' does not exists.");
		}

		return $confirmer;
	}

	/**
	 * @return $this
	 */
	public function resetConfirmer()
	{
		$this->confirmer = NULL;

		// Invalidate dialog snippets
		$this->redrawControl();

		return $this;
	}

	/**
	 * @return Application\UI\Multiplier
	 *
	 * @throws Exceptions\InvalidArgumentException
	 */
	protected function createComponentConfirmer()
	{
		$that = $this;

		return new Application\UI\Multiplier((function() use ($that) {
			// Check if confirmer factory is available
			if ($that->confirmerFactory) {
				$confirmer = $that->confirmerFactory->create($that->templateFile);

			} else {
				throw new Exceptions\InvalidStateException("Confirmation control factory does not exist.");
			}

			if ($that->useAjax) {
				$confirmer->enableAjax();

			} else {
				$confirmer->disableAjax();
			}

			return $confirmer;
		}));
	}

	/**
	 * Show dialog for confirmation
	 *
	 * @param string $name
	 * @param array $params
	 *
	 * @throws Exceptions\InvalidArgumentException
	 * @throws Exceptions\InvalidStateException
	 */
	public function showConfirm($name, array $params = [])
	{
		if (!is_string($name)) {
			throw new Exceptions\InvalidArgumentException('$name must be string.');
		}

		if ((!$this->confirmer = $this['confirmer-'. $name]) || !$this->confirmer->isConfigured()) {
			throw new Exceptions\InvalidStateException("Confirmer '$name' do not exist.");
		}

		// Prepare confirmer for displaying
		$this->confirmer->showConfirm($params);
	}

	/**
	 * Dynamically named signal receiver
	 *
	 * @throws Exceptions\InvalidArgumentException
	 * @throws Exceptions\InvalidStateException
	 */
	public function handleShowConfirmer()
	{
		if ($this->getPresenter() instanceof Application\UI\Presenter) {
			list(, $signal) = $this->getPresenter()->getSignal();

		} else {
			throw new Exceptions\InvalidArgumentException('Confirmer is not attached to presenter.');
		}

		$name = Utils\Strings::substring($signal, 7);
		$name{0} = strtolower($name{0});

		if (!$this['confirmer-'. $name]->isConfigured()) {
			throw new Exceptions\InvalidArgumentException('Invalid confirmation control.');
		}

		$params = $this->getParameters();

		$this->showConfirm($name, $params);
	}

	/**
	 * @return $this
	 */
	public function enableAjax()
	{
		$this->useAjax = TRUE;

		return $this;
	}

	/**
	 * @return $this
	 */
	public function disableAjax()
	{
		$this->useAjax = FALSE;

		return $this;
	}

	/**
	 * Render control
	 *
	 * @throws Exceptions\InvalidStateException
	 */
	public function render()
	{
		// Create template
		$template = parent::render();

		// Check if control has template
		if ($template instanceof Nette\Bridges\ApplicationLatte\Template) {
			// Assign vars to template
			$template->confirmer = $this->confirmer;

			// If template was not defined before...
			if ($template->getFile() === NULL) {
				// ...try to get base component template file
				$layoutFile = !empty($this->layoutFile) ? $this->layoutFile : __DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . 'layout.latte';
				$template->setFile($layoutFile);
			}

			// Render component template
			$template->render();

		} else {
			throw new Exceptions\InvalidStateException('Dialog control is without template.');
		}
	}
}