Role::setParent() - Code Metrics - Inspection of "Change getters to getFoo, and access with ArrayAcc..." - locomotivemtl/charcoal-user - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#2)

by Mathieu

created 2019-07-23 20:56 UTC

Role::setParent() A

↳ Parent: Role

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Charcoal\User\Acl;

use InvalidArgumentException;

// From Pimple
use Pimple\Container;

// From 'charcoal-translator'
use Charcoal\Translator\TranslatorAwareTrait;

// From 'charcoal-core'
use Charcoal\Model\AbstractModel;

/**
 * ACL Roles define hierarchical allowed and denied permissions.
 *
 * They can be attached to user accounts for fine-grained permission control.
 */
class Role extends AbstractModel

{
    use TranslatorAwareTrait;

    const SEPARATOR = ',';

    /**
     * @var string|null $ident
     */
    public $ident;

    /**
     * The parent ACL role.
     *
     * This role will inherit all of its parent's permissions.
     *
     * @var string $parent
     */
    public $parent;

    /**
     * The user-friendly name.
     *
     * @var \Charcoal\Translator\Translation
     */
    public $name;

    /**
     * List of explicitely allowed permissions.
     *
     * @var string[]|null $allowed
     */
    public $allowed;

    /**
     * List of explicitely denied permissions.
     *
     * @var string[]|null $denied
     */
    public $denied;

    /**
     * @var boolean
     */
    private $superuser = false;

    /**
     * @var integer
     */
    private $position;

    /**
     * ACL Role can be used as a string (ident).
     *
     * @return string
     */
    public function __toString()
    {
        if ($this->ident === null) {
            return '';
        }
        return $this->ident;
    }

    /**
     * @return string
     */
    public function key()
    {
        return 'ident';
    }

    /**
     * @param string|Role $parent Role's parent.
     * @return self
     */
    public function setParent($parent)
    {
        $this->parent = (string)$parent;
        return $this;
    }

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

    /**
     * @param string[]|string|null $allowed The allowed permissions for this role.
     * @throws InvalidArgumentException If the passed arguments is not an array, null, or a comma-separated string.
     * @return self
     */
    public function setAllowed($allowed)

    {
        if ($allowed === null) {
            $this->allowed = null;
            return $this;
        }

        if (is_string($allowed)) {
            $allowed = explode(self::SEPARATOR, $allowed);
            $allowed = array_map('trim', $allowed);
        }
        if (!is_array($allowed)) {
            throw new InvalidArgumentException(
                'Invalid allowed value. Must be an array, null, or a comma-separated string.'
            );
        }
        $this->allowed = $allowed;
        return $this;
    }

    /**
     * @return string[]|null
     */
    public function getAllowed()
    {
        return $this->allowed;
    }

    /**
     * @param string[]|string|null $denied The denied permissions for this role.
     * @throws InvalidArgumentException If the passed arguments is not an array, null, or a comma-separated string.
     * @return self
     */
    public function setDenied($denied)

    {
        if ($denied === null) {
            $this->denied = null;
            return $this;
        }

        if (is_string($denied)) {
            $denied = explode(self::SEPARATOR, $denied);
            $denied = array_map('trim', $denied);
        }
        if (!is_array($denied)) {
            throw new InvalidArgumentException(
                'Invalid denied value. Must be an array, null, or a comma-separated string.'
            );
        }
        $this->denied = $denied;
        return $this;
    }

    /**
     * @return string[]|null
     */
    public function getDenied()
    {
        return $this->denied;
    }

    /**
     * @param boolean $isSuper The superuser flag.
     * @return self
     */
    public function setSuperuser($isSuper)
    {
        $this->superuser = !!$isSuper;
        return $this;
    }

    /**
     * @return boolean
     */
    public function getSuperuser()
    {
        return $this->superuser;
    }

    /**
     * @param integer|string|null $position The role's ordering position.
     * @return self
     */
    public function setPosition($position)
    {
        $this->position = (int)$position;
        return $this;
    }

    /**
     * @return integer
     */
    public function getPosition()
    {
        return $this->position;
    }

    /**
     * @param Container $container Pimple DI container.
     * @return void
     */
    protected function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        $this->setTranslator($container['translator']);
    }
}


1		<?php
2
3		namespace Charcoal\User\Acl;
4
5		use InvalidArgumentException;
6
7		// From Pimple
8		use Pimple\Container;
9
10		// From 'charcoal-translator'
11		use Charcoal\Translator\TranslatorAwareTrait;
12
13		// From 'charcoal-core'
14		use Charcoal\Model\AbstractModel;
15
16		/**
17		* ACL Roles define hierarchical allowed and denied permissions.
18		*
19		* They can be attached to user accounts for fine-grained permission control.
20		*/
21		class Role extends AbstractModel
		0 ignored issues – show Bug introduced 2018-01-05 19:54 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: hasProperty, p, properties, property Loading history...
22		{
23		use TranslatorAwareTrait;
24
25		const SEPARATOR = ',';
26
27		/**
28		* @var string\|null $ident
29		*/
30		public $ident;
31
32		/**
33		* The parent ACL role.
34		*
35		* This role will inherit all of its parent's permissions.
36		*
37		* @var string $parent
38		*/
39		public $parent;
40
41		/**
42		* The user-friendly name.
43		*
44		* @var \Charcoal\Translator\Translation
45		*/
46		public $name;
47
48		/**
49		* List of explicitely allowed permissions.
50		*
51		* @var string[]\|null $allowed
52		*/
53		public $allowed;
54
55		/**
56		* List of explicitely denied permissions.
57		*
58		* @var string[]\|null $denied
59		*/
60		public $denied;
61
62		/**
63		* @var boolean
64		*/
65		private $superuser = false;
66
67		/**
68		* @var integer
69		*/
70		private $position;
71
72		/**
73		* ACL Role can be used as a string (ident).
74		*
75		* @return string
76		*/
77		public function __toString()
78		{
79		if ($this->ident === null) {
80		return '';
81		}
82		return $this->ident;
83		}
84
85		/**
86		* @return string
87		*/
88		public function key()
89		{
90		return 'ident';
91		}
92
93		/**
94		* @param string\|Role $parent Role's parent.
95		* @return self
96		*/
97		public function setParent($parent)
98		{
99		$this->parent = (string)$parent;
100		return $this;
101		}
102
103		/**
104		* @return string
105		*/
106		public function getParent()
107		{
108		return $this->parent;
109		}
110
111		/**
112		* @param string[]\|string\|null $allowed The allowed permissions for this role.
113		* @throws InvalidArgumentException If the passed arguments is not an array, null, or a comma-separated string.
114		* @return self
115		*/
116	View Code Duplication	public function setAllowed($allowed)
		0 ignored issues – show Duplication introduced 2017-11-17 20:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117		{
118		if ($allowed === null) {
119		$this->allowed = null;
120		return $this;
121		}
122
123		if (is_string($allowed)) {
124		$allowed = explode(self::SEPARATOR, $allowed);
125		$allowed = array_map('trim', $allowed);
126		}
127		if (!is_array($allowed)) {
128		throw new InvalidArgumentException(
129		'Invalid allowed value. Must be an array, null, or a comma-separated string.'
130		);
131		}
132		$this->allowed = $allowed;
133		return $this;
134		}
135
136		/**
137		* @return string[]\|null
138		*/
139		public function getAllowed()
140		{
141		return $this->allowed;
142		}
143
144		/**
145		* @param string[]\|string\|null $denied The denied permissions for this role.
146		* @throws InvalidArgumentException If the passed arguments is not an array, null, or a comma-separated string.
147		* @return self
148		*/
149	View Code Duplication	public function setDenied($denied)
		0 ignored issues – show Duplication introduced 2017-11-17 20:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
150		{
151		if ($denied === null) {
152		$this->denied = null;
153		return $this;
154		}
155
156		if (is_string($denied)) {
157		$denied = explode(self::SEPARATOR, $denied);
158		$denied = array_map('trim', $denied);
159		}
160		if (!is_array($denied)) {
161		throw new InvalidArgumentException(
162		'Invalid denied value. Must be an array, null, or a comma-separated string.'
163		);
164		}
165		$this->denied = $denied;
166		return $this;
167		}
168
169		/**
170		* @return string[]\|null
171		*/
172		public function getDenied()
173		{
174		return $this->denied;
175		}
176
177		/**
178		* @param boolean $isSuper The superuser flag.
179		* @return self
180		*/
181		public function setSuperuser($isSuper)
182		{
183		$this->superuser = !!$isSuper;
184		return $this;
185		}
186
187		/**
188		* @return boolean
189		*/
190		public function getSuperuser()
191		{
192		return $this->superuser;
193		}
194
195		/**
196		* @param integer\|string\|null $position The role's ordering position.
197		* @return self
198		*/
199		public function setPosition($position)
200		{
201		$this->position = (int)$position;
202		return $this;
203		}
204
205		/**
206		* @return integer
207		*/
208		public function getPosition()
209		{
210		return $this->position;
211		}
212
213		/**
214		* @param Container $container Pimple DI container.
215		* @return void
216		*/
217		protected function setDependencies(Container $container)
218		{
219		parent::setDependencies($container);
220
221		$this->setTranslator($container['translator']);
222		}
223		}
224

locomotivemtl / charcoal-user

Pull Request — master (#2)

Role::setParent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like