Slug::enableForceEditUpdate() - Code Metrics - Inspection of "- Added support for disabling field change" - ipublikuj-ui/form-slug - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c61447...e134cf )

by Adam

created 2018-01-14 17:58 UTC

Slug::enableForceEditUpdate() A

↳ Parent: Slug

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	0
cts	2
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0
crap	2

<?php
/**
 * Slug.php
 *
 * @copyright      More in license.md
 * @license        http://www.ipublikuj.eu
 * @author         Adam Kadlec http://www.ipublikuj.eu
 * @package        iPublikuj:FormSlug!
 * @subpackage     Controls
 * @since          1.0.0
 *
 * @date           08.01.15
 */

declare(strict_types = 1);

namespace IPub\FormSlug\Controls;

use Nette;
use Nette\Application\UI;
use Nette\Bridges;
use Nette\Forms;
use Nette\Utils;

use IPub;
use IPub\FormSlug;
use IPub\FormSlug\Exceptions;

/**
 * Form slug control element
 *
 * @package        iPublikuj:FormSlug!
 * @subpackage     Controls
 *
 * @author         Adam Kadlec <[email protected]>
 */
class Slug extends Forms\Controls\TextInput
{
	/**
	 * @var string|NULL
	 */
	private $templateFile;

	/**
	 * @var UI\ITemplate
	 */
	private $template;

	/**
	 * @var UI\ITemplateFactory
	 */
	private $templateFactory;

	/**
	 * @var Forms\Controls\BaseControl[]
	 */
	private $fields = [];

	/**
	 * Toggle box selector
	 *
	 * @var string
	 */
	private $toggleBox = '.ipub-slug-box';

	/**
	 * @var bool
	 */
	private static $registered = FALSE;

	/**
	 * Enable or disable one time auto updating slug field from watched fields
	 *
	 * @var bool
	 */
	private $onetimeAutoUpdate = TRUE;

	/**
	 * Enable or disable updating field when editing watched field
	 *
	 * @var bool
	 */
	private $forceEditUpdate = FALSE;

	/**
	 * @param UI\ITemplateFactory $templateFactory
	 * @param string|NULL $label
	 * @param int|NULL $maxLength
	 */
	public function __construct(UI\ITemplateFactory $templateFactory, string $label = NULL, int $maxLength = NULL)
	{
		parent::__construct($label, $maxLength);

		$this->templateFactory = $templateFactory;
	}

	/**
	 * Add filed from which slug will be created
	 *
	 * @param Forms\Controls\BaseControl $field
	 *
	 * @return self
	 */
	public function addField(Forms\Controls\BaseControl $field) : self
	{
		// Assign filed to collection
		$this->fields[$field->getHtmlId()] = $field;

		return $this;
	}

	/**
	 * @return self
	 */
	public function disableOneTimeUpdate() : self
	{
		$this->onetimeAutoUpdate = FALSE;

		return $this;
	}

	/**
	 * @return self
	 */
	public function enableOneTimeUpdate() : self
	{
		$this->onetimeAutoUpdate = TRUE;

		return $this;
	}

	/**
	 * @return self
	 */
	public function disableForceEditUpdate() : self
	{
		$this->forceEditUpdate = FALSE;

		return $this;
	}

	/**
	 * @return self
	 */
	public function enableForceEditUpdate() : self
	{
		$this->forceEditUpdate = TRUE;

		return $this;
	}

	/**
	 * Generates control's HTML element
	 *
	 * @return Utils\Html
	 */
	public function getControl() : Utils\Html
	{
		// Create form input
		$input = parent::getControl();

		$template = $this->getTemplate();

		// If template file was not defined before...
		if ($template->getFile() === NULL) {
			// ...try to get base control template file
			$templateFile = $this->getTemplateFile();

			// ...& set it to template engine
			$template->setFile($templateFile);
		}

		// Assign vars to template
		$template->input = $input;
		$template->value = $this->getValue();
		$template->caption = $this->caption;
		$template->_form = $this->getForm();

		// Component js settings
		$template->settings = [
			'toggle'    => $this->toggleBox,
			'onetime'   => $this->onetimeAutoUpdate,
			'forceEdit' => $this->forceEditUpdate,
			'fields'    => (array_reduce($this->fields, function (array $result, Forms\Controls\BaseControl $row) {
				$result[] = '#' . $row->getHtmlId();

				return $result;
			}, [])),
		];

		return Utils\Html::el()
			->addHtml((string) $template);
	}

	/**
	 * Change default control template path
	 *
	 * @param string $templateFile
	 *
	 * @return void
	 *
	 * @throws Exceptions\FileNotFoundException
	 */
	public function setTemplateFile(string $templateFile) : void
	{
		// Check if template file exists...
		if (!is_file($templateFile)) {
			// ...check if extension template is used
			if (is_file(__DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile)) {
				$templateFile = __DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile;

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

		$this->templateFile = $templateFile;
	}

	/**
	 * @return string
	 */
	private function getTemplateFile() : string
	{
		return $this->templateFile !== NULL ? $this->templateFile : __DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . 'default.latte';
	}

	/**
	 * @return UI\ITemplate|Bridges\ApplicationLatte\Template
	 */
	private function getTemplate() : UI\ITemplate
	{
		if ($this->template === NULL) {
			$this->template = $this->templateFactory->createTemplate();
			$this->template->setFile($this->getTemplateFile());
		}

		return $this->template;
	}

	/**
	 * @param UI\ITemplateFactory $templateFactory
	 * @param string $method
	 *
	 * @return void
	 */
	public static function register(UI\ITemplateFactory $templateFactory, $method = 'addSlug') : void
	{
		// Check for multiple registration
		if (static::$registered) {
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
			throw new Exceptions\InvalidStateException('Slug control already registered.');
		}

		static::$registered = TRUE;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

		$class = function_exists('get_called_class') ? get_called_class() : __CLASS__;

		Forms\Container::extensionMethod(
			$method, function (Forms\Container $form, $name, $label = NULL, $maxLength = NULL) use ($class, $templateFactory) : Slug {
			$component = new $class($templateFactory, $label, $maxLength);

			$form->addComponent($component, $name);

			return $component;
		});
	}
}


1		<?php
2		/**
3		* Slug.php
4		*
5		* @copyright More in license.md
6		* @license http://www.ipublikuj.eu
7		* @author Adam Kadlec http://www.ipublikuj.eu
8		* @package iPublikuj:FormSlug!
9		* @subpackage Controls
10		* @since 1.0.0
11		*
12		* @date 08.01.15
13		*/
14
15		declare(strict_types = 1);
16
17		namespace IPub\FormSlug\Controls;
18
19		use Nette;
20		use Nette\Application\UI;
21		use Nette\Bridges;
22		use Nette\Forms;
23		use Nette\Utils;
24
25		use IPub;
26		use IPub\FormSlug;
27		use IPub\FormSlug\Exceptions;
28
29		/**
30		* Form slug control element
31		*
32		* @package iPublikuj:FormSlug!
33		* @subpackage Controls
34		*
35		* @author Adam Kadlec <[email protected]>
36		*/
37	1	class Slug extends Forms\Controls\TextInput
38		{
39		/**
40		* @var string\|NULL
41		*/
42		private $templateFile;
43
44		/**
45		* @var UI\ITemplate
46		*/
47		private $template;
48
49		/**
50		* @var UI\ITemplateFactory
51		*/
52		private $templateFactory;
53
54		/**
55		* @var Forms\Controls\BaseControl[]
56		*/
57		private $fields = [];
58
59		/**
60		* Toggle box selector
61		*
62		* @var string
63		*/
64		private $toggleBox = '.ipub-slug-box';
65
66		/**
67		* @var bool
68		*/
69		private static $registered = FALSE;
70
71		/**
72		* Enable or disable one time auto updating slug field from watched fields
73		*
74		* @var bool
75		*/
76		private $onetimeAutoUpdate = TRUE;
77
78		/**
79		* Enable or disable updating field when editing watched field
80		*
81		* @var bool
82		*/
83		private $forceEditUpdate = FALSE;
84
85		/**
86		* @param UI\ITemplateFactory $templateFactory
87		* @param string\|NULL $label
88		* @param int\|NULL $maxLength
89		*/
90		public function __construct(UI\ITemplateFactory $templateFactory, string $label = NULL, int $maxLength = NULL)
91		{
92	1	parent::__construct($label, $maxLength);
93
94	1	$this->templateFactory = $templateFactory;
95	1	}
96
97		/**
98		* Add filed from which slug will be created
99		*
100		* @param Forms\Controls\BaseControl $field
101		*
102		* @return self
103		*/
104		public function addField(Forms\Controls\BaseControl $field) : self
105		{
106		// Assign filed to collection
107		$this->fields[$field->getHtmlId()] = $field;
108
109		return $this;
110		}
111
112		/**
113		* @return self
114		*/
115		public function disableOneTimeUpdate() : self
116		{
117		$this->onetimeAutoUpdate = FALSE;
118
119		return $this;
120		}
121
122		/**
123		* @return self
124		*/
125		public function enableOneTimeUpdate() : self
126		{
127		$this->onetimeAutoUpdate = TRUE;
128
129		return $this;
130		}
131
132		/**
133		* @return self
134		*/
135		public function disableForceEditUpdate() : self
136		{
137		$this->forceEditUpdate = FALSE;
138
139		return $this;
140		}
141
142		/**
143		* @return self
144		*/
145		public function enableForceEditUpdate() : self
146		{
147		$this->forceEditUpdate = TRUE;
148
149		return $this;
150		}
151
152		/**
153		* Generates control's HTML element
154		*
155		* @return Utils\Html
156		*/
157		public function getControl() : Utils\Html
158		{
159		// Create form input
160	1	$input = parent::getControl();
161
162	1	$template = $this->getTemplate();
163
164		// If template file was not defined before...
165	1	if ($template->getFile() === NULL) {
166		// ...try to get base control template file
167		$templateFile = $this->getTemplateFile();
168
169		// ...& set it to template engine
170		$template->setFile($templateFile);
171		}
172
173		// Assign vars to template
174	1	$template->input = $input;
175	1	$template->value = $this->getValue();
176	1	$template->caption = $this->caption;
177	1	$template->_form = $this->getForm();
178
179		// Component js settings
180	1	$template->settings = [
181	1	'toggle' => $this->toggleBox,
182	1	'onetime' => $this->onetimeAutoUpdate,
183	1	'forceEdit' => $this->forceEditUpdate,
184	1	'fields' => (array_reduce($this->fields, function (array $result, Forms\Controls\BaseControl $row) {
185		$result[] = '#' . $row->getHtmlId();
186
187		return $result;
188	1	}, [])),
189		];
190
191	1	return Utils\Html::el()
192	1	->addHtml((string) $template);
193		}
194
195		/**
196		* Change default control template path
197		*
198		* @param string $templateFile
199		*
200		* @return void
201		*
202		* @throws Exceptions\FileNotFoundException
203		*/
204		public function setTemplateFile(string $templateFile) : void
205		{
206		// Check if template file exists...
207		if (!is_file($templateFile)) {
208		// ...check if extension template is used
209		if (is_file(__DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile)) {
210		$templateFile = __DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . $templateFile;
211
212		} else {
213		// ...if not throw exception
214		throw new Exceptions\FileNotFoundException(sprintf('Template file "%s" was not found.', $templateFile));
215		}
216		}
217
218		$this->templateFile = $templateFile;
219		}
220
221		/**
222		* @return string
223		*/
224		private function getTemplateFile() : string
225		{
226	1	return $this->templateFile !== NULL ? $this->templateFile : __DIR__ . DIRECTORY_SEPARATOR . 'template' . DIRECTORY_SEPARATOR . 'default.latte';
227		}
228
229		/**
230		* @return UI\ITemplate\|Bridges\ApplicationLatte\Template
231		*/
232		private function getTemplate() : UI\ITemplate
233		{
234	1	if ($this->template === NULL) {
235	1	$this->template = $this->templateFactory->createTemplate();
236	1	$this->template->setFile($this->getTemplateFile());
237		}
238
239	1	return $this->template;
240		}
241
242		/**
243		* @param UI\ITemplateFactory $templateFactory
244		* @param string $method
245		*
246		* @return void
247		*/
248		public static function register(UI\ITemplateFactory $templateFactory, $method = 'addSlug') : void
249		{
250		// Check for multiple registration
251	1	if (static::$registered) {
		0 ignored issues – show Bug introduced 2017-01-02 21:21 UTC by Report Bug Copy Issue Report Since `$registered` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$registered` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
252	1	throw new Exceptions\InvalidStateException('Slug control already registered.');
253		}
254
255	1	static::$registered = TRUE;
		0 ignored issues – show Bug introduced 2017-01-02 21:21 UTC by Report Bug Copy Issue Report Since `$registered` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$registered` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
256
257	1	$class = function_exists('get_called_class') ? get_called_class() : __CLASS__;
258
259	1	Forms\Container::extensionMethod(
260	1	$method, function (Forms\Container $form, $name, $label = NULL, $maxLength = NULL) use ($class, $templateFactory) : Slug {
261	1	$component = new $class($templateFactory, $label, $maxLength);
262
263	1	$form->addComponent($component, $name);
264
265	1	return $component;
266	1	});
267	1	}
268		}
269

ipublikuj-ui / form-slug

Push — master ( c61447...e134cf )

Slug::enableForceEditUpdate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like