ElggRole::getReservedRoleNames() - Code Metrics - arckinteractive/Roles - Measure and Improve Code Quality continuously with Scrutinizer

ElggRole::getReservedRoleNames() A
last analyzed 2017-05-27 07:36 UTC

↳ Parent: ElggRole

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	0
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

/**
 * Class to implement Role objects
 * 
 * @package Roles
 * @author Andras Szepeshazi
 * @copyright Arck Interactive, LLC 2012
 * @link http://www.arckinteractive.com/
 *
 * @property string   $name        Role name
 * @property string   $title       Human readable role title
 */
class ElggRole extends ElggObject {
namespace YourVendor;

class YourClass { }

	/**
	 * Protected permissions metadata
	 * @var string
	 */
	protected $permissions;

	/**
	 * Protected extends metdata
	 * @var string[]
	 */
	protected $extends;

	/**
	 * {@inheritdoc}
	 */
	protected function initializeAttributes() {
		parent::initializeAttributes();

		$this->attributes['subtype'] = "role";
	}

	/**
	 * {@inheritdoc}
	 */
	public function getDisplayName() {
		return elgg_echo($this->title);
	}

	/**
	 * Sets role permissions
	 * @return void
	 */
	public function setPermissions($permissions = array()) {
		$this->setMetadata('permissions', serialize($permissions));
	}

	/**
	 * Returns an array of permissions for this role
	 * @return array
	 */
	public function getPermissions() {
		$permissions = unserialize($this->getMetadata('permissions'));
		if (!is_array($permissions)) {
			return array();
		}
		foreach ($permissions as $type => $rules) {
			if (!is_array($rules)) {
				continue;
			}
			foreach ($rules as $name => $opts) {
				if (is_string($opts)) {
					$permissions[$type][$name] = array('rule' => $opts);
				}
			}
		}
		return $permissions;
	}

	/**
	 * Set extends
	 * @param string[] $extends
	 * @return void
	 */
	public function setExtends($extends = array()) {
		$this->setMetadata('extends', $extends);
	}

	/**
	 * Get extends
	 * @return string[]
	 */
	public function getExtends() {
		return (array) $this->getMetadata('extends');
	}

	/**
	 * Gets all reserved role names
	 * @return array The list of reserved role names
	 * @deprecated 2.0
	 */
	public static function getReservedRoleNames() {
		return roles()->getReservedRoleNames();
	}

	/**
	 * 
	 * Checks if a role name is reserved in the system
	 * 
	 * @param string $role_name The name of the role to check
	 * @return boolean True if the passed $role_name is a reserved role name
	 * @deprecated 2.0
	 */
	public static function isReservedRoleName($role_name) {
		return roles()->isReservedRoleName($role_name);
	}

	/**
	 * 
	 * Checks if this role is a reserved role
	 * @return boolean True if the current role is a reserved role
	 */
	public function isReservedRole() {
		return roles()->isReservedRoleName($this->name);
	}

	/**
	 * Obtain the list of users for the current role object
	 *
	 * @param array $options An array of $key => $value pairs accepted by {@link elgg_get_entities()}
	 * @return ElggUser[]|false The array of users having this role, false if no user found
	 */
	public function getUsers($options) {

		switch ($this->name) {
			case DEFAULT_ROLE :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
				$dbprefix = elgg_get_config('dbprefix');
				$defaults = array(
					'type' => 'user',
					'joins' => array(
						"INNER JOIN {$dbprefix}users_entity u ON (u.guid = e.guid)",
						"LEFT JOIN {$dbprefix}entity_relationships r ON (r.guid_one = e.guid AND r.relationship = 'has_role')",
					),
					'wheres' => array(
						'r.guid_two IS NULL',
						'u.admin = "no"'
					)
				);
				$options = array_merge($defaults, $options);
				$users = elgg_get_entities($options);
				break;
			case ADMIN_ROLE :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
				$dbprefix = elgg_get_config('dbprefix');
				$defaults = array(
					'type' => 'user',
					'joins' => array(
						"INNER JOIN {$dbprefix}users_entity u ON (u.guid = e.guid)",
						"LEFT JOIN {$dbprefix}entity_relationships r ON (r.guid_one = e.guid AND r.relationship = 'has_role')",
					),
					'wheres' => array(
						'r.guid_two IS NULL',
						'u.admin = "yes"'
					)
				);
				$options = array_merge($defaults, $options);
				$users = elgg_get_entities($options);
				break;
			default :
switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}
				$defaults = array(
					'type' => 'user',
					'relationship' => 'has_role',
					'relationship_guid' => $this->get('guid'),
					'inverse_relationship' => true
				);
				$options = array_merge($defaults, $options);
				$users = elgg_get_entities_from_relationship($options);
				break;
		}

		return $users;
	}

}


1			<?php
2
3			/**
4			* Class to implement Role objects
5			*
6			* @package Roles
7			* @author Andras Szepeshazi
8			* @copyright Arck Interactive, LLC 2012
9			* @link http://www.arckinteractive.com/
10			*
11			* @property string $name Role name
12			* @property string $title Human readable role title
13			*/
14			class ElggRole extends ElggObject {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
15
16			/**
17			* Protected permissions metadata
18			* @var string
19			*/
20			protected $permissions;
21
22			/**
23			* Protected extends metdata
24			* @var string[]
25			*/
26			protected $extends;
27
28			/**
29			* {@inheritdoc}
30			*/
31	27		protected function initializeAttributes() {
32	27		parent::initializeAttributes();
33
34	27		$this->attributes['subtype'] = "role";
35	27		}
36
37			/**
38			* {@inheritdoc}
39			*/
40			public function getDisplayName() {
41			return elgg_echo($this->title);
42			}
43
44			/**
45			* Sets role permissions
46			* @return void
47			*/
48	27		public function setPermissions($permissions = array()) {
49	27		$this->setMetadata('permissions', serialize($permissions));
50	27		}
51
52			/**
53			* Returns an array of permissions for this role
54			* @return array
55			*/
56	24		public function getPermissions() {
57	24		$permissions = unserialize($this->getMetadata('permissions'));
58	24		if (!is_array($permissions)) {
59			return array();
60			}
61	24		foreach ($permissions as $type => $rules) {
62	24		if (!is_array($rules)) {
63			continue;
64			}
65	24		foreach ($rules as $name => $opts) {
66	24		if (is_string($opts)) {
67	24		$permissions[$type][$name] = array('rule' => $opts);
68	24		}
69	24		}
70	24		}
71	24		return $permissions;
72			}
73
74			/**
75			* Set extends
76			* @param string[] $extends
77			* @return void
78			*/
79	27		public function setExtends($extends = array()) {
80	27		$this->setMetadata('extends', $extends);
81	27		}
82
83			/**
84			* Get extends
85			* @return string[]
86			*/
87	24		public function getExtends() {
88	24		return (array) $this->getMetadata('extends');
89			}
90
91			/**
92			* Gets all reserved role names
93			* @return array The list of reserved role names
94			* @deprecated 2.0
95			*/
96			public static function getReservedRoleNames() {
97			return roles()->getReservedRoleNames();
98			}
99
100			/**
101			*
102			* Checks if a role name is reserved in the system
103			*
104			* @param string $role_name The name of the role to check
105			* @return boolean True if the passed $role_name is a reserved role name
106			* @deprecated 2.0
107			*/
108			public static function isReservedRoleName($role_name) {
109			return roles()->isReservedRoleName($role_name);
110			}
111
112			/**
113			*
114			* Checks if this role is a reserved role
115			* @return boolean True if the current role is a reserved role
116			*/
117	2		public function isReservedRole() {
118	2		return roles()->isReservedRoleName($this->name);
119			}
120
121			/**
122			* Obtain the list of users for the current role object
123			*
124			* @param array $options An array of $key => $value pairs accepted by {@link elgg_get_entities()}
125			* @return ElggUser[]\|false The array of users having this role, false if no user found
126			*/
127			public function getUsers($options) {
128
129			switch ($this->name) {
130		View Code Duplication	case DEFAULT_ROLE :
			0 ignored issues – show Duplication introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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... Coding Style introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
131			$dbprefix = elgg_get_config('dbprefix');
132			$defaults = array(
133			'type' => 'user',
134			'joins' => array(
135			"INNER JOIN {$dbprefix}users_entity u ON (u.guid = e.guid)",
136			"LEFT JOIN {$dbprefix}entity_relationships r ON (r.guid_one = e.guid AND r.relationship = 'has_role')",
137			),
138			'wheres' => array(
139			'r.guid_two IS NULL',
140			'u.admin = "no"'
141			)
142			);
143			$options = array_merge($defaults, $options);
144			$users = elgg_get_entities($options);
145			break;
146		View Code Duplication	case ADMIN_ROLE :
			0 ignored issues – show Duplication introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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... Coding Style introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
147			$dbprefix = elgg_get_config('dbprefix');
148			$defaults = array(
149			'type' => 'user',
150			'joins' => array(
151			"INNER JOIN {$dbprefix}users_entity u ON (u.guid = e.guid)",
152			"LEFT JOIN {$dbprefix}entity_relationships r ON (r.guid_one = e.guid AND r.relationship = 'has_role')",
153			),
154			'wheres' => array(
155			'r.guid_two IS NULL',
156			'u.admin = "yes"'
157			)
158			);
159			$options = array_merge($defaults, $options);
160			$users = elgg_get_entities($options);
161			break;
162			default :
			0 ignored issues – show Coding Style introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a DEFAULT statement As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement. switch ($expr) { default : //wrong doSomething(); break; } switch ($expr) { default: //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
163			$defaults = array(
164			'type' => 'user',
165			'relationship' => 'has_role',
166			'relationship_guid' => $this->get('guid'),
167			'inverse_relationship' => true
168			);
169			$options = array_merge($defaults, $options);
170			$users = elgg_get_entities_from_relationship($options);
171			break;
172			}
173
174			return $users;
175			}
176
177			}
178

arckinteractive / Roles

ElggRole::getReservedRoleNames() A last analyzed 2017-05-27 07:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ElggRole::getReservedRoleNames() A
last analyzed 2017-05-27 07:36 UTC