ThallesDella\GateKeeper\Roles\Roles

Complexity

Total Complexity

24

Size/Duplication

Total Lines	217
Duplicated Lines	0 %

Importance

Changes	4
Bugs	2	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getRole()	0	3	1
A	getRoleAuthUrl()	0	5	1
A	editAuthUrl()	0	10	1
A	editPermissions()	0	10	1
A	editRoleGroup()	0	10	1
A	getRoles()	0	3	1
A	getPermissions()	0	16	5
A	deleteRole()	0	10	3
A	moveRoleAfter()	0	19	6
A	addRole()	0	8	1
A	addGroup()	0	7	1
A	getGroup()	0	4	1

<?php

namespace ThallesDella\GateKeeper\Roles;

use ArrayObject;
use ThallesDella\GateKeeper\UserInfo;

/**
 * Gate Keeper | Class Roles [ ROLE SYSTEM ]
 *
 * @category GateKeeper\Roles
 * @package  ThallesDella\GateKeeper\Roles
 * @author   Thalles D. koester <thallesdella@gmail.com>
 * @license  https://choosealicense.com/licenses/mit/ MIT
 * @link     https://github.com/thallesdella/gate-keeper
 */
class Roles
{
    /**
     * Array Object containing instances of group object
     *
     * @var ArrayObject
     */
    private $groups;
    
    /**
     * Array Object containing instances of role object
     *
     * @var ArrayObject
     */
    private $roles;
    
    /**
     * Roles constructor.
     */
    public function __construct()
    {
        $this->groups = new ArrayObject();
        $this->roles = new ArrayObject();
    }
    
    /**
     * @param string      $groupName Name of the group to add
     * @param string|null $authUrl   Auth page of the group
     *
     * @return Roles
     */
    public function addGroup(string $groupName, ?string $authUrl = null): Roles
    {
        $group = new Group($groupName, $this->groups->count());
        $group->setAuthUrl($authUrl);
    
        $this->groups->append([$groupName => $group]);
        return $this;
    }
    
    /**
     * @param string     $roleName    Name of role to add
     * @param array|null $permissions Permissions of the role
     * @param string     $groupName   Group of the role
     *
     * @return Roles
     */
    public function addRole(string $roleName, ?array $permissions, string $groupName): Roles
    {
        $roleInfo = new Role($roleName, $this->roles->count());
        $roleInfo->setPermissions($permissions);
        $roleInfo->setGroup($groupName);
    
        $this->roles->append([$roleName => $roleInfo]);
        return $this;
    }
    
    /**
     * @param string     $roleName    Name of the role to edit
     * @param array|null $permissions New permissions of the role
     *
     * @return Roles
     */
    public function editPermissions(string $roleName, ?array $permissions): Roles
    {
        /**
         * Role object
         *
         * @var Role $roleInfo
         */
        $roleInfo = $this->roles[$roleName];
        $roleInfo->setPermissions($permissions);
        return $this;
    }
    
    /**
     * @param string $roleName  Name of the role to edit
     * @param string $groupName New group
     *
     * @return Roles
     */
    public function editRoleGroup(string $roleName, string $groupName): Roles
    {
        /**
         * Role object
         *
         * @var Role $roleInfo
         */
        $roleInfo = $this->roles[$roleName];
        $roleInfo->setGroup($groupName);
        return $this;
    }
    
    /**
     * @param string      $groupName Name of the group to edit
     * @param string|null $url       New auth url
     *
     * @return Roles
     */
    public function editAuthUrl(string $groupName, ?string $url): Roles
    {
        /**
         * Group object
         *
         * @var Group $groupInfo
         */
        $groupInfo = $this->groups[$groupName];
        $groupInfo->setAuthUrl($url);
        return $this;
    }
    
    /**
     * @param string      $roleName  Name of the role to be moved
     * @param string|null $otherRole Pivot role
     *
     * @return Roles
     */
    public function moveRoleAfter(string $roleName, ?string $otherRole): Roles
    {
        foreach ($this->roles->getIterator() as $key => $value) {
            if ($value->level > $this->roles[$roleName]->level) {
                $this->roles[$key]->level -= 1;
            }
        }
    
        foreach ($this->roles->getIterator() as $key => $value) {
            if (empty($otherRole)
                || $value->level > $this->roles[$otherRole]->level
            ) {
                $this->roles[$key]->level += 1;
            }
        }
    
        $this->roles[$roleName]->level = $this->roles[$otherRole]->level + 1;
        
        return $this;
    }
    
    /**
     * @param string $roleName Name of the role to be deleted
     *
     * @return Roles
     */
    public function deleteRole(string $roleName): Roles
    {
        foreach ($this->roles->getIterator() as $key => $value) {
            if ($value->level > $this->roles[$roleName]->level) {
                $this->roles[$key]->level -= 1;
            }
        }
    
        $this->roles->offsetUnset($roleName);
        return $this;
    }
    
    /**
     * @param UserInfo $user
     *
     * @return array
     */
    public function getPermissions(UserInfo $user): array
    {
        if (!isset($this->roles[$user->role])
            || empty($this->roles[$user->role])
        ) {
            return [];
        }
    
        $permissions = new ArrayObject();
        $userRole = $this->roles[$user->role];
        foreach ($this->roles as $key => $value) {
            if ($value->level <= $userRole->level) {
                $permissions->append($value->permissions);
            }
        }
        return $permissions->getArrayCopy();
    }
    
    /**
     * @return ArrayObject
     */
    public function getRoles(): ArrayObject
    {
        return $this->roles;
    }
    
    /**
     * @param string $roleName Name of the role
     *
     * @return Role
     */
    public function getRole(string $roleName): Role
    {
        return $this->roles[$roleName];
    }
    
    /**
     * @param string $groupName
     *
     * @return Group|null
     */
    public function getGroup(string $groupName): ?Group
    {
    
        return ($this->groups[$groupName] ?? null);
    }
    
    /**
     * @param string $roleName
     *
     * @return string|null
     */
    public function getRoleAuthUrl(string $roleName): ?string
    {
        $roleInfo = $this->roles[$roleName];
        $group = $this->getGroup($roleInfo->group);
        return $group->auth_url;
    }
}