AdminGroups::getUserGroups() - Code Metrics - Inspection of "Color configs" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#278)

by De Cramer

created 2018-02-24 13:29 UTC

AdminGroups::getUserGroups() A

↳ Parent: AdminGroups

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
cc	2
eloc	6
nc	2
nop	0
crap	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 <[email protected]>
 */
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)

    {
        $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);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        }

        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) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $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;
    }

}


Pull Request — master (#278)

AdminGroups::getUserGroups() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace eXpansion\Framework\AdminGroups\Helpers;
4
5			use eXpansion\Framework\AdminGroups\Exceptions\UnknownGroupException;
6			use eXpansion\Framework\AdminGroups\Services\AdminGroupConfiguration;
7			use eXpansion\Framework\Core\Model\UserGroups\Group;
8			use eXpansion\Framework\Core\Plugins\UserGroups\Factory;
9			use eXpansion\Framework\Core\Storage\Data\Player;
10
11			/**
12			* Class AdminGroupConfiguration
13			*
14			* @package eXpansion\Bundle\AdminGroupConfiguration\Helpers;
15			* @author oliver de Cramer <[email protected]>
16			*/
17			class AdminGroups
18			{
19			/** @var AdminGroupConfiguration */
20			protected $adminGroupConfiguration;
21
22			/** @var Factory */
23			protected $userGroupFactory;
24
25			/**
26			* GroupsPlugin constructor.
27			*
28			* @param AdminGroupConfiguration $adminGroupConfiguration
29			* @param Factory $userGroupFactory
30			*/
31	7		public function __construct(
32			AdminGroupConfiguration $adminGroupConfiguration,
33			Factory $userGroupFactory
34			) {
35	7		$this->adminGroupConfiguration = $adminGroupConfiguration;
36	7		$this->userGroupFactory = $userGroupFactory;
37	7		}
38
39			/**
40			* Get list of all user groups.
41			* Can be useful for creating group based GUI widgets.
42			*
43			* @return Group[]
44			*/
45	1		public function getUserGroups()
46			{
47	1		$groups = [];
48	1		foreach ($this->adminGroupConfiguration->getGroups() as $groupName) {
49	1		$groups[] = $this->getUserGroup("$groupName");
50			}
51	1		$groups[] = $this->getUserGroup('guest');
52
53	1		return $groups;
54			}
55
56			/**
57			* Get the group in which a user is.
58			* This is useful for gui actions.
59			*
60			* @param string $login
61			*
62			* @return Group
63			*/
64	1		public function getLoginUserGroups($login)
65			{
66	1		$groupName = $this->adminGroupConfiguration->getLoginGroupName($login);
67	1		if (empty($groupName)) {
68	1		$groupName = 'guest';
69			}
70
71	1		return $this->getUserGroup("$groupName");
72			}
73
74			/**
75			* Get admin group Label
76			*
77			* @param string $login
78			* @return string
79			*/
80		View Code Duplication	public function getLoginGroupLabel($login)
			0 ignored issues – show Duplication introduced 2017-12-16 09:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
81			{
82			$group = $this->getLoginUserGroups($login);
83
84			$groupName = "Admin";
85			if ($group) {
86			if ($groupName) {
87			$groupName = $this->getGroupLabel($group->getName());
88			}
89			}
90
91			return $groupName;
92			}
93
94
95			/**
96			* Get (or create a new) admin user group
97			*
98			* @param string $groupName
99			*
100			* @return Group
101			*/
102	2		protected function getUserGroup($groupName)
103			{
104	2		$groupName = "admin:$groupName";
105
106	2		$group = $this->userGroupFactory->getGroup($groupName);
107	2		if (!$group) {
108	2		$this->userGroupFactory->create($groupName);
109	2		$group = $this->userGroupFactory->getGroup($groupName);
			0 ignored issues – show Bug introduced 2017-05-13 11:19 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$group` is correct as `$this->userGroupFactory->getGroup($groupName)` (which targets `eXpansion\Framework\Core...ups\Factory::getGroup()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
110			}
111
112	2		return $group;
113			}
114
115			/**
116			* Checks if group, a login or a player has a certain permission or not.
117			*
118			* @param string\|Group\|Player $recipient
119			* @param string $permission The permission to check for.
120			*
121			* @return bool
122			*/
123	3		public function hasPermission($recipient, $permission)
124			{
125
126	3		if ($recipient instanceof Group) {
			0 ignored issues – show Bug introduced 2017-11-25 14:38 UTC by Report Bug Copy Issue Report The class `eXpansion\Framework\Core\Model\UserGroups\Group` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
127			$check = true;
128			foreach ($recipient->getLogins() as $login) {
129			if ($this->hasLoginPermission($login, $permission) === false) {
130			$check = false;
131			}
132			}
133
134			return $check;
135			} else {
136	3		return $this->hasLoginPermission($recipient, $permission);
137			}
138			}
139
140			/**
141			* @param string $permission
142			*/
143	3		protected function hasLoginPermission($login, $permission)
144			{
145	3		if ($login instanceof Player) {
146			$login = $login->getLogin();
147			}
148
149	3		return $this->adminGroupConfiguration->hasPermission($login, $permission);
150			}
151
152
153			/**
154			* Check if a group has a certain permission or not.
155			*
156			* @param string $groupName The name of the group to check permissions for.
157			* @param string $permission The permission to check for.
158			*
159			* @return bool
160			* @throws UnknownGroupException Thrown when group isn't an admin group.
161			*/
162	3		public function hasGroupPermission($groupName, $permission)
163			{
164	3		if (strpos($groupName, 'admin:') === 0) {
165	2		$groupName = str_replace("admin:", '', $groupName);
166			}
167	3		$logins = $this->adminGroupConfiguration->getGroupLogins($groupName);
168
169	3		if (!empty($logins)) {
170	1		return $this->hasPermission($logins[0], $permission);
171			}
172
173			// If guest group is unknow it has no permissions.
174	3		if ($groupName == 'guest' && is_null($logins)) {
175	1		return false;
176			}
177
178	2		if (is_null($logins)) {
179	2		throw new UnknownGroupException("'$groupName' admin group does not exist.");
180			}
181
182	1		return false;
183			}
184
185			/**
186			* @param string $groupName
187			* @return string
188			*/
189			public function getGroupLabel($groupName)
190			{
191			if (strpos($groupName, 'admin:') === 0) {
192			$groupName = str_replace("admin:", '', $groupName);
193			}
194
195			return $this->adminGroupConfiguration->getGroupLabel($groupName);
196
197			}
198
199			/**
200			* gets if the player is admin
201			*
202			* @param string $login
203			* @return bool
204			*/
205			public function isAdmin($login)
206			{
207			return ($this->getLoginUserGroups($login)->getName() !== "admin:guest") ? true : false;
208			}
209
210			}
211

eXpansionPluginPack / eXpansion2

Pull Request — master (#278)

AdminGroups::getUserGroups() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like