roles.php ➔ roles_set_role() - Code Metrics - Inspection of "fix(roles): remove has_role relationships individu..." - arckinteractive/Roles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

by Ismayil

created 2016-05-06 17:59 UTC

roles.php ➔ roles_set_role() A

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	6
Bugs	1	Features	1

Metric	Value
cc	4
eloc	5
c	6
b	1
f	1
nc	4
nop	2
dl	0
loc	7
rs	9.2

<?php

use Elgg\Roles\Api;

/**
 * Roles library functions
 *
 * @package Roles
 * @author Andras Szepeshazi
 * @copyright Arck Interactive, LLC 2012
 * @link http://www.arckinteractive.com/
 */

/**
 * Obtains the role of a given user
 *
 * @param ElggUser $user User entity
 * @return ElggRole The role the user belongs to
 */
function roles_get_role($user = null) {
	$user = isset($user) ? $user : elgg_get_logged_in_user_entity();
	if ($user instanceof ElggUser) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
		return roles()->getRole($user);
	}
	return roles()->getRoleByName(roles()->filterName(Api::NO_ROLE));
}

/**
 * Checks if the user has a specific role
 *
 * @param ElggUser $user
 * @return bool True if the user belongs to the passed role, false otherwise
 */
function roles_has_role($user = null, $role_name = DEFAULT_ROLE) {
	return roles()->hasRole($user, $role_name);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
}

/**
 * Assigns a role to a particular user
 *
 * @param ElggRole $role The role to be assigned
 * @param ElggUser $user The user the role needs to be assigned to
 * @return bool|void True if the role change was successful, false if could not update user role, and null if there was no change in user role
 */
function roles_set_role($role, $user = null) {
	$user = isset($user) ? $user : elgg_get_logged_in_user_entity();
	if ($user instanceof ElggUser && $role instanceof ElggRole) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
		return roles()->setRole($user, $role);
	}
	return false;
}

/**
 * Gets all role objects
 * @return ElggRole[]|false An array of ElggRole objects defined in the system, or false if none found
 */
function roles_get_all_roles() {
	return roles()->getAll();
}

/**
 * Gets all non-default role objects
 *
 * This is used by the role selector view. Default roles (VISITOR_ROLE, ADMIN_ROLE, DEFAULT_ROLE) need to be omitted from
 * the list of selectable roles - as default roles are automatically assigned to users based on their Elgg membership type
 * 
 * @return ElggRole[]|false An array of non-default ElggRole objects defined in the system, or false if none found
 */
function roles_get_all_selectable_roles() {
	return roles()->getSelectable();
}

/**
 * Obtains a list of permissions associated with a particular role object
 *
 * @param ElggRole $role            The role to check for permissions
 * @param string   $permission_type The section from the configuration array ('actions', 'menus', 'views', etc.)
 * @return array The permission rules for the given role and permission type
 */
function roles_get_role_permissions($role = null, $permission_type = null) {
	$role = isset($role) ? $role : roles_get_role();
	return roles()->getPermissions($role, $permission_type);
}

/**
 * Caches permissions associated with a role object. Also resolves all role extensions.
 *
 * @param ElggRole $role The role to cache permissions for
 * @return void
 */
function roles_cache_permissions($role) {
	return roles()->cachePermissions($role);
}

/**
 * Gets a role object based on it's name
 *
 * @param string $role_name The name of the role
 * @return ElggRole|false An ElggRole object if it could be found based on the name, false otherwise
 */
function roles_get_role_by_name($role_name) {
	return roles()->getRoleByName($role_name);
}

/**
 * Resolves the default role for specified or currently logged in user
 *
 * @param string $role_name The name of the user's role
 * @param int    $user_guid GUID of the user whose default role needs to be resolved
 * @return string
 */
function roles_filter_role_name($role_name, $user_guid = null) {
	if (!isset($user_guid)) {
		$user_guid = elgg_get_logged_in_user_guid();
	}
	return roles()->filterName($role_name, get_entity($user_guid) ? : null);
}

/**
 * Processes the configuration files and generates the appropriate ElggRole objects.
 *
 * If, for any role definition, there is an already existing role with the same name,
 * the role permissions will be updated for the given role object.
 * If there is no previously existing, corresponding role object, it will be created now.
 *
 * @param array $roles_array The roles configuration array
 * @return void
 */
function roles_create_from_config($roles_array) {
	return roles()->createFromConfig($roles_array);
}

/**
 * Checks if the configuration array has been updated and updates role objects accordingly if needed
 * @return void
 */
function roles_check_update() {
	return roles()->checkUpdate();
}

/**
 * @deprecated 2.0
 */
function roles_unregister_menu_item() {
	
}

/**
 * @deprecated 2.0
 */
function roles_replace_menu_item() {

}

/**
 * @deprecated 2.0
 */
function roles_unregister_menu_item_recursive() {
	
}

/**
 * @deprecated 2.0
 */
function roles_replace_menu_item_recursive() {
	
}

/**
 * @deprecated 2.0
 */
function roles_find_menu_index() {
	
}

/**
 * Substitutes dynamic parts of a menu's target URL
 *
 * @param array $vars An associative array holding the menu permissions
 * @return The substituted menu permission array
 */
function roles_prepare_menu_vars($vars) {
	return roles()->prepareMenuVars($vars);
}

/**
 * @deprecated 2.0
 */
function roles_get_menu($menu_name) {

	
}

/**
 * Replaces certain parts of path and URL type definitions with dynamic values
 *
 * @param string $str The string to operate on
 * @return string The updated, substituted string
 */
function roles_replace_dynamic_paths($str) {
	return roles()->replaceDynamicPaths($str);
}

/**
 * Checks if a path or URL type rule matches a given path. Also processes regular expressions
 *
 * @param string $rule The permission rule to check
 * @param string $path The path to match against
 * @return boole True if the rule matches the path, false otherwise
 */
function roles_path_match($rule, $path) {
	return roles()->matchPath($rule, $path);
}

/**
 * Checks if a permission rule should be executed for the current context
 *
 * @param string  $permission_details The permission rule configuration
 * @param boolean $strict             If strict context matching should be used.
 * 							          If true, only the last context will be checked for the rule matching.
 * 							          If false, any context value in the context stack will be considered.
 * @return bool True if the rule should be executed, false otherwise
 */
function roles_check_context($permission_details, $strict = false) {
	return roles()->checkContext($permission_details, $strict);
}

/**
 * Updates roles objects to 1.0.1 version
 * @return bool
 */
function roles_update_100_to_101() {

	// Remove all 'roles_hash' values from plugin settings
	// This will force new storage of the configuration array hash
	$dbprefix = elgg_get_config('dbprefix');
	$statement = "DELETE from {$dbprefix}private_settings WHERE name = 'roles_hash'";
	return delete_data($statement);
}


Pull Request — master (#20)

roles.php ➔ roles_set_role() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			use Elgg\Roles\Api;
4
5			/**
6			* Roles library functions
7			*
8			* @package Roles
9			* @author Andras Szepeshazi
10			* @copyright Arck Interactive, LLC 2012
11			* @link http://www.arckinteractive.com/
12			*/
13
14			/**
15			* Obtains the role of a given user
16			*
17			* @param ElggUser $user User entity
18			* @return ElggRole The role the user belongs to
19			*/
20			function roles_get_role($user = null) {
21			$user = isset($user) ? $user : elgg_get_logged_in_user_entity();
22			if ($user instanceof ElggUser) {
			0 ignored issues – show Bug introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report The class `ElggUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
23			return roles()->getRole($user);
24			}
25			return roles()->getRoleByName(roles()->filterName(Api::NO_ROLE));
26			}
27
28			/**
29			* Checks if the user has a specific role
30			*
31			* @param ElggUser $user
32			* @return bool True if the user belongs to the passed role, false otherwise
33			*/
34			function roles_has_role($user = null, $role_name = DEFAULT_ROLE) {
35			return roles()->hasRole($user, $role_name);
			0 ignored issues – show Bug introduced 2016-05-06 18:05 UTC by Report Bug Copy Issue Report It seems like `$user` defined by parameter `$user` on line `34` can be `null`; however, `Elgg\Roles\Api::hasRole()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
36			}
37
38			/**
39			* Assigns a role to a particular user
40			*
41			* @param ElggRole $role The role to be assigned
42			* @param ElggUser $user The user the role needs to be assigned to
43			* @return bool\|void True if the role change was successful, false if could not update user role, and null if there was no change in user role
44			*/
45			function roles_set_role($role, $user = null) {
46			$user = isset($user) ? $user : elgg_get_logged_in_user_entity();
47			if ($user instanceof ElggUser && $role instanceof ElggRole) {
			0 ignored issues – show Bug introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report The class `ElggUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
48			return roles()->setRole($user, $role);
49			}
50			return false;
51			}
52
53			/**
54			* Gets all role objects
55			* @return ElggRole[]\|false An array of ElggRole objects defined in the system, or false if none found
56			*/
57			function roles_get_all_roles() {
58			return roles()->getAll();
59			}
60
61			/**
62			* Gets all non-default role objects
63			*
64			* This is used by the role selector view. Default roles (VISITOR_ROLE, ADMIN_ROLE, DEFAULT_ROLE) need to be omitted from
65			* the list of selectable roles - as default roles are automatically assigned to users based on their Elgg membership type
66			*
67			* @return ElggRole[]\|false An array of non-default ElggRole objects defined in the system, or false if none found
68			*/
69			function roles_get_all_selectable_roles() {
70			return roles()->getSelectable();
71			}
72
73			/**
74			* Obtains a list of permissions associated with a particular role object
75			*
76			* @param ElggRole $role The role to check for permissions
77			* @param string $permission_type The section from the configuration array ('actions', 'menus', 'views', etc.)
78			* @return array The permission rules for the given role and permission type
79			*/
80			function roles_get_role_permissions($role = null, $permission_type = null) {
81			$role = isset($role) ? $role : roles_get_role();
82			return roles()->getPermissions($role, $permission_type);
83			}
84
85			/**
86			* Caches permissions associated with a role object. Also resolves all role extensions.
87			*
88			* @param ElggRole $role The role to cache permissions for
89			* @return void
90			*/
91			function roles_cache_permissions($role) {
92			return roles()->cachePermissions($role);
93			}
94
95			/**
96			* Gets a role object based on it's name
97			*
98			* @param string $role_name The name of the role
99			* @return ElggRole\|false An ElggRole object if it could be found based on the name, false otherwise
100			*/
101			function roles_get_role_by_name($role_name) {
102			return roles()->getRoleByName($role_name);
103			}
104
105			/**
106			* Resolves the default role for specified or currently logged in user
107			*
108			* @param string $role_name The name of the user's role
109			* @param int $user_guid GUID of the user whose default role needs to be resolved
110			* @return string
111			*/
112			function roles_filter_role_name($role_name, $user_guid = null) {
113			if (!isset($user_guid)) {
114			$user_guid = elgg_get_logged_in_user_guid();
115			}
116			return roles()->filterName($role_name, get_entity($user_guid) ? : null);
117			}
118
119			/**
120			* Processes the configuration files and generates the appropriate ElggRole objects.
121			*
122			* If, for any role definition, there is an already existing role with the same name,
123			* the role permissions will be updated for the given role object.
124			* If there is no previously existing, corresponding role object, it will be created now.
125			*
126			* @param array $roles_array The roles configuration array
127			* @return void
128			*/
129			function roles_create_from_config($roles_array) {
130			return roles()->createFromConfig($roles_array);
131			}
132
133			/**
134			* Checks if the configuration array has been updated and updates role objects accordingly if needed
135			* @return void
136			*/
137			function roles_check_update() {
138			return roles()->checkUpdate();
139			}
140
141			/**
142			* @deprecated 2.0
143			*/
144			function roles_unregister_menu_item() {
145
146			}
147
148			/**
149			* @deprecated 2.0
150			*/
151			function roles_replace_menu_item() {
152
153			}
154
155			/**
156			* @deprecated 2.0
157			*/
158			function roles_unregister_menu_item_recursive() {
159
160			}
161
162			/**
163			* @deprecated 2.0
164			*/
165			function roles_replace_menu_item_recursive() {
166
167			}
168
169			/**
170			* @deprecated 2.0
171			*/
172			function roles_find_menu_index() {
173
174			}
175
176			/**
177			* Substitutes dynamic parts of a menu's target URL
178			*
179			* @param array $vars An associative array holding the menu permissions
180			* @return The substituted menu permission array
181			*/
182			function roles_prepare_menu_vars($vars) {
183			return roles()->prepareMenuVars($vars);
184			}
185
186			/**
187			* @deprecated 2.0
188			*/
189			function roles_get_menu($menu_name) {
			0 ignored issues – show Unused Code introduced 2015-11-28 10:16 UTC by Report Bug Copy Issue Report The parameter `$menu_name` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
190
191			}
192
193			/**
194			* Replaces certain parts of path and URL type definitions with dynamic values
195			*
196			* @param string $str The string to operate on
197			* @return string The updated, substituted string
198			*/
199			function roles_replace_dynamic_paths($str) {
200			return roles()->replaceDynamicPaths($str);
201			}
202
203			/**
204			* Checks if a path or URL type rule matches a given path. Also processes regular expressions
205			*
206			* @param string $rule The permission rule to check
207			* @param string $path The path to match against
208			* @return boole True if the rule matches the path, false otherwise
209			*/
210			function roles_path_match($rule, $path) {
211			return roles()->matchPath($rule, $path);
212			}
213
214			/**
215			* Checks if a permission rule should be executed for the current context
216			*
217			* @param string $permission_details The permission rule configuration
218			* @param boolean $strict If strict context matching should be used.
219			* If true, only the last context will be checked for the rule matching.
220			* If false, any context value in the context stack will be considered.
221			* @return bool True if the rule should be executed, false otherwise
222			*/
223			function roles_check_context($permission_details, $strict = false) {
224			return roles()->checkContext($permission_details, $strict);
225			}
226
227			/**
228			* Updates roles objects to 1.0.1 version
229			* @return bool
230			*/
231			function roles_update_100_to_101() {
232
233			// Remove all 'roles_hash' values from plugin settings
234			// This will force new storage of the configuration array hash
235			$dbprefix = elgg_get_config('dbprefix');
236			$statement = "DELETE from {$dbprefix}private_settings WHERE name = 'roles_hash'";
237			return delete_data($statement);
238			}
239

arckinteractive / Roles

Pull Request — master (#20)

roles.php ➔ roles_set_role() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like