arckinteractive / Roles

classes/Elgg/Roles/Api.php

Doc Comments +3 added lines, -3 removed lines

@@ -58,7 +58,7 @@ 
 	/**
 	 * Checks if the user has a specific role
 	 *
-	 * @param ElggUser $user User entity
+	 * @param ElggUser|null $user User entity
 	 * @return bool True if the user belongs to the passed role, false otherwise
 	 */
 	public function hasRole(ElggUser $user, $role_name = self::DEFAULT_ROLE) {
@@ -401,7 +401,7 @@ 
 
 	/**
 	 * Gets all reserved role names
-	 * @return array The list of reserved role names
+	 * @return string[] The list of reserved role names
 	 */
 	public function getReservedRoleNames() {
 		return array(self::DEFAULT_ROLE, self::ADMIN_ROLE, self::VISITOR_ROLE);
@@ -578,7 +578,7 @@ 
 	 * 
 	 * @param ElggRole $role   Role object
 	 * @param string   $action Registered action name
-	 * @return boolean|void
+	 * @return false|null
 	 */
 	function actionGatekeeper(\ElggRole $role, $action = '') {
 		$role_perms = $this->getPermissions($role, 'actions');

lib/roles.php

Doc Comments +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
  * 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

+ * @return ElggUser|null 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);

@@ -205,7 +205,7 @@ 
  *

  * @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

+ * @return boolean True if the rule matches the path, false otherwise

  */

 function roles_path_match($rule, $path) {

 	return roles()->matchPath($rule, $path);

start.php

Doc Comments +2 added lines, -2 removed lines

@@ -104,7 +104,7 @@ 
  * @param string  $action       The registered action name
  * @param boolean $return_value Return value
  * @param mixed   $params       An associative array of parameters provided by the hook trigger
- * @return boolean|void True if the action should be executed, false if it should be stopped
+ * @return null|false True if the action should be executed, false if it should be stopped
  */
 function roles_actions_permissions($hook_name, $action, $return_value, $params) {
 
@@ -237,7 +237,7 @@ 
  * @param string $entity_type  "user"
  * @param mixed  $return_value Return value
  * @param mixed  $params       An associative array of parameters provided by the hook trigger
- * @return void
+ * @return boolean|null
  */
 function roles_user_settings_save($hook_name, $entity_type, $return_value, $params) {
 	$role_name = get_input('role');