DataGridActionBase::isSelection() - Code Metrics - Inspection of "* [MOD] Improved template rendering" - nuxsmin/sysPass - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — devel-3.0 ( e32256...e49526 )

by Rubén

created 2018-10-22 22:56 UTC

DataGridActionBase::isSelection() A

↳ Parent: DataGridActionBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *  along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Html\DataGrid\Action;

use SP\Html\Assets\IconInterface;

defined('APP_ROOT') || die();

/**
 * Class DataGridAction para crear una acción para cada elemento de la matriz de datos
 *
 * @package SP\Html\DataGrid
 */
abstract class DataGridActionBase implements DataGridActionInterface
{
    /**
     * El objeto reflexivo que determina si se muestra la acción
     *
     * @var callable
     */
    protected $runtimeFilter;
    /**
     * El nombre de la acción
     *
     * @var string
     */
    protected $name = '';
    /**
     * El título de la acción
     *
     * @var string
     */
    protected $title = '';
    /**
     * El id de la acción
     *
     * @var int
     */
    protected $id = 0;
    /**
     * La función javascript del evento OnClick
     *
     * @var string
     */
    protected $onClickFunction = '';
    /**
     * Los argumentos de la función OnClick
     *
     * @var array
     */
    protected $onClickArgs;
    /**
     * El icono de la acción
     *
     * @var IconInterface
     */
    protected $icon;
    /**
     * Si se debe de omitir para los elementos del listado
     *
     * @var bool
     */
    protected $isSkip = false;
    /**
     * La columna de origen de datos que condiciona esta acción
     *
     * @var array
     */
    protected $filterRowSource;
    /**
     * Si es una acción de ayuda
     *
     * @var bool
     */
    protected $isHelper;
    /**
     * El tipo de acción
     *
     * @var int
     */
    protected $type = 0;
    /**
     * Atributos de datos adicionales
     *
     * @var array
     */
    protected $data;
    /**
     * Atributos adicionales
     *
     * @var array
     */
    protected $attributes;
    /**
     * @var array
     */
    protected $classes;
    /**
     * @var bool
     */
    protected $isSelection = false;

    /**
     * DataGridActionBase constructor.
     *
     * @param int $id EL id de la acción
     */
    public function __construct($id = null)
    {
        $this->id = $id;
    }

    /**
     * Devolver el método reflexivo que determina si se muestra la acción
     *
     * @return callable
     */
    public function getRuntimeFilter()
    {
        return $this->runtimeFilter;
    }

    /**
     * Establecer el método reflexivo que determina si se muestra la acción
     *
     * @param string $class
     * @param string $method
     *
     * @throws \RuntimeException
     * @return $this
     */
    public function setRuntimeFilter($class, $method)
    {
        if (method_exists($class, $method)) {
            $this->runtimeFilter = function ($filter) use ($method) {
//                new \ReflectionMethod($class, $method);
                return $filter->{$method}();
            };
        } else {
            throw new \RuntimeException('Method does not exist');
        }

        return $this;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param $name string
     *
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param int $id
     *
     * @return $this
     */
    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param $title string
     *
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * @param $function string
     *
     * @return $this
     */
    public function setOnClickFunction($function)
    {
        $this->onClickFunction = $function;

        return $this;
    }

    /**
     * @param $args string
     *
     * @return $this
     */
    public function setOnClickArgs($args)
    {
        if ($this->onClickArgs === null) {
            $this->onClickArgs = [];
        }

        $this->onClickArgs[] = $args;

        return $this;
    }

    /**
     * @return string
     */
    public function getOnClick()
    {
        if ($this->onClickArgs !== null) {

            $args = array_map(function ($value) {
                return (!is_numeric($value) && $value !== 'this') ? '\'' . $value . '\'' : $value;
            }, $this->onClickArgs);

            return count($args) > 0 ? $this->onClickFunction . '(' . implode(',', $args) . ')' : $this->onClickFunction;
        }

        return $this->onClickFunction;

    }

    /**
     * @return IconInterface
     */
    public function getIcon()
    {
        return $this->icon;
    }

    /**
     * @param $icon IconInterface
     *
     * @return $this
     */
    public function setIcon($icon)
    {
        $this->icon = $icon;

        return $this;
    }

    /**
     * @param $skip bool
     *
     * @return $this
     */
    public function setSkip($skip)
    {
        $this->isSkip = $skip;

        return $this;
    }

    /**
     * @return bool
     */
    public function isSkip()
    {
        return $this->isSkip;
    }

    /**
     * @return bool
     */
    public function isHelper()
    {
        return $this->isHelper;
    }

    /**
     * @param bool $helper
     *
     * @return $this
     */
    public function setIsHelper($helper)
    {
        $this->isHelper = $helper;

        return $this;
    }

    /**
     * @return array
     */
    public function getFilterRowSource()
    {
        return $this->filterRowSource;
    }

    /**
     * Filtro para mostrar la acción
     *
     * @param       $rowSource string
     * @param mixed $value     Valor a filtrar
     *
     * @return $this
     */
    public function setFilterRowSource($rowSource, $value = 1)
    {
        if ($this->filterRowSource === null) {
            $this->filterRowSource = [];
        }

        $this->filterRowSource[] = ['field' => $rowSource, 'value' => $value];

        return $this;
    }

    /**
     * @return int El tipo de acción
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param int $type El tipo de acción definido en DataGridActionType
     *
     * @return $this
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @return array
     */
    public function getData()
    {
        return (array)$this->data;
    }

    /**
     * @param array $data Los datos de los atributos
     *
     * @return $this
     */
    public function setData(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Añadir nuevo atributo de datos
     *
     * @param string $name El nombe del atributo
     * @param mixed  $data Los datos del atributo
     *
     * @return $this
     */
    public function addData($name, $data)
    {
        if ($this->data === null) {
            $this->data = [];
        }

        $this->data[$name] = $data;

        return $this;
    }

    /**
     * @return array
     */
    public function getAttributes()
    {
        return (array)$this->attributes;
    }

    /**
     * Establecer atributos
     *
     * @param array $attributes Los datos de los atributos
     *
     * @return $this
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;

        return $this;
    }

    /**
     * Añadir nuevo atributo
     *
     * @param string $name El nombe del atributo
     * @param mixed  $value
     *
     * @return $this
     */
    public function addAttribute($name, $value)
    {
        if ($this->attributes === null) {
            $this->attributes = [];
        }

        $this->attributes[$name] = $value;

        return $this;
    }

    /**
     * Returns classes as a string
     *
     * @return string
     */
    public function getClassesAsString()
    {
        if ($this->classes === null) {
            return '';
        }

        return implode(' ', $this->classes);
    }

    /**
     * Returns classes
     *
     * @return array
     */
    public function getClasses()
    {
        return (array)$this->classes;
    }

    /**
     * Set classes
     *
     * @param array $classes
     */
    public function setClasses(array $classes)
    {
        $this->classes = $classes;
    }

    /**
     * Adds a new class
     *
     * @param mixed $value
     *
     * @return $this
     */
    public function addClass($value)
    {
        if ($this->classes === null) {
            $this->classes = [];
        }

        $this->classes[] = $value;

        return $this;
    }

    /**
     * Returns if the action is used for selecting multiple items
     *
     * @return bool
     */
    public function isSelection(): bool
    {
        return $this->isSelection;
    }

    /**
     * @param bool $isSelection
     *
     * @return DataGridActionBase
     */
    public function setIsSelection(bool $isSelection)
    {
        $this->isSelection = $isSelection;

        return $this;
    }
}


1			<?php
2			/**
3			* sysPass
4			*
5			* @author nuxsmin
6			* @link https://syspass.org
7			* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
8			*
9			* This file is part of sysPass.
10			*
11			* sysPass is free software: you can redistribute it and/or modify
12			* it under the terms of the GNU General Public License as published by
13			* the Free Software Foundation, either version 3 of the License, or
14			* (at your option) any later version.
15			*
16			* sysPass is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU General Public License
22			* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
23			*/
24
25			namespace SP\Html\DataGrid\Action;
26
27			use SP\Html\Assets\IconInterface;
28
29			defined('APP_ROOT') \|\| die();
30
31			/**
32			* Class DataGridAction para crear una acción para cada elemento de la matriz de datos
33			*
34			* @package SP\Html\DataGrid
35			*/
36			abstract class DataGridActionBase implements DataGridActionInterface
37			{
38			/**
39			* El objeto reflexivo que determina si se muestra la acción
40			*
41			* @var callable
42			*/
43			protected $runtimeFilter;
44			/**
45			* El nombre de la acción
46			*
47			* @var string
48			*/
49			protected $name = '';
50			/**
51			* El título de la acción
52			*
53			* @var string
54			*/
55			protected $title = '';
56			/**
57			* El id de la acción
58			*
59			* @var int
60			*/
61			protected $id = 0;
62			/**
63			* La función javascript del evento OnClick
64			*
65			* @var string
66			*/
67			protected $onClickFunction = '';
68			/**
69			* Los argumentos de la función OnClick
70			*
71			* @var array
72			*/
73			protected $onClickArgs;
74			/**
75			* El icono de la acción
76			*
77			* @var IconInterface
78			*/
79			protected $icon;
80			/**
81			* Si se debe de omitir para los elementos del listado
82			*
83			* @var bool
84			*/
85			protected $isSkip = false;
86			/**
87			* La columna de origen de datos que condiciona esta acción
88			*
89			* @var array
90			*/
91			protected $filterRowSource;
92			/**
93			* Si es una acción de ayuda
94			*
95			* @var bool
96			*/
97			protected $isHelper;
98			/**
99			* El tipo de acción
100			*
101			* @var int
102			*/
103			protected $type = 0;
104			/**
105			* Atributos de datos adicionales
106			*
107			* @var array
108			*/
109			protected $data;
110			/**
111			* Atributos adicionales
112			*
113			* @var array
114			*/
115			protected $attributes;
116			/**
117			* @var array
118			*/
119			protected $classes;
120			/**
121			* @var bool
122			*/
123			protected $isSelection = false;
124
125			/**
126			* DataGridActionBase constructor.
127			*
128			* @param int $id EL id de la acción
129			*/
130			public function __construct($id = null)
131			{
132			$this->id = $id;
133			}
134
135			/**
136			* Devolver el método reflexivo que determina si se muestra la acción
137			*
138			* @return callable
139			*/
140			public function getRuntimeFilter()
141			{
142			return $this->runtimeFilter;
143			}
144
145			/**
146			* Establecer el método reflexivo que determina si se muestra la acción
147			*
148			* @param string $class
149			* @param string $method
150			*
151			* @throws \RuntimeException
152			* @return $this
153			*/
154			public function setRuntimeFilter($class, $method)
155			{
156			if (method_exists($class, $method)) {
157			$this->runtimeFilter = function ($filter) use ($method) {
158			// new \ReflectionMethod($class, $method);
159			return $filter->{$method}();
160			};
161			} else {
162			throw new \RuntimeException('Method does not exist');
163			}
164
165			return $this;
166			}
167
168			/**
169			* @return string
170			*/
171			public function getName()
172			{
173			return $this->name;
174			}
175
176			/**
177			* @param $name string
178			*
179			* @return $this
180			*/
181			public function setName($name)
182			{
183			$this->name = $name;
184
185			return $this;
186			}
187
188			/**
189			* @return string
190			*/
191			public function getId()
192			{
193			return $this->id;
194			}
195
196			/**
197			* @param int $id
198			*
199			* @return $this
200			*/
201			public function setId($id)
202			{
203			$this->id = $id;
204
205			return $this;
206			}
207
208			/**
209			* @return string
210			*/
211			public function getTitle()
212			{
213			return $this->title;
214			}
215
216			/**
217			* @param $title string
218			*
219			* @return $this
220			*/
221			public function setTitle($title)
222			{
223			$this->title = $title;
224
225			return $this;
226			}
227
228			/**
229			* @param $function string
230			*
231			* @return $this
232			*/
233			public function setOnClickFunction($function)
234			{
235			$this->onClickFunction = $function;
236
237			return $this;
238			}
239
240			/**
241			* @param $args string
242			*
243			* @return $this
244			*/
245			public function setOnClickArgs($args)
246			{
247			if ($this->onClickArgs === null) {
248			$this->onClickArgs = [];
249			}
250
251			$this->onClickArgs[] = $args;
252
253			return $this;
254			}
255
256			/**
257			* @return string
258			*/
259			public function getOnClick()
260			{
261			if ($this->onClickArgs !== null) {
262
263			$args = array_map(function ($value) {
264			return (!is_numeric($value) && $value !== 'this') ? '\'' . $value . '\'' : $value;
265			}, $this->onClickArgs);
266
267			return count($args) > 0 ? $this->onClickFunction . '(' . implode(',', $args) . ')' : $this->onClickFunction;
268			}
269
270			return $this->onClickFunction;
271
272			}
273
274			/**
275			* @return IconInterface
276			*/
277			public function getIcon()
278			{
279			return $this->icon;
280			}
281
282			/**
283			* @param $icon IconInterface
284			*
285			* @return $this
286			*/
287			public function setIcon($icon)
288			{
289			$this->icon = $icon;
290
291			return $this;
292			}
293
294			/**
295			* @param $skip bool
296			*
297			* @return $this
298			*/
299			public function setSkip($skip)
300			{
301			$this->isSkip = $skip;
302
303			return $this;
304			}
305
306			/**
307			* @return bool
308			*/
309			public function isSkip()
310			{
311			return $this->isSkip;
312			}
313
314			/**
315			* @return bool
316			*/
317			public function isHelper()
318			{
319			return $this->isHelper;
320			}
321
322			/**
323			* @param bool $helper
324			*
325			* @return $this
326			*/
327			public function setIsHelper($helper)
328			{
329			$this->isHelper = $helper;
330
331			return $this;
332			}
333
334			/**
335			* @return array
336			*/
337			public function getFilterRowSource()
338			{
339			return $this->filterRowSource;
340			}
341
342			/**
343			* Filtro para mostrar la acción
344			*
345			* @param $rowSource string
346			* @param mixed $value Valor a filtrar
347			*
348			* @return $this
349			*/
350			public function setFilterRowSource($rowSource, $value = 1)
351			{
352			if ($this->filterRowSource === null) {
353			$this->filterRowSource = [];
354			}
355
356			$this->filterRowSource[] = ['field' => $rowSource, 'value' => $value];
357
358			return $this;
359			}
360
361			/**
362			* @return int El tipo de acción
363			*/
364			public function getType()
365			{
366			return $this->type;
367			}
368
369			/**
370			* @param int $type El tipo de acción definido en DataGridActionType
371			*
372			* @return $this
373			*/
374			public function setType($type)
375			{
376			$this->type = $type;
377
378			return $this;
379			}
380
381			/**
382			* @return array
383			*/
384			public function getData()
385			{
386			return (array)$this->data;
387			}
388
389			/**
390			* @param array $data Los datos de los atributos
391			*
392			* @return $this
393			*/
394			public function setData(array $data)
395			{
396			$this->data = $data;
397
398			return $this;
399			}
400
401			/**
402			* Añadir nuevo atributo de datos
403			*
404			* @param string $name El nombe del atributo
405			* @param mixed $data Los datos del atributo
406			*
407			* @return $this
408			*/
409			public function addData($name, $data)
410			{
411			if ($this->data === null) {
412			$this->data = [];
413			}
414
415			$this->data[$name] = $data;
416
417			return $this;
418			}
419
420			/**
421			* @return array
422			*/
423			public function getAttributes()
424			{
425			return (array)$this->attributes;
426			}
427
428			/**
429			* Establecer atributos
430			*
431			* @param array $attributes Los datos de los atributos
432			*
433			* @return $this
434			*/
435			public function setAttributes(array $attributes)
436			{
437			$this->attributes = $attributes;
438
439			return $this;
440			}
441
442			/**
443			* Añadir nuevo atributo
444			*
445			* @param string $name El nombe del atributo
446			* @param mixed $value
447			*
448			* @return $this
449			*/
450			public function addAttribute($name, $value)
451			{
452			if ($this->attributes === null) {
453			$this->attributes = [];
454			}
455
456			$this->attributes[$name] = $value;
457
458			return $this;
459			}
460
461			/**
462			* Returns classes as a string
463			*
464			* @return string
465			*/
466			public function getClassesAsString()
467			{
468			if ($this->classes === null) {
469			return '';
470			}
471
472			return implode(' ', $this->classes);
473			}
474
475			/**
476			* Returns classes
477			*
478			* @return array
479			*/
480			public function getClasses()
481			{
482			return (array)$this->classes;
483			}
484
485			/**
486			* Set classes
487			*
488			* @param array $classes
489			*/
490			public function setClasses(array $classes)
491			{
492			$this->classes = $classes;
493			}
494
495			/**
496			* Adds a new class
497			*
498			* @param mixed $value
499			*
500			* @return $this
501			*/
502			public function addClass($value)
503			{
504			if ($this->classes === null) {
505			$this->classes = [];
506			}
507
508			$this->classes[] = $value;
509
510			return $this;
511			}
512
513			/**
514			* Returns if the action is used for selecting multiple items
515			*
516			* @return bool
517			*/
518			public function isSelection(): bool
519			{
520			return $this->isSelection;
521			}
522
523			/**
524			* @param bool $isSelection
525			*
526			* @return DataGridActionBase
527			*/
528			public function setIsSelection(bool $isSelection)
529			{
530			$this->isSelection = $isSelection;
531
532			return $this;
533			}
534			}
535

nuxsmin / sysPass

Push — devel-3.0 ( e32256...e49526 )

DataGridActionBase::isSelection() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like