Samshal / Acl

src/Acl.php

Doc Comments +4 added lines, -4 removed lines

@@ -144,7 +144,7 @@ 
 	 * @param string $permission
 	 * @param string[] $args
 	 * @throws \Exception
-	 * @return void
+	 * @return boolean|null
 	 */
 	public function __call(string $permission, array $args)
 	{
@@ -192,7 +192,7 @@ 
 	/**
 	 * Add a new role object to the registry
 	 *
-	 * @param string $role
+	 * @param string[] $role
 	 * @return void
 	 */
 	public function addRole(string ...$role)
@@ -206,7 +206,7 @@ 
 	/**
 	 * Add a new resource object to the registry
 	 *
-	 * @param string $resource
+	 * @param string[] $resource
 	 * @return void
 	 */
 	public function addResource(string ...$resource)
@@ -237,7 +237,7 @@ 
 	 * Automatically determine the type of an object and call the appropriate
 	 * add method on it.
 	 *
-	 * @param ObjectInterface $objects
+	 * @param ObjectInterface[] $objects
 	 * @throws \Exception
 	 * @return void
 	 */

Indentation +251 added lines, -251 removed lines

@@ -9,20 +9,20 @@ 
 namespace Samshal\Acl;
 
 use Samshal\Acl\Role\{
-	DefaultRole as Role,
-	RoleInterface
+    DefaultRole as Role,
+    RoleInterface
 };
 use Samshal\Acl\Resource\{
-	DefaultResource as Resource,
-	ResourceInterface
+    DefaultResource as Resource,
+    ResourceInterface
 };
 use Samshal\Acl\Permission\{
-	DefaultPermission as Permission,
-	PermissionInterface
+    DefaultPermission as Permission,
+    PermissionInterface
 };
 use Samshal\Acl\Registry\{
-	GlobalRegistry,
-	Registry
+    GlobalRegistry,
+    Registry
 };
 
 
@@ -35,96 +35,96 @@ 
  */
 class Acl implements AclInterface
 {
-	/**
-	 * @var Registry\RegistryInterface $roleRegistry
-	 */
-	public $roleRegistry;
-
-	/**
-	 * @var Registry\RegistryInterface $resourceRegistry
-	 */
-	protected $resourceRegistry;
-
-	/**
-	 * @var Registry\RegistryInterface $permissionRegistry
-	 */
-	protected $permissionRegistry;
-
-	/**
-	 * @var Registry\RegistryInterface $globalRegistry
-	 */
-	public $globalRegistry;
-
-	/**
-	 *  @var string[] $sesion
-	 */
-	protected $session = [];
-
-	/**
-	 * @var string SYN_ALLOW
-	 */
-	const SYN_ALLOW = "can";
-
-	/**
-	 * @var string SYN_DENY
-	 */
-	const SYN_DENY = "cannot";
-
-	/**
-	 * Performs bootstrapping
-	 */
-	public function __construct()
-	{
-		self::initRegistries();
-		self::initSession();
-	}
-
-	/**
-	 * Initalizes the registries
-	 *
-	 * @return void
-	 */
-	protected function initRegistries()
-	{
-		$this->roleRegistry = new Registry();
-		$this->resourceRegistry = new Registry();
-		$this->permissionRegistry = new Registry();
-		$this->globalRegistry = new GlobalRegistry();
-	}
-
-	/**
-	 * Initializes the global session array and sets them to the default value
-	 *
-	 * @return void
-	 */
-	protected function initSession()
-	{
-		$this->session["query"] = true;
-		unset($this->session["role"], $this->session["status"]);
-	}
-
-	/**
-	 * Listen for and intercept properties that're not set
-	 *
-	 * @param string $role;
-	 * @throws \Exception
-	 * @return AclInterface
-	 */
-	public function __get(string $role) : AclInterface
-	{
-		if ($role === self::SYN_ALLOW || $role === self::SYN_DENY)
-		{
-			$this->session["status"] = ($role === self::SYN_ALLOW);
-
-			if (!empty($this->session["role"]))
-			{
-				$this->session["query"] = false;
-			}
-
-			return $this;
-		}
-
-		if (!$this->roleRegistry->exists($role)) {
+    /**
+     * @var Registry\RegistryInterface $roleRegistry
+     */
+    public $roleRegistry;
+
+    /**
+     * @var Registry\RegistryInterface $resourceRegistry
+     */
+    protected $resourceRegistry;
+
+    /**
+     * @var Registry\RegistryInterface $permissionRegistry
+     */
+    protected $permissionRegistry;
+
+    /**
+     * @var Registry\RegistryInterface $globalRegistry
+     */
+    public $globalRegistry;
+
+    /**
+     *  @var string[] $sesion
+     */
+    protected $session = [];
+
+    /**
+     * @var string SYN_ALLOW
+     */
+    const SYN_ALLOW = "can";
+
+    /**
+     * @var string SYN_DENY
+     */
+    const SYN_DENY = "cannot";
+
+    /**
+     * Performs bootstrapping
+     */
+    public function __construct()
+    {
+        self::initRegistries();
+        self::initSession();
+    }
+
+    /**
+     * Initalizes the registries
+     *
+     * @return void
+     */
+    protected function initRegistries()
+    {
+        $this->roleRegistry = new Registry();
+        $this->resourceRegistry = new Registry();
+        $this->permissionRegistry = new Registry();
+        $this->globalRegistry = new GlobalRegistry();
+    }
+
+    /**
+     * Initializes the global session array and sets them to the default value
+     *
+     * @return void
+     */
+    protected function initSession()
+    {
+        $this->session["query"] = true;
+        unset($this->session["role"], $this->session["status"]);
+    }
+
+    /**
+     * Listen for and intercept properties that're not set
+     *
+     * @param string $role;
+     * @throws \Exception
+     * @return AclInterface
+     */
+    public function __get(string $role) : AclInterface
+    {
+        if ($role === self::SYN_ALLOW || $role === self::SYN_DENY)
+        {
+            $this->session["status"] = ($role === self::SYN_ALLOW);
+
+            if (!empty($this->session["role"]))
+            {
+                $this->session["query"] = false;
+            }
+
+            return $this;
+        }
+
+        if (!$this->roleRegistry->exists($role)) {
             throw new \Exception(
                 sprintf(
                     "The role: %s doesnt exist",
@@ -133,22 +133,22 @@ 
             );
         }
 
-		$this->session["role"] = $role;
-
-		return $this;
-	}
-
-	/**
-	 * Listen for and intercept undefined methods
-	 *
-	 * @param string $permission
-	 * @param string[] $args
-	 * @throws \Exception
-	 * @return void
-	 */
-	public function __call(string $permission, array $args)
-	{
-		if (!$this->permissionRegistry->exists($permission)) {
+        $this->session["role"] = $role;
+
+        return $this;
+    }
+
+    /**
+     * Listen for and intercept undefined methods
+     *
+     * @param string $permission
+     * @param string[] $args
+     * @throws \Exception
+     * @return void
+     */
+    public function __call(string $permission, array $args)
+    {
+        if (!$this->permissionRegistry->exists($permission)) {
             throw new \Exception(
                 sprintf(
                     "The permission: %s doesnt exist",
@@ -157,7 +157,7 @@ 
             );
         }
 
-		if (!$this->resourceRegistry->exists($args[0])) {
+        if (!$this->resourceRegistry->exists($args[0])) {
             throw new \Exception(
                 sprintf(
                     "The resource: %s doesnt exist",
@@ -166,122 +166,122 @@ 
             );
         }
 
-		if ($this->session["query"])
-		{
-			$result = $this->getPermissionStatus(
+        if ($this->session["query"])
+        {
+            $result = $this->getPermissionStatus(
                 $this->session["role"],
                 $permission,
                 $args[0]
             );
 
-			$this->initSession();
+            $this->initSession();
 
-			return $result;
-		}
+            return $result;
+        }
 
-		$this->allow(
+        $this->allow(
             $this->session["role"],
             $permission,
             $args[0],
             (boolean)$this->session["status"]
         );
 
-		$this->initSession();
-	}
-
-	/**
-	 * Add a new role object to the registry
-	 *
-	 * @param string $role
-	 * @return void
-	 */
-	public function addRole(string ...$role)
-	{
-		foreach ($role as $_role)
-		{
-			$this->roleRegistry->save($_role);
-		}
-	}
-
-	/**
-	 * Add a new resource object to the registry
-	 *
-	 * @param string $resource
-	 * @return void
-	 */
-	public function addResource(string ...$resource)
-	{
-		foreach ($resource as $_resource)
-		{
-			$this->resourceRegistry->save($resource);
-		}
-	}
-
-	/**
-	 * Add a new permission object to the registry
-	 *
-	 * @param string $permission
-	 * @return void
-	 */
-	public function addPermission(string $permission)
-	{
-		foreach ($permission as $_permission)
-		{
-			$this->permissionRegistry->save($_permission);
-		}
-	}
-
-	/**
-	 * Adds objects lazily.
-	 *
-	 * Automatically determine the type of an object and call the appropriate
-	 * add method on it.
-	 *
-	 * @param ObjectInterface $objects
-	 * @throws \Exception
-	 * @return void
-	 */
-	public function add(ObjectInterface ...$objects)
-	{
-		foreach ($objects as $object)
-		{
-			if ($object instanceof RoleInterface)
-			{
-				$this->addRole((string)$object);
-			}
-			else if ($object instanceof ResourceInterface)
-			{
-				$this->addResource((string)$object);
-			}
-			else if ($object instanceof PermissionInterface)
-			{
-				$this->addPermission((string)$object);
-			}
-			else {
-	            throw new \Exception(
-	                sprintf(
-	                    "%s must implement one of RoleInterface, '.
+        $this->initSession();
+    }
+
+    /**
+     * Add a new role object to the registry
+     *
+     * @param string $role
+     * @return void
+     */
+    public function addRole(string ...$role)
+    {
+        foreach ($role as $_role)
+        {
+            $this->roleRegistry->save($_role);
+        }
+    }
+
+    /**
+     * Add a new resource object to the registry
+     *
+     * @param string $resource
+     * @return void
+     */
+    public function addResource(string ...$resource)
+    {
+        foreach ($resource as $_resource)
+        {
+            $this->resourceRegistry->save($resource);
+        }
+    }
+
+    /**
+     * Add a new permission object to the registry
+     *
+     * @param string $permission
+     * @return void
+     */
+    public function addPermission(string $permission)
+    {
+        foreach ($permission as $_permission)
+        {
+            $this->permissionRegistry->save($_permission);
+        }
+    }
+
+    /**
+     * Adds objects lazily.
+     *
+     * Automatically determine the type of an object and call the appropriate
+     * add method on it.
+     *
+     * @param ObjectInterface $objects
+     * @throws \Exception
+     * @return void
+     */
+    public function add(ObjectInterface ...$objects)
+    {
+        foreach ($objects as $object)
+        {
+            if ($object instanceof RoleInterface)
+            {
+                $this->addRole((string)$object);
+            }
+            else if ($object instanceof ResourceInterface)
+            {
+                $this->addResource((string)$object);
+            }
+            else if ($object instanceof PermissionInterface)
+            {
+                $this->addPermission((string)$object);
+            }
+            else {
+                throw new \Exception(
+                    sprintf(
+                        "%s must implement one of RoleInterface, '.
 	                    'ResourceInterface and PermissionInterface",
-	                    $object
-	                )
-	            );
-	        }	
-		}
-	}
-
-	/**
-	 * Change the status option of an assigned permission to true
-	 *
-	 * @param string $role;
-	 * @param string $permission
-	 * @param string $resource
-	 * @param boolean $status Optional
-	 * @throws \Exception
-	 * @return void
-	 */
-	public function allow(string $role, string $permission, string $resource, boolean $status=true)
-	{
-		if (!$this->roleRegistry->exists($role)) {
+                        $object
+                    )
+                );
+            }	
+        }
+    }
+
+    /**
+     * Change the status option of an assigned permission to true
+     *
+     * @param string $role;
+     * @param string $permission
+     * @param string $resource
+     * @param boolean $status Optional
+     * @throws \Exception
+     * @return void
+     */
+    public function allow(string $role, string $permission, string $resource, boolean $status=true)
+    {
+        if (!$this->roleRegistry->exists($role)) {
             throw new \Exception(
                 sprintf(
                     "The role: %s doesnt exist",
@@ -290,7 +290,7 @@ 
             );
         }
 
-		if (!$this->permissionRegistry->exists($permission)) {
+        if (!$this->permissionRegistry->exists($permission)) {
             throw new \Exception(
                 sprintf(
                     "The permission: %s doesnt exist",
@@ -299,7 +299,7 @@ 
             );
         }
 
-		if (!$this->resourceRegistry->exists($resource)) {
+        if (!$this->resourceRegistry->exists($resource)) {
             throw new \Exception(
                 sprintf(
                     "The resource: %s doesnt exist",
@@ -308,33 +308,33 @@ 
             );
         }
 
-		$this->globalRegistry->save($role, $resource, $permission, $status);
-	}
-
-	/**
-	 * Change the status option of an assigned permission to false
-	 *
-	 * @param string $role;
-	 * @param string $permission
-	 * @param string $resource
-	 * @return void
-	 */
-	public function deny(string $role, string $permission, string $resource)
-	{
-		$this->allow($role, $permission, $resource, false);
-	}
-
-	/**
-	 * Retrieve the status of a permission assigned to a role
-	 *
-	 * @param string $role;
-	 * @param string $permission
-	 * @param string $resource
-	 * @return boolean
-	 */
-	public function getPermissionStatus(string $role, string $permission, string $resource) : bool
-	{
-		if (!$this->roleRegistry->exists($role)) {
+        $this->globalRegistry->save($role, $resource, $permission, $status);
+    }
+
+    /**
+     * Change the status option of an assigned permission to false
+     *
+     * @param string $role;
+     * @param string $permission
+     * @param string $resource
+     * @return void
+     */
+    public function deny(string $role, string $permission, string $resource)
+    {
+        $this->allow($role, $permission, $resource, false);
+    }
+
+    /**
+     * Retrieve the status of a permission assigned to a role
+     *
+     * @param string $role;
+     * @param string $permission
+     * @param string $resource
+     * @return boolean
+     */
+    public function getPermissionStatus(string $role, string $permission, string $resource) : bool
+    {
+        if (!$this->roleRegistry->exists($role)) {
             throw new \Exception(
                 sprintf(
                     "The role: %s doesnt exist",
@@ -343,7 +343,7 @@ 
             );
         }
 
-		if (!$this->permissionRegistry->exists($permission)) {
+        if (!$this->permissionRegistry->exists($permission)) {
             throw new \Exception(
                 sprintf(
                     "The permission: %s doesnt exist",
@@ -352,7 +352,7 @@ 
             );
         }
 
-		if (!$this->resourceRegistry->exists($resource)) {
+        if (!$this->resourceRegistry->exists($resource)) {
             throw new \Exception(
                 sprintf(
                     "The resource: %s doesnt exist",
@@ -362,8 +362,8 @@ 
         }
 
 
-		$role = $this->globalRegistry->get($role);
+        $role = $this->globalRegistry->get($role);
 
-		return $role[$resource][$permission]["status"];
-	}
+        return $role[$resource][$permission]["status"];
+    }
 }