GroupActionCollection::addGroupTextareaAction() - Code Metrics - Inspection of "Added GroupTextarea action, group actions may have..." - ublaboo/datagrid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f463c7...38c89a )

by Pavel

created 2016-07-20 08:52 UTC

GroupActionCollection::addGroupTextareaAction() A

↳ Parent: GroupActionCollection

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/**
 * @copyright   Copyright (c) 2015 ublaboo <[email protected]>
 * @author      Pavel Janda <[email protected]>
 * @package     Ublaboo
 */

namespace Ublaboo\DataGrid\GroupAction;

use Nette;
use Nette\Application\UI\Form;
use Ublaboo\DataGrid\DataGrid;
use Ublaboo\DataGrid\Exception\DataGridGroupActionException;

class GroupActionCollection extends Nette\Object
{

	const ID_ATTRIBUTE_PREFIX = 'group_action_item_';

	/**
	 * @var GroupAction[]
	 */
	protected $group_actions = [];

	/**
	 * @var DataGrid
	 */
	protected $datagrid;


	public function __construct(DataGrid $datagrid)
	{
		$this->datagrid = $datagrid;
	}


	/**
	 * Get assambled form
	 * @param Nette\Forms\Container $container
	 * @return void
	 */
	public function addToFormContainer($container)
	{
		/** @var Nette\Application\UI\Form $form */
		$form = $container->lookup('Nette\Application\UI\Form');
		$translator = $form->getTranslator();
		$main_options = [];

		/**
		 * First foreach for filling "main" select
		 */
		foreach ($this->group_actions as $id => $action) {
			$main_options[$id] = $action->getTitle();
		}

		$container->addSelect('group_action', '', $main_options)
			->setPrompt('ublaboo_datagrid.choose');

		/**
		 * Second for creating select for each "sub"-action
		 */
		foreach ($this->group_actions as $id => $action) {
			$control = NULL;

			if ($action instanceof GroupSelectAction) {
				if ($action->hasOptions()) {
					$control = $container->addSelect($id, '', $action->getOptions());

					$control->setAttribute('id', static::ID_ATTRIBUTE_PREFIX . $id);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				}

			} else if ($action instanceof GroupTextAction) {
				$control = $container->addText($id, '');

				$control->setAttribute('id', static::ID_ATTRIBUTE_PREFIX . $id)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
					->addConditionOn($container['group_action'], Form::EQUAL, $id)
						->setRequired($translator->translate('ublaboo_datagrid.choose_input_required'))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
					->endCondition();

			} else if ($action instanceof GroupTextareaAction) {
				$control = $container->addTextarea($id, '');

				$control->setAttribute('id', static::ID_ATTRIBUTE_PREFIX . $id)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
					->addConditionOn($container['group_action'], Form::EQUAL, $id)
						->setRequired($translator->translate('ublaboo_datagrid.choose_input_required'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			}

			if ($control) {
				/**
				 * User may set a class to the form control
				 */
				if ($class = $action->getClass()) {
					$control->setAttribute('class', $class);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				}

				/**
				 * User may set additional attribtues to the form control
				 */
				foreach ($action->getAttributes() as $name => $value) {
					$control->setAttribute($name, $value);
				}
			}
		}

		foreach ($this->group_actions as $id => $action) {
			$container['group_action']->addCondition(Form::EQUAL, $id)
				->toggle(static::ID_ATTRIBUTE_PREFIX.$id);
		}

		$container['group_action']->addCondition(Form::FILLED)
			->toggle(strtolower($this->datagrid->getName()) . 'group_action_submit');

		$container->addSubmit('submit', 'ublaboo_datagrid.execute')
			->setAttribute('id', strtolower($this->datagrid->getName()) . 'group_action_submit');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		if ($form instanceof Nette\ComponentModel\IComponent) {
			$form->onSubmit[] = [$this, 'submitted'];
		}
	}


	/**
	 * Pass "sub"-form submission forward to custom submit function
	 * @param  Form   $form
	 * @return void
	 */
	public function submitted(Form $form)
	{
		if (!isset($form['group_action']['submit']) || !$form['group_action']['submit']->isSubmittedBy()) {
			return;
		}

		$values = $form->getValues();
		$values = $values['group_action'];

		if ($values->group_action === 0 || is_null($values->group_action)) {
			return;
		}

		/**
		 * @todo Define items IDs
		 */
		$http_ids = $form->getHttpData(Form::DATA_LINE|Form::DATA_KEYS, strtolower($this->datagrid->getName()) . '_group_action_item[]');
		$ids = array_keys($http_ids);

		$id = $values->group_action;
		$this->group_actions[$id]->onSelect($ids, isset($values->{$id}) ? $values->{$id} : NULL);

		$form['group_action']['group_action']->setValue(NULL);
	}


	/**
	 * Add one group action (select box) to collection of actions
	 *
	 * @param string $title
	 * @param array  $options
	 *
	 * @return GroupAction
	 */
	public function addGroupSelectAction($title, $options)
	{
		$id = ($s = sizeof($this->group_actions)) ? ($s + 1) : 1;

		return $this->group_actions[$id] = new GroupSelectAction($title, $options);
	}


	/**
	 * Add one group action (text input) to collection of actions
	 *
	 * @param string $title
	 *
	 * @return GroupAction
	 */
	public function addGroupTextAction($title)
	{
		$id = ($s = sizeof($this->group_actions)) ? ($s + 1) : 1;

		return $this->group_actions[$id] = new GroupTextAction($title);
	}


	/**
	 * Add one group action (textarea) to collection of actions
	 *
	 * @param string $title
	 *
	 * @return GroupAction
	 */
	public function addGroupTextareaAction($title)
	{
		$id = ($s = sizeof($this->group_actions)) ? ($s + 1) : 1;

		return $this->group_actions[$id] = new GroupTextareaAction($title);
	}


	/**
	 * @param  string $title
	 * @return GroupAction
	 */
	public function getGroupAction($title)
	{
		foreach ($this->group_actions as $action) {
			if ($action->getTitle() === $title) {
				return $action;
			}
		}

		throw new DataGridGroupActionException("Group action $title does not exist.");
	}

}


1			<?php
2
3			/**
4			* @copyright Copyright (c) 2015 ublaboo <[email protected]>
5			* @author Pavel Janda <[email protected]>
6			* @package Ublaboo
7			*/
8
9			namespace Ublaboo\DataGrid\GroupAction;
10
11			use Nette;
12			use Nette\Application\UI\Form;
13			use Ublaboo\DataGrid\DataGrid;
14			use Ublaboo\DataGrid\Exception\DataGridGroupActionException;
15
16			class GroupActionCollection extends Nette\Object
17			{
18
19			const ID_ATTRIBUTE_PREFIX = 'group_action_item_';
20
21			/**
22			* @var GroupAction[]
23			*/
24			protected $group_actions = [];
25
26			/**
27			* @var DataGrid
28			*/
29			protected $datagrid;
30
31
32			public function __construct(DataGrid $datagrid)
33			{
34			$this->datagrid = $datagrid;
35			}
36
37
38			/**
39			* Get assambled form
40			* @param Nette\Forms\Container $container
41			* @return void
42			*/
43			public function addToFormContainer($container)
44			{
45			/** @var Nette\Application\UI\Form $form */
46			$form = $container->lookup('Nette\Application\UI\Form');
47			$translator = $form->getTranslator();
48			$main_options = [];
49
50			/**
51			* First foreach for filling "main" select
52			*/
53			foreach ($this->group_actions as $id => $action) {
54			$main_options[$id] = $action->getTitle();
55			}
56
57			$container->addSelect('group_action', '', $main_options)
58			->setPrompt('ublaboo_datagrid.choose');
59
60			/**
61			* Second for creating select for each "sub"-action
62			*/
63			foreach ($this->group_actions as $id => $action) {
64			$control = NULL;
65
66			if ($action instanceof GroupSelectAction) {
67			if ($action->hasOptions()) {
68			$control = $container->addSelect($id, '', $action->getOptions());
69
70			$control->setAttribute('id', static::ID_ATTRIBUTE_PREFIX . $id);
			0 ignored issues – show Documentation introduced 2016-02-01 16:07 UTC by Report Bug Copy Issue Report `static::ID_ATTRIBUTE_PREFIX . $id` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
71			}
72
73			} else if ($action instanceof GroupTextAction) {
74			$control = $container->addText($id, '');
75
76			$control->setAttribute('id', static::ID_ATTRIBUTE_PREFIX . $id)
			0 ignored issues – show Documentation introduced 2016-07-20 08:54 UTC by Report Bug Copy Issue Report `static::ID_ATTRIBUTE_PREFIX . $id` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-07-20 08:54 UTC by Report Bug Copy Issue Report The call to the method `Nette\Forms\Rules::endCondition()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
77			->addConditionOn($container['group_action'], Form::EQUAL, $id)
78			->setRequired($translator->translate('ublaboo_datagrid.choose_input_required'))
			0 ignored issues – show Documentation introduced 2016-07-20 08:54 UTC by Report Bug Copy Issue Report `$translator->translate('...choose_input_required')` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
79			->endCondition();
80
81			} else if ($action instanceof GroupTextareaAction) {
82			$control = $container->addTextarea($id, '');
83
84			$control->setAttribute('id', static::ID_ATTRIBUTE_PREFIX . $id)
			0 ignored issues – show Documentation introduced 2016-07-20 08:54 UTC by Report Bug Copy Issue Report `static::ID_ATTRIBUTE_PREFIX . $id` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
85			->addConditionOn($container['group_action'], Form::EQUAL, $id)
86			->setRequired($translator->translate('ublaboo_datagrid.choose_input_required'));
			0 ignored issues – show Documentation introduced 2016-03-24 17:35 UTC by Report Bug Copy Issue Report `$translator->translate('...choose_input_required')` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
87			}
88
89			if ($control) {
90			/**
91			* User may set a class to the form control
92			*/
93			if ($class = $action->getClass()) {
94			$control->setAttribute('class', $class);
			0 ignored issues – show Documentation introduced 2016-07-20 08:54 UTC by Report Bug Copy Issue Report `$class` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
95			}
96
97			/**
98			* User may set additional attribtues to the form control
99			*/
100			foreach ($action->getAttributes() as $name => $value) {
101			$control->setAttribute($name, $value);
102			}
103			}
104			}
105
106			foreach ($this->group_actions as $id => $action) {
107			$container['group_action']->addCondition(Form::EQUAL, $id)
108			->toggle(static::ID_ATTRIBUTE_PREFIX.$id);
109			}
110
111			$container['group_action']->addCondition(Form::FILLED)
112			->toggle(strtolower($this->datagrid->getName()) . 'group_action_submit');
113
114			$container->addSubmit('submit', 'ublaboo_datagrid.execute')
115			->setAttribute('id', strtolower($this->datagrid->getName()) . 'group_action_submit');
			0 ignored issues – show Documentation introduced 2016-05-20 14:44 UTC by Report Bug Copy Issue Report `strtolower($this->datagr.... 'group_action_submit'` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
116
117			if ($form instanceof Nette\ComponentModel\IComponent) {
118			$form->onSubmit[] = [$this, 'submitted'];
119			}
120			}
121
122
123			/**
124			* Pass "sub"-form submission forward to custom submit function
125			* @param Form $form
126			* @return void
127			*/
128			public function submitted(Form $form)
129			{
130			if (!isset($form['group_action']['submit']) \|\| !$form['group_action']['submit']->isSubmittedBy()) {
131			return;
132			}
133
134			$values = $form->getValues();
135			$values = $values['group_action'];
136
137			if ($values->group_action === 0 \|\| is_null($values->group_action)) {
138			return;
139			}
140
141			/**
142			* @todo Define items IDs
143			*/
144			$http_ids = $form->getHttpData(Form::DATA_LINE\|Form::DATA_KEYS, strtolower($this->datagrid->getName()) . '_group_action_item[]');
145			$ids = array_keys($http_ids);
146
147			$id = $values->group_action;
148			$this->group_actions[$id]->onSelect($ids, isset($values->{$id}) ? $values->{$id} : NULL);
149
150			$form['group_action']['group_action']->setValue(NULL);
151			}
152
153
154			/**
155			* Add one group action (select box) to collection of actions
156			*
157			* @param string $title
158			* @param array $options
159			*
160			* @return GroupAction
161			*/
162			public function addGroupSelectAction($title, $options)
163			{
164			$id = ($s = sizeof($this->group_actions)) ? ($s + 1) : 1;
165
166			return $this->group_actions[$id] = new GroupSelectAction($title, $options);
167			}
168
169
170			/**
171			* Add one group action (text input) to collection of actions
172			*
173			* @param string $title
174			*
175			* @return GroupAction
176			*/
177			public function addGroupTextAction($title)
178			{
179			$id = ($s = sizeof($this->group_actions)) ? ($s + 1) : 1;
180
181			return $this->group_actions[$id] = new GroupTextAction($title);
182			}
183
184
185			/**
186			* Add one group action (textarea) to collection of actions
187			*
188			* @param string $title
189			*
190			* @return GroupAction
191			*/
192			public function addGroupTextareaAction($title)
193			{
194			$id = ($s = sizeof($this->group_actions)) ? ($s + 1) : 1;
195
196			return $this->group_actions[$id] = new GroupTextareaAction($title);
197			}
198
199
200			/**
201			* @param string $title
202			* @return GroupAction
203			*/
204			public function getGroupAction($title)
205			{
206			foreach ($this->group_actions as $action) {
207			if ($action->getTitle() === $title) {
208			return $action;
209			}
210			}
211
212			throw new DataGridGroupActionException("Group action $title does not exist.");
213			}
214
215			}
216

ublaboo / datagrid

Push — master ( f463c7...38c89a )

GroupActionCollection::addGroupTextareaAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like