AlessandroMinoccheri / UserPermissions

src/Controller/Component/UserPermissionsComponent.php

Doc Comments +3 added lines

@@ -189,6 +189,9 @@
 		}
     }
 	
+	/**
+	 * @param string $controller
+	 */
 	private function checkForHandler($controller, $handler)
 	{
 		if(!method_exists($controller, $handler)) {

Unused Use Statements -4 removed lines

@@ -2,11 +2,7 @@
 namespace UserPermissions\Controller\Component;
 
 use Cake\Controller\Component;
-use Cake\Controller\ComponentRegistry;
-use Cake\Controller\Component\FlashComponent;
-use Cake\Datasource\ConnectionManager;
 use Cake\Log\Log;
-use Cake\ORM\TableRegistry;
 use UserPermissions\Exception\MissingHandlerException;
 
 class UserPermissionsComponent extends Component {

Indentation +97 added lines, -97 removed lines

@@ -11,40 +11,40 @@ 
 
 class UserPermissionsComponent extends Component {
 
-    /**
-     * Controller name
-     *
-     * @var string
-     */
+	/**
+	 * Controller name
+	 *
+	 * @var string
+	 */
 	public $controller = null;
 
-    /**
-     * Session
-     *
-     * @var string
-     */
+	/**
+	 * Session
+	 *
+	 * @var string
+	 */
 	public $session = null;
 
-    /**
-     * Components array
-     *
-     * @var array
-     */
+	/**
+	 * Components array
+	 *
+	 * @var array
+	 */
    	public $components = ['Flash'];
 
-    private $actions;
+	private $actions;
 
-    private $allow;
+	private $allow;
 
-    private $redirect;
+	private $redirect;
 
-    private $params;
+	private $params;
 
-    private $message;
+	private $message;
 
-    private $userType;
+	private $userType;
 
-    private $action;
+	private $action;
 	
 	/**
 	 * Boolean value which holds the configuration for the behavior in case of
@@ -52,23 +52,23 @@ 
 	 */
 	private $throwEx;
 
-    /**
-    * Initialization to get controller variable
-    *
-	* For this component available settings:
-	* 	bool throwEx - default false - if set to true, an exception will be
-	*		thrown, if a handler is about to be called but does not exist.
-	*
-    * @param array $config Configuration array for the component.
-    */
-    public function initialize(array $config)
-    {
-        parent::initialize($config);
+	/**
+	 * Initialization to get controller variable
+	 *
+	 * For this component available settings:
+	 * 	bool throwEx - default false - if set to true, an exception will be
+	 *		thrown, if a handler is about to be called but does not exist.
+	 *
+	 * @param array $config Configuration array for the component.
+	 */
+	public function initialize(array $config)
+	{
+		parent::initialize($config);
         
-        $this->controller = $this->_registry->getController();
-        $this->session = $this->controller->request->session();
+		$this->controller = $this->_registry->getController();
+		$this->session = $this->controller->request->session();
 
-        $this->actions 		= array();
+		$this->actions 		= array();
 		$this->allow 		= true;
 		$this->redirect 	= '';
 		$this->params 		= '';
@@ -76,56 +76,56 @@ 
 		$this->userType 	= '';
 		$this->action   	= null;
 		$this->throwEx      = isset($config["throwEx"]) && $config["throwEx"];
-    }
-
-    /**
-    * Initialization to get controller variable
-    *
-    * @param array $rules Array of rules for permissions.
-    * @return bool false if user / group doesn't have permission, true if has permission
-    */
-    public function allow ($rules) {
-    	$this->setUserValues();
-    	$this->bindConfiguration($rules);
+	}
+
+	/**
+	 * Initialization to get controller variable
+	 *
+	 * @param array $rules Array of rules for permissions.
+	 * @return bool false if user / group doesn't have permission, true if has permission
+	 */
+	public function allow ($rules) {
+		$this->setUserValues();
+		$this->bindConfiguration($rules);
 
 		if (!$this->applyGroupsRules($rules)) {
 			$this->applyViewsRules($rules);
 		}
 
 		return $this->allow;
-    }
+	}
 
-    private function setUserValues()
-    {
-    	$userId = $this->session->read('Auth.User.id');
+	private function setUserValues()
+	{
+		$userId = $this->session->read('Auth.User.id');
 
-    	if (!isset($userId)) {
+		if (!isset($userId)) {
 			$this->userType = 'guest';
 		}
-    }
+	}
 
-    private function bindConfiguration(array $rules) 
-    {
-    	foreach($rules as $key => $value){
+	private function bindConfiguration(array $rules) 
+	{
+		foreach($rules as $key => $value){
 			switch($key){
 				case "user_type":
-			        $this->userType = $value;
-			        break;
-			    case "redirect":
-			        $this->redirect = $value;
-			        break;
-			    case "action":
-			        $this->action = $value;
-			        break;
-			    case "controller":
-			        $this->controller = $value;
+					$this->userType = $value;
+					break;
+				case "redirect":
+					$this->redirect = $value;
+					break;
+				case "action":
+					$this->action = $value;
+					break;
+				case "controller":
+					$this->controller = $value;
 					if(!is_object($value)) {
 						Log::write("warning", sprintf("controller is not an object (%s)", gettype($value)));
 					}
-			        break;
-			    case "message":
-			        $this->message = $value;
-			        break;
+					break;
+				case "message":
+					$this->message = $value;
+					break;
 			}
 		}
 
@@ -136,56 +136,56 @@ 
 				}
 			}
 		}
-    }
+	}
 
-    private function applyGroupsRules(array $rules)
-    {
-    	$existRulesForGroups = false;
+	private function applyGroupsRules(array $rules)
+	{
+		$existRulesForGroups = false;
 
-    	if(isset($rules['groups'])){
+		if(isset($rules['groups'])){
 			foreach($rules['groups'] as $key => $value){
 				$this->searchForApplyGroupRules($key, $value);
 			}
 		}
 
 		return $existRulesForGroups;
-    }
+	}
 
-    private function searchForApplyGroupRules($key)
-    {
-    	if($key == $this->userType){
-    		if ($this->notInArrayAction()) {
+	private function searchForApplyGroupRules($key)
+	{
+		if($key == $this->userType){
+			if ($this->notInArrayAction()) {
 				$this->redirectIfIsSet();
 				
 				$this->allow = false;
 			}
 		}
-    }
+	}
 
-    private function notInArrayAction()
-    {
-    	return ((!in_array('*', $this->actions)) && (!in_array($this->action, $this->actions)));
-    }
+	private function notInArrayAction()
+	{
+		return ((!in_array('*', $this->actions)) && (!in_array($this->action, $this->actions)));
+	}
 
-    private function applyViewsRules(array $rules)
-    {
-    	if(isset($rules['views'])){
+	private function applyViewsRules(array $rules)
+	{
+		if(isset($rules['views'])){
 			foreach($rules['views'] as $key => $value){
 				$this->searchForApplyViewRules($key, $value);
 			}
 		}
-    }
+	}
 
-    private function searchForApplyViewRules($key, $value)
-    {
-    	if($key == $this->action) {
+	private function searchForApplyViewRules($key, $value)
+	{
+		if($key == $this->action) {
 			if(!$this->checkForHandler($this->controller, $value) || !$this->controller->$value()){
 				$this->redirectIfIsSet();
 				
 				$this->allow = false;
 			}
 		}
-    }
+	}
 	
 	private function checkForHandler($controller, $handler)
 	{
@@ -206,9 +206,9 @@ 
 		return true;
 	}
 
-    private function redirectIfIsSet()
-    {
-    	if($this->redirect != ''){
+	private function redirectIfIsSet()
+	{
+		if($this->redirect != ''){
 			if($this->message != ''){
 				$this->Flash->set($this->message);
 			}

Spacing +22 added lines, -22 removed lines

@@ -68,14 +68,14 @@ 
         $this->controller = $this->_registry->getController();
         $this->session = $this->controller->request->session();
 
-        $this->actions 		= array();
-		$this->allow 		= true;
+        $this->actions = array();
+		$this->allow = true;
 		$this->redirect 	= '';
-		$this->params 		= '';
+		$this->params = '';
 		$this->message 		= '';
 		$this->userType 	= '';
 		$this->action   	= null;
-		$this->throwEx      = isset($config["throwEx"]) && $config["throwEx"];
+		$this->throwEx = isset($config["throwEx"]) && $config["throwEx"];
     }
 
     /**
@@ -84,7 +84,7 @@ 
     * @param array $rules Array of rules for permissions.
     * @return bool false if user / group doesn't have permission, true if has permission
     */
-    public function allow ($rules) {
+    public function allow($rules) {
     	$this->setUserValues();
     	$this->bindConfiguration($rules);
 
@@ -106,8 +106,8 @@ 
 
     private function bindConfiguration(array $rules) 
     {
-    	foreach($rules as $key => $value){
-			switch($key){
+    	foreach ($rules as $key => $value) {
+			switch ($key) {
 				case "user_type":
 			        $this->userType = $value;
 			        break;
@@ -119,7 +119,7 @@ 
 			        break;
 			    case "controller":
 			        $this->controller = $value;
-					if(!is_object($value)) {
+					if (!is_object($value)) {
 						Log::write("warning", sprintf("controller is not an object (%s)", gettype($value)));
 					}
 			        break;
@@ -129,9 +129,9 @@ 
 			}
 		}
 
-		foreach($rules['groups']  as $key => $value){
-			if($key == $this->userType){
-				foreach($value as $v){
+		foreach ($rules['groups']  as $key => $value) {
+			if ($key == $this->userType) {
+				foreach ($value as $v) {
 					array_push($this->actions, $v);
 				}
 			}
@@ -142,8 +142,8 @@ 
     {
     	$existRulesForGroups = false;
 
-    	if(isset($rules['groups'])){
-			foreach($rules['groups'] as $key => $value){
+    	if (isset($rules['groups'])) {
+			foreach ($rules['groups'] as $key => $value) {
 				$this->searchForApplyGroupRules($key, $value);
 			}
 		}
@@ -153,7 +153,7 @@ 
 
     private function searchForApplyGroupRules($key)
     {
-    	if($key == $this->userType){
+    	if ($key == $this->userType) {
     		if ($this->notInArrayAction()) {
 				$this->redirectIfIsSet();
 				
@@ -169,8 +169,8 @@ 
 
     private function applyViewsRules(array $rules)
     {
-    	if(isset($rules['views'])){
-			foreach($rules['views'] as $key => $value){
+    	if (isset($rules['views'])) {
+			foreach ($rules['views'] as $key => $value) {
 				$this->searchForApplyViewRules($key, $value);
 			}
 		}
@@ -178,8 +178,8 @@ 
 
     private function searchForApplyViewRules($key, $value)
     {
-    	if($key == $this->action) {
-			if(!$this->checkForHandler($this->controller, $value) || !$this->controller->$value()){
+    	if ($key == $this->action) {
+			if (!$this->checkForHandler($this->controller, $value) || !$this->controller->$value()) {
 				$this->redirectIfIsSet();
 				
 				$this->allow = false;
@@ -189,7 +189,7 @@ 
 	
 	private function checkForHandler($controller, $handler)
 	{
-		if(!method_exists($controller, $handler)) {
+		if (!method_exists($controller, $handler)) {
 			$msg = sprintf(
 				"Controller %s=%s has no method called '%s'",
 				is_object($controller) ? "class" : "type",
@@ -197,7 +197,7 @@ 
 				$handler
 			);
 			Log::write("debug", $msg);
-			if($this->throwEx) {
+			if ($this->throwEx) {
 				throw new MissingHandlerException($msg);
 			}
 			return false;
@@ -208,8 +208,8 @@ 
 
     private function redirectIfIsSet()
     {
-    	if($this->redirect != ''){
-			if($this->message != ''){
+    	if ($this->redirect != '') {
+			if ($this->message != '') {
 				$this->Flash->set($this->message);
 			}