Container::hasOperation() - Code Metrics - Inspection of "Remove of Nette\Object and replace with trait Nett..." - o5/grido - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#299)

unknown

created 2018-02-28 09:22 UTC

Container::hasOperation() A

↳ Parent: Container

Complexity

Conditions	4
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.2
c	0
b	0
f	0
ccs	0
cts	6
cp	0
cc	4
eloc	6
nc	3
nop	1
crap	20

<?php

/**
 * This file is part of the Grido (http://grido.bugyik.cz)
 *
 * Copyright (c) 2011 Petr Bugyík (http://petr.bugyik.cz)
 *
 * For the full copyright and license information, please view
 * the file license.md that was distributed with this source code.
 */

namespace Grido\Components;

use Grido\Grid;
use Grido\Helpers;
use Grido\Components\Actions\Action;
use Grido\Components\Columns\Column;
use Grido\Components\Filters\Filter;
use Grido\Components\Columns\Editable;

/**
 * Container of grid components.
 *
 * @package     Grido
 * @subpackage  Components
 * @author      Petr Bugyík
 *
 */
abstract class Container extends \Nette\Application\UI\Control
{
    /** @var bool */
    protected $hasColumns;

    /** @var bool */
    protected $hasFilters;

    /** @var bool */
    protected $hasActions;

    /** @var bool */
    protected $hasOperation;

    /** @var bool */
    protected $hasExport;

    /** @var bool */
    protected $hasButtons;

    /**
     * Returns column component.
     * @param string $name
     * @param bool $need
     * @return Editable
     */
    public function getColumn($name, $need = TRUE)
    {
        return $this->hasColumns()
            ? $this->getComponent(Column::ID)->getComponent(Helpers::formatColumnName($name), $need)
            : NULL;
    }

    /**
     * Returns filter component.
     * @param string $name
     * @param bool $need
     * @return Filter
     */
    public function getFilter($name, $need = TRUE)
    {
        return $this->hasFilters()
            ? $this->getComponent(Filter::ID)->getComponent(Helpers::formatColumnName($name), $need)
            : NULL;
    }

    /**
     * Returns action component.
     * @param string $name
     * @param bool $need
     * @return Action
     */
    public function getAction($name, $need = TRUE)
    {
        return $this->hasActions()
            ? $this->getComponent(Action::ID)->getComponent($name, $need)
            : NULL;
    }

    /**
     * Returns operations component.
     * @param bool $need
     * @return Operation
     */
    public function getOperation($need = TRUE)
    {
        return $this->getComponent(Operation::ID, $need);
    }

    /**
     * Returns export component.
     * @param bool $need
     * @return Export
     */
    public function getExport($need = TRUE)
    {
        return $this->getComponent(Export::ID, $need);
    }

    /**
     * Returns toolbar button component.
     * @param bool $need
     * @return Button
     */
    public function getButton($name, $need = TRUE)
    {
        return $this->hasButtons()
            ? $this->getComponent(Button::ID)->getComponent($name, $need)
            : NULL;
    }

    /**********************************************************************************************/

    /**
     * @param bool $useCache
     * @return bool
     * @internal
     */
    public function hasColumns($useCache = TRUE)
    {
        $hasColumns = $this->hasColumns;

        if ($hasColumns === NULL || $useCache === FALSE) {
            $container = $this->getComponent(Column::ID, FALSE);
            $hasColumns = $container && count($container->getComponents()) > 0;
            $this->hasColumns = $useCache ? $hasColumns : NULL;
        }

        return $hasColumns;
    }

    /**
     * @param bool $useCache
     * @return bool
     * @internal
     */
    public function hasFilters($useCache = TRUE)
    {
        $hasFilters = $this->hasFilters;

        if ($hasFilters === NULL || $useCache === FALSE) {
            $container = $this->getComponent(Filter::ID, FALSE);
            $hasFilters = $container && count($container->getComponents()) > 0;
            $this->hasFilters = $useCache ? $hasFilters : NULL;
        }

        return $hasFilters;
    }

    /**
     * @param bool $useCache
     * @return bool
     * @internal
     */
    public function hasActions($useCache = TRUE)
    {
        $hasActions = $this->hasActions;

        if ($hasActions === NULL || $useCache === FALSE) {
            $container = $this->getComponent(Action::ID, FALSE);
            $hasActions = $container && count($container->getComponents()) > 0;
            $this->hasActions = $useCache ? $hasActions : NULL;
        }

        return $hasActions;
    }

    /**
     * @param bool $useCache
     * @return bool
     * @internal
     */
    public function hasOperation($useCache = TRUE)
    {
        $hasOperation = $this->hasOperation;

        if ($hasOperation === NULL || $useCache === FALSE) {
            $hasOperation = (bool) $this->getComponent(Operation::ID, FALSE);
            $this->hasOperation = $useCache ? $hasOperation : NULL;
        }

        return $hasOperation;
    }

    /**
     * @param bool $useCache
     * @return bool
     * @internal
     */
    public function hasExport($useCache = TRUE)
    {
        $hasExport = $this->hasExport;

        if ($hasExport === NULL || $useCache === FALSE) {
            $hasExport = (bool) $this->getComponent(Export::ID, FALSE);
            $this->hasExport = $useCache ? $hasExport : NULL;
        }

        return $hasExport;
    }

    /**
     * @param bool $useCache
     * @return bool
     * @internal
     */
    public function hasButtons($useCache = TRUE)
    {
        $hasButtons = $this->hasButtons;

        if ($hasButtons === NULL || $useCache === FALSE) {
            $hasButtons = (bool) $this->getComponent(Button::ID, FALSE);
            $this->hasButtons = $useCache ? $hasButtons : NULL;
        }

        return $hasButtons;
    }

    /**********************************************************************************************/

    /**
     * @param string $name
     * @param string $label
     * @return Columns\Text
     */
    public function addColumnText($name, $label)
    {
        return new Columns\Text($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @return Columns\Email
     */
    public function addColumnEmail($name, $label)
    {
        return new Columns\Email($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @return Columns\Link
     */
    public function addColumnLink($name, $label)
    {
        return new Columns\Link($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @param string $dateFormat
     * @return Columns\Date
     */
    public function addColumnDate($name, $label, $dateFormat = NULL)
    {
        return new Columns\Date($this, $name, $label, $dateFormat);
    }

    /**
     * @param string $name
     * @param string $label
     * @param int $decimals number of decimal points
     * @param string $decPoint separator for the decimal point
     * @param string $thousandsSep thousands separator
     * @return Columns\Number
     */
    public function addColumnNumber($name, $label, $decimals = NULL, $decPoint = NULL, $thousandsSep = NULL)
    {
        return new Columns\Number($this, $name, $label, $decimals, $decPoint, $thousandsSep);
    }

    /**********************************************************************************************/

    /**
     * @param string $name
     * @param string $label
     * @return Filters\Text
     */
    public function addFilterText($name, $label)
    {
        return new Filters\Text($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @return Filters\Date
     */
    public function addFilterDate($name, $label)
    {
        return new Filters\Date($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @return Filters\DateRange
     */
    public function addFilterDateRange($name, $label)
    {
        return new Filters\DateRange($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @return Filters\Check
     */
    public function addFilterCheck($name, $label)
    {
        return new Filters\Check($this, $name, $label);
    }

    /**
     * @param string $name
     * @param string $label
     * @param array $items
     * @return Filters\Select
     */
    public function addFilterSelect($name, $label, array $items = NULL)
    {
        return new Filters\Select($this, $name, $label, $items);
    }

    /**
     * @param string $name
     * @param string $label
     * @return Filters\Number
     */
    public function addFilterNumber($name, $label)
    {
        return new Filters\Number($this, $name, $label);
    }

    /**
     * @param string $name
     * @param \Nette\Forms\IControl $formControl
     * @return Filters\Custom
     */
    public function addFilterCustom($name, \Nette\Forms\IControl $formControl)
    {
        return new Filters\Custom($this, $name, NULL, $formControl);
    }

    /**********************************************************************************************/

    /**
     * @param string $name
     * @param string $label
     * @param string $destination
     * @param array $arguments
     * @return Actions\Href
     */
    public function addActionHref($name, $label, $destination = NULL, array $arguments = [])
    {
        return new Actions\Href($this, $name, $label, $destination, $arguments);
    }

    /**
     * @param string $name
     * @param string $label
     * @param callback $onClick
     * @return Actions\Event
     */
    public function addActionEvent($name, $label, $onClick = NULL)
    {
        return new Actions\Event($this, $name, $label, $onClick);
    }

    /**********************************************************************************************/

    /**
     * @param array $operations
     * @param callback $onSubmit - callback after operation submit
     * @return Operation
     */
    public function setOperation(array $operations, $onSubmit)
    {
        return new Operation($this, $operations, $onSubmit);
    }

    /**
     * @param string $label of exporting file
     * @return Export
     */
    public function setExport($label = NULL)
    {
        return new Export($this, $label);
    }


    /**
     * @param string $name
     * @param string $label
     * @param string $destination - first param for method $presenter->link()
     * @param array $arguments - second param for method $presenter->link()
     * @return Button
     */
    public function addButton($name, $label = NULL, $destination = NULL, array $arguments = [])
    {
        return new Button($this, $name, $label, $destination, $arguments);
    }

    /**
     * Sets all columns as editable.
     * First parameter is optional and is for implementation of method for saving modified data.
     * @param callback $callback function($id, $newValue, $oldValue, Editable $column) {}
     * @return Grid
     */
    public function setEditableColumns($callback = NULL)
    {
        $this->onRender[] = function(Grid $grid) use ($callback) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            if (!$grid->hasColumns()) {
                return;
            }

            foreach ($grid->getComponent(Column::ID)->getComponents() as $column) {
                if ($column instanceof Editable && !$column->isEditableDisabled() && !$column->editableCallback) {

                    $column->setEditable($callback);
                }
            }
        };

        return $this;
    }
}


1		<?php
2
3		/**
4		* This file is part of the Grido (http://grido.bugyik.cz)
5		*
6		* Copyright (c) 2011 Petr Bugyík (http://petr.bugyik.cz)
7		*
8		* For the full copyright and license information, please view
9		* the file license.md that was distributed with this source code.
10		*/
11
12		namespace Grido\Components;
13
14		use Grido\Grid;
15		use Grido\Helpers;
16		use Grido\Components\Actions\Action;
17		use Grido\Components\Columns\Column;
18		use Grido\Components\Filters\Filter;
19		use Grido\Components\Columns\Editable;
20
21		/**
22		* Container of grid components.
23		*
24		* @package Grido
25		* @subpackage Components
26		* @author Petr Bugyík
27		*
28		*/
29		abstract class Container extends \Nette\Application\UI\Control
30	1	{
31		/** @var bool */
32		protected $hasColumns;
33
34		/** @var bool */
35		protected $hasFilters;
36
37		/** @var bool */
38		protected $hasActions;
39
40		/** @var bool */
41		protected $hasOperation;
42
43		/** @var bool */
44		protected $hasExport;
45
46		/** @var bool */
47		protected $hasButtons;
48
49		/**
50		* Returns column component.
51		* @param string $name
52		* @param bool $need
53		* @return Editable
54		*/
55		public function getColumn($name, $need = TRUE)
56		{
57	1	return $this->hasColumns()
58	1	? $this->getComponent(Column::ID)->getComponent(Helpers::formatColumnName($name), $need)
59	1	: NULL;
60		}
61
62		/**
63		* Returns filter component.
64		* @param string $name
65		* @param bool $need
66		* @return Filter
67		*/
68		public function getFilter($name, $need = TRUE)
69	1	{
70	1	return $this->hasFilters()
71	1	? $this->getComponent(Filter::ID)->getComponent(Helpers::formatColumnName($name), $need)
72	1	: NULL;
73		}
74
75		/**
76		* Returns action component.
77		* @param string $name
78		* @param bool $need
79		* @return Action
80		*/
81		public function getAction($name, $need = TRUE)
82	1	{
83		return $this->hasActions()
84		? $this->getComponent(Action::ID)->getComponent($name, $need)
85		: NULL;
86		}
87
88		/**
89		* Returns operations component.
90		* @param bool $need
91		* @return Operation
92		*/
93		public function getOperation($need = TRUE)
94		{
95		return $this->getComponent(Operation::ID, $need);
96		}
97
98		/**
99		* Returns export component.
100		* @param bool $need
101		* @return Export
102		*/
103		public function getExport($need = TRUE)
104		{
105		return $this->getComponent(Export::ID, $need);
106		}
107
108		/**
109		* Returns toolbar button component.
110		* @param bool $need
111		* @return Button
112		*/
113		public function getButton($name, $need = TRUE)
114		{
115		return $this->hasButtons()
116		? $this->getComponent(Button::ID)->getComponent($name, $need)
117		: NULL;
118		}
119
120		/**********************************************************************************************/
121
122		/**
123		* @param bool $useCache
124		* @return bool
125		* @internal
126		*/
127		public function hasColumns($useCache = TRUE)
128		{
129	1	$hasColumns = $this->hasColumns;
130
131	1	if ($hasColumns === NULL \|\| $useCache === FALSE) {
132	1	$container = $this->getComponent(Column::ID, FALSE);
133	1	$hasColumns = $container && count($container->getComponents()) > 0;
134	1	$this->hasColumns = $useCache ? $hasColumns : NULL;
135	1	}
136
137	1	return $hasColumns;
138		}
139
140		/**
141		* @param bool $useCache
142		* @return bool
143		* @internal
144		*/
145		public function hasFilters($useCache = TRUE)
146		{
147	1	$hasFilters = $this->hasFilters;
148
149	1	if ($hasFilters === NULL \|\| $useCache === FALSE) {
150	1	$container = $this->getComponent(Filter::ID, FALSE);
151	1	$hasFilters = $container && count($container->getComponents()) > 0;
152	1	$this->hasFilters = $useCache ? $hasFilters : NULL;
153	1	}
154
155	1	return $hasFilters;
156		}
157
158		/**
159		* @param bool $useCache
160		* @return bool
161		* @internal
162		*/
163		public function hasActions($useCache = TRUE)
164		{
165		$hasActions = $this->hasActions;
166
167		if ($hasActions === NULL \|\| $useCache === FALSE) {
168		$container = $this->getComponent(Action::ID, FALSE);
169		$hasActions = $container && count($container->getComponents()) > 0;
170	1	$this->hasActions = $useCache ? $hasActions : NULL;
171		}
172
173		return $hasActions;
174		}
175
176		/**
177		* @param bool $useCache
178		* @return bool
179		* @internal
180		*/
181		public function hasOperation($useCache = TRUE)
182		{
183		$hasOperation = $this->hasOperation;
184
185		if ($hasOperation === NULL \|\| $useCache === FALSE) {
186		$hasOperation = (bool) $this->getComponent(Operation::ID, FALSE);
187		$this->hasOperation = $useCache ? $hasOperation : NULL;
188		}
189
190		return $hasOperation;
191		}
192
193		/**
194		* @param bool $useCache
195		* @return bool
196		* @internal
197		*/
198		public function hasExport($useCache = TRUE)
199		{
200		$hasExport = $this->hasExport;
201
202		if ($hasExport === NULL \|\| $useCache === FALSE) {
203		$hasExport = (bool) $this->getComponent(Export::ID, FALSE);
204		$this->hasExport = $useCache ? $hasExport : NULL;
205		}
206
207		return $hasExport;
208		}
209
210		/**
211		* @param bool $useCache
212		* @return bool
213		* @internal
214		*/
215		public function hasButtons($useCache = TRUE)
216		{
217		$hasButtons = $this->hasButtons;
218
219		if ($hasButtons === NULL \|\| $useCache === FALSE) {
220		$hasButtons = (bool) $this->getComponent(Button::ID, FALSE);
221		$this->hasButtons = $useCache ? $hasButtons : NULL;
222		}
223
224		return $hasButtons;
225		}
226
227		/**********************************************************************************************/
228
229		/**
230		* @param string $name
231		* @param string $label
232		* @return Columns\Text
233		*/
234		public function addColumnText($name, $label)
235		{
236	1	return new Columns\Text($this, $name, $label);
237		}
238
239		/**
240		* @param string $name
241		* @param string $label
242		* @return Columns\Email
243		*/
244		public function addColumnEmail($name, $label)
245		{
246	1	return new Columns\Email($this, $name, $label);
247		}
248
249		/**
250		* @param string $name
251		* @param string $label
252		* @return Columns\Link
253		*/
254		public function addColumnLink($name, $label)
255		{
256	1	return new Columns\Link($this, $name, $label);
257		}
258
259		/**
260		* @param string $name
261		* @param string $label
262		* @param string $dateFormat
263		* @return Columns\Date
264		*/
265		public function addColumnDate($name, $label, $dateFormat = NULL)
266		{
267	1	return new Columns\Date($this, $name, $label, $dateFormat);
268		}
269
270		/**
271		* @param string $name
272		* @param string $label
273		* @param int $decimals number of decimal points
274		* @param string $decPoint separator for the decimal point
275		* @param string $thousandsSep thousands separator
276		* @return Columns\Number
277		*/
278		public function addColumnNumber($name, $label, $decimals = NULL, $decPoint = NULL, $thousandsSep = NULL)
279		{
280	1	return new Columns\Number($this, $name, $label, $decimals, $decPoint, $thousandsSep);
281		}
282
283		/**********************************************************************************************/
284
285		/**
286		* @param string $name
287		* @param string $label
288		* @return Filters\Text
289		*/
290		public function addFilterText($name, $label)
291		{
292	1	return new Filters\Text($this, $name, $label);
293		}
294
295		/**
296		* @param string $name
297		* @param string $label
298		* @return Filters\Date
299		*/
300		public function addFilterDate($name, $label)
301		{
302	1	return new Filters\Date($this, $name, $label);
303		}
304
305		/**
306		* @param string $name
307		* @param string $label
308		* @return Filters\DateRange
309		*/
310		public function addFilterDateRange($name, $label)
311		{
312	1	return new Filters\DateRange($this, $name, $label);
313		}
314
315		/**
316		* @param string $name
317		* @param string $label
318		* @return Filters\Check
319		*/
320		public function addFilterCheck($name, $label)
321		{
322	1	return new Filters\Check($this, $name, $label);
323		}
324
325		/**
326		* @param string $name
327		* @param string $label
328		* @param array $items
329		* @return Filters\Select
330		*/
331		public function addFilterSelect($name, $label, array $items = NULL)
332		{
333	1	return new Filters\Select($this, $name, $label, $items);
334		}
335
336		/**
337		* @param string $name
338		* @param string $label
339		* @return Filters\Number
340		*/
341		public function addFilterNumber($name, $label)
342		{
343	1	return new Filters\Number($this, $name, $label);
344		}
345
346		/**
347		* @param string $name
348		* @param \Nette\Forms\IControl $formControl
349		* @return Filters\Custom
350		*/
351		public function addFilterCustom($name, \Nette\Forms\IControl $formControl)
352		{
353	1	return new Filters\Custom($this, $name, NULL, $formControl);
354		}
355
356		/**********************************************************************************************/
357
358		/**
359		* @param string $name
360		* @param string $label
361		* @param string $destination
362		* @param array $arguments
363		* @return Actions\Href
364		*/
365		public function addActionHref($name, $label, $destination = NULL, array $arguments = [])
366		{
367		return new Actions\Href($this, $name, $label, $destination, $arguments);
368		}
369
370		/**
371		* @param string $name
372		* @param string $label
373		* @param callback $onClick
374		* @return Actions\Event
375		*/
376		public function addActionEvent($name, $label, $onClick = NULL)
377		{
378		return new Actions\Event($this, $name, $label, $onClick);
379		}
380
381		/**********************************************************************************************/
382
383		/**
384		* @param array $operations
385		* @param callback $onSubmit - callback after operation submit
386		* @return Operation
387		*/
388		public function setOperation(array $operations, $onSubmit)
389		{
390		return new Operation($this, $operations, $onSubmit);
391		}
392
393		/**
394		* @param string $label of exporting file
395		* @return Export
396		*/
397		public function setExport($label = NULL)
398		{
399		return new Export($this, $label);
400		}
401
402
403		/**
404		* @param string $name
405		* @param string $label
406		* @param string $destination - first param for method $presenter->link()
407		* @param array $arguments - second param for method $presenter->link()
408		* @return Button
409		*/
410		public function addButton($name, $label = NULL, $destination = NULL, array $arguments = [])
411		{
412		return new Button($this, $name, $label, $destination, $arguments);
413		}
414
415		/**
416		* Sets all columns as editable.
417		* First parameter is optional and is for implementation of method for saving modified data.
418		* @param callback $callback function($id, $newValue, $oldValue, Editable $column) {}
419		* @return Grid
420		*/
421		public function setEditableColumns($callback = NULL)
422		{
423		$this->onRender[] = function(Grid $grid) use ($callback) {
		0 ignored issues – show Documentation introduced 2015-11-24 11:50 UTC by Report Bug Copy Issue Report The property `onRender` does not exist on `object<Grido\Components\Container>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
424		if (!$grid->hasColumns()) {
425		return;
426		}
427
428		foreach ($grid->getComponent(Column::ID)->getComponents() as $column) {
429		if ($column instanceof Editable && !$column->isEditableDisabled() && !$column->editableCallback) {
		0 ignored issues – show Bug introduced 2016-07-10 15:00 UTC by Report Bug Copy Issue Report The property `editableCallback` cannot be accessed from this context as it is declared `protected` in class `Grido\Components\Columns\Editable`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
430		$column->setEditable($callback);
431		}
432		}
433		};
434
435		return $this;
436		}
437		}
438

o5 / grido

Pull Request — master (#299)

Container::hasOperation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like