eXpansion\Framework\AdminGroups\Helpers\AdminGroups

Complexity

Total Complexity

26

Size/Duplication

Total Lines	194
Duplicated Lines	6.7 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

67.24%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getUserGroups()	0	10	2
A	getLoginUserGroups()	0	9	2
A	getLoginGroupLabel()	13	13	3
A	getUserGroup()	0	12	2
A	hasPermission()	0	16	4
A	hasLoginPermission()	0	8	2
B	hasGroupPermission()	0	22	6
A	getGroupLabel()	0	9	2
A	isAdmin()	0	4	2

<?php

namespace eXpansion\Framework\AdminGroups\Helpers;

use eXpansion\Framework\AdminGroups\Exceptions\UnknownGroupException;
use eXpansion\Framework\AdminGroups\Services\AdminGroupConfiguration;
use eXpansion\Framework\Core\Model\UserGroups\Group;
use eXpansion\Framework\Core\Plugins\UserGroups\Factory;
use eXpansion\Framework\Core\Storage\Data\Player;

/**
 * Class AdminGroupConfiguration
 *
 * @package eXpansion\Bundle\AdminGroupConfiguration\Helpers;
 * @author  oliver de Cramer <oliverde8@gmail.com>
 */
class AdminGroups
{
    /** @var  AdminGroupConfiguration */
    protected $adminGroupConfiguration;

    /** @var  Factory */
    protected $userGroupFactory;

    /**
     * GroupsPlugin constructor.
     *
     * @param AdminGroupConfiguration $adminGroupConfiguration
     * @param Factory                 $userGroupFactory
     */
    public function __construct(
        AdminGroupConfiguration $adminGroupConfiguration,
        Factory $userGroupFactory
    ) {
        $this->adminGroupConfiguration = $adminGroupConfiguration;
        $this->userGroupFactory = $userGroupFactory;
    }

    /**
     * Get list of all user groups.
     * Can be useful for creating group based GUI widgets.
     *
     * @return Group[]
     */
    public function getUserGroups()
    {
        $groups = [];
        foreach ($this->adminGroupConfiguration->getGroups() as $groupName) {
            $groups[] = $this->getUserGroup("$groupName");
        }
        $groups[] = $this->getUserGroup('guest');

        return $groups;
    }

    /**
     * Get the group in which a user is.
     * This is useful for gui actions.
     *
     * @param string $login
     *
     * @return Group
     */
    public function getLoginUserGroups($login)
    {
        $groupName = $this->adminGroupConfiguration->getLoginGroupName($login);
        if (empty($groupName)) {
            $groupName = 'guest';
        }

        return $this->getUserGroup("$groupName");
    }

    /**
     * Get admin group Label
     *
     * @param string $login
     * @return string
     */
    public function getLoginGroupLabel($login)

This method seems to be duplicated in your project.

    {
        $group = $this->getLoginUserGroups($login);

        $groupName = "Admin";
        if ($group) {
            if ($groupName) {
                $groupName = $this->getGroupLabel($group->getName());
            }
        }

        return $groupName;
    }


    /**
     * Get (or create a new) admin user group
     *
     * @param string $groupName
     *
     * @return Group
     */
    protected function getUserGroup($groupName)
    {
        $groupName = "admin:$groupName";

        $group = $this->userGroupFactory->getGroup($groupName);
        if (!$group) {
            $this->userGroupFactory->create($groupName);
            $group = $this->userGroupFactory->getGroup($groupName);

Are you sure the assignment to $group is correct as $this->userGroupFactory->getGroup($groupName) (which targets eXpansion\Framework\Core\Plugins\UserGroups\Factory::getGroup()) seems to always return null.

        }

        return $group;
    }

    /**
     * Checks if group, a login or a player has a certain permission or not.
     *
     * @param string|Group|Player $recipient
     * @param string              $permission The permission to check for.
     *
     * @return bool
     */
    public function hasPermission($recipient, $permission)
    {

        if ($recipient instanceof Group) {

The class eXpansion\Framework\Core\Model\UserGroups\Group does not exist. Did you forget a USE statement, or did you not list all dependencies?

            $check = true;
            foreach ($recipient->getLogins() as $login) {
                if ($this->hasLoginPermission($login, $permission) === false) {
                    $check = false;
                }
            }

            return $check;
        } else {
            return $this->hasLoginPermission($recipient, $permission);
        }
    }

    /**
     * @param string $permission
     */
    protected function hasLoginPermission($login, $permission)
    {
        if ($login instanceof Player) {
            $login = $login->getLogin();
        }

        return $this->adminGroupConfiguration->hasPermission($login, $permission);
    }


    /**
     * Check if a group has a certain permission or not.
     *
     * @param string $groupName  The name of the group to check permissions for.
     * @param string $permission The permission to check for.
     *
     * @return bool
     * @throws UnknownGroupException Thrown when group isn't an admin group.
     */
    public function hasGroupPermission($groupName, $permission)
    {
        if (strpos($groupName, 'admin:') === 0) {
            $groupName = str_replace("admin:", '', $groupName);
        }
        $logins = $this->adminGroupConfiguration->getGroupLogins($groupName);

        if (!empty($logins)) {
            return $this->hasPermission($logins[0], $permission);
        }
        
        // If guest group is unknow it has no permissions.
        if ($groupName == 'guest' && is_null($logins)) {
            return false;
        }

        if (is_null($logins)) {
            throw new UnknownGroupException("'$groupName' admin group does not exist.");
        }

        return false;
    }

    /**
     * @param string $groupName
     * @return string
     */
    public function getGroupLabel($groupName)
    {
        if (strpos($groupName, 'admin:') === 0) {
            $groupName = str_replace("admin:", '', $groupName);
        }

        return $this->adminGroupConfiguration->getGroupLabel($groupName);

    }

    /**
     * gets if the player is admin
     *
     * @param string $login
     * @return bool
     */
    public function isAdmin($login)
    {
        return ($this->getLoginUserGroups($login)->getName() !== "admin:guest") ? true : false;
    }

}