TPermissionEvent::getDescription() - Code Metrics - Inspection of "#783 Shell modernization for Composer, Cron Shell..." - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5fd064...896ccb )

by Fabio

created 2021-07-18 08:07 UTC

TPermissionEvent::getDescription() A

↳ Parent: TPermissionEvent

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * TPermissionEvent class file
 *
 * @author Brad Anderson <[email protected]>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 * @package Prado\Security\Permissions
 */

namespace Prado\Security\Permissions;

use Prado\Exceptions\TConfigurationException;
use Prado\TPropertyValue;
use Prado\Security\TAuthorizationRule;

/**
 * TPermissionEvent class
 *
 * TPermissionEvent links a permission to dynamic events to check permission.
 * This class acts as a data container object for the Permission, Description,
 * and module preset rules.  Preset Rules can be turned off from the
 * TPermissionManager with setting setAutoPresetRules to false.
 * This class works with {@link \Prado\Security\Permissions\TPermissionsBehavior}
 * to register the Permission, Description, and Preset Rules and also to
 * link the dynamic events to check user permission.
 *
 * @author Brad Anderson <[email protected]>
 * @package Prado\Security\Permissions
 * @since 4.2.0
 */
class TPermissionEvent extends \Prado\TComponent
{
	/** @var string permission */
	private $_name;
	
	/** @var string short description of the permission */
	private $_description;
	
	/** @var string[] dynamic events  */
	private $_events;
	
	/** @var \Prado\Security\TAuthorizationRule[] the preset rules from the module  */
	private $_rules;
	
	/**
	 * Constructs the class. All permission names are made lower case.
	 * @param string $permissionName the permission name linked to the dynamic events.
	 * @param string $description short description of the permission
	 * @param string|string[] $events the events that the permission is linked.
	 * @param null|Prado\Security\TAuthorizationRule[] $rules default rules from the module.
	 */
	public function __construct($permissionName = '', $description = '', $events = [], $rules = null)
	{
		$this->setName($permissionName);
		$this->setDescription($description);
		$this->setEvents($events);
		$this->setRules($rules);
	}
	
	/**
	 * @return string the permission name
	 */
	public function getName()
	{
		return $this->_name;
	}
	
	/**
	 * @param string $permissionName the permission name
	 */
	public function setName($permissionName)
	{
		$this->_name = strtolower(TPropertyValue::ensureString($permissionName));
	}
	
	/**
	 * @return string the permission description
	 */
	public function getDescription()
	{
		return $this->_description;
	}
	
	/**
	 * @param string $description the permission description
	 */
	public function setDescription($description)
	{
		$this->_description = TPropertyValue::ensureString($description);
	}
	
	/**
	 * @return string[] the dynamic events tied to the permission
	 */
	public function getEvents()
	{
		return $this->_events;
	}
	
	/**
	 * this will take an array of string dynamic events, or a ',' comma separated
	 * list of dynamic events
	 * @param string|string[] $events the dynamic events tied to the permission
	 */
	public function setEvents($events)
	{
		if (is_string($events)) {
			$events = array_map('trim', explode(',', $events));
		} elseif ($events !== null && !is_array($events)) {

			throw new TConfigurationException('permission_events_invalid', $events);
		}
		$this->_events = array_map('strtolower', array_filter($events ?? []));
	}
	
	/**
	 * these are the preset rules for when registering the permission name.
	 * @return \Prado\Security\TAuthorizationRule[] the preset permission rules
	 */
	public function getRules()
	{
		return $this->_rules;
	}
	
	/**
	 * these are the preset rules for when registering the permission name.
	 * @param null|Prado\Security\TAuthorizationRule|Prado\Security\TAuthorizationRule[] $rules the preset permission rules

	 */
	public function setRules($rules)
	{
		if ($rules instanceof TAuthorizationRule) {
			$rules = [$rules];
		}
		if ($rules !== null && !is_array($rules)) {

			throw new TConfigurationException('permission_rules_invalid', $rules);
		}
		$this->_rules = $rules ?? [];
	}
}


1			<?php
2			/**
3			* TPermissionEvent class file
4			*
5			* @author Brad Anderson <[email protected]>
6			* @link https://github.com/pradosoft/prado
7			* @license https://github.com/pradosoft/prado/blob/master/LICENSE
8			* @package Prado\Security\Permissions
9			*/
10
11			namespace Prado\Security\Permissions;
12
13			use Prado\Exceptions\TConfigurationException;
14			use Prado\TPropertyValue;
15			use Prado\Security\TAuthorizationRule;
16
17			/**
18			* TPermissionEvent class
19			*
20			* TPermissionEvent links a permission to dynamic events to check permission.
21			* This class acts as a data container object for the Permission, Description,
22			* and module preset rules. Preset Rules can be turned off from the
23			* TPermissionManager with setting setAutoPresetRules to false.
24			* This class works with {@link \Prado\Security\Permissions\TPermissionsBehavior}
25			* to register the Permission, Description, and Preset Rules and also to
26			* link the dynamic events to check user permission.
27			*
28			* @author Brad Anderson <[email protected]>
29			* @package Prado\Security\Permissions
30			* @since 4.2.0
31			*/
32			class TPermissionEvent extends \Prado\TComponent
33			{
34			/** @var string permission */
35			private $_name;
36
37			/** @var string short description of the permission */
38			private $_description;
39
40			/** @var string[] dynamic events */
41			private $_events;
42
43			/** @var \Prado\Security\TAuthorizationRule[] the preset rules from the module */
44			private $_rules;
45
46			/**
47			* Constructs the class. All permission names are made lower case.
48			* @param string $permissionName the permission name linked to the dynamic events.
49			* @param string $description short description of the permission
50			* @param string\|string[] $events the events that the permission is linked.
51			* @param null\|Prado\Security\TAuthorizationRule[] $rules default rules from the module.
52			*/
53			public function __construct($permissionName = '', $description = '', $events = [], $rules = null)
54			{
55			$this->setName($permissionName);
56			$this->setDescription($description);
57			$this->setEvents($events);
58			$this->setRules($rules);
59			}
60
61			/**
62			* @return string the permission name
63			*/
64			public function getName()
65			{
66			return $this->_name;
67			}
68
69			/**
70			* @param string $permissionName the permission name
71			*/
72			public function setName($permissionName)
73			{
74			$this->_name = strtolower(TPropertyValue::ensureString($permissionName));
75			}
76
77			/**
78			* @return string the permission description
79			*/
80			public function getDescription()
81			{
82			return $this->_description;
83			}
84
85			/**
86			* @param string $description the permission description
87			*/
88			public function setDescription($description)
89			{
90			$this->_description = TPropertyValue::ensureString($description);
91			}
92
93			/**
94			* @return string[] the dynamic events tied to the permission
95			*/
96			public function getEvents()
97			{
98			return $this->_events;
99			}
100
101			/**
102			* this will take an array of string dynamic events, or a ',' comma separated
103			* list of dynamic events
104			* @param string\|string[] $events the dynamic events tied to the permission
105			*/
106			public function setEvents($events)
107			{
108			if (is_string($events)) {
109			$events = array_map('trim', explode(',', $events));
110			} elseif ($events !== null && !is_array($events)) {
			0 ignored issues – show introduced 2021-07-12 12:56 UTC by Report Bug Copy Issue Report The condition `is_array($events)` is always `true`. Loading history...
111			throw new TConfigurationException('permission_events_invalid', $events);
112			}
113			$this->_events = array_map('strtolower', array_filter($events ?? []));
114			}
115
116			/**
117			* these are the preset rules for when registering the permission name.
118			* @return \Prado\Security\TAuthorizationRule[] the preset permission rules
119			*/
120			public function getRules()
121			{
122			return $this->_rules;
123			}
124
125			/**
126			* these are the preset rules for when registering the permission name.
127			* @param null\|Prado\Security\TAuthorizationRule\|Prado\Security\TAuthorizationRule[] $rules the preset permission rules
			0 ignored issues – show Bug introduced 2021-07-15 11:25 UTC by Report Bug Copy Issue Report The type `Prado\Security\Permissio...rity\TAuthorizationRule` was not found. Did you mean `Prado\Security\TAuthorizationRule`? If so, make sure to prefix the type with `\`. Loading history...
128			*/
129			public function setRules($rules)
130			{
131			if ($rules instanceof TAuthorizationRule) {
132			$rules = [$rules];
133			}
134			if ($rules !== null && !is_array($rules)) {
			0 ignored issues – show introduced 2021-07-12 12:56 UTC by Report Bug Copy Issue Report The condition `is_array($rules)` is always `true`. Loading history...
135			throw new TConfigurationException('permission_rules_invalid', $rules);
136			}
137			$this->_rules = $rules ?? [];
138			}
139			}
140

pradosoft / prado

Push — master ( 5fd064...896ccb )

TPermissionEvent::getDescription() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like