BristolSU\Module\AssignRoles\Support\LogicUserRoleRepository

Complexity

Total Complexity

12

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

74.19%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	logicGroupId()	0	7	2
A	getRolesThroughUser()	0	3	1
A	logicGroup()	0	4	1
A	removeUserFromRole()	0	3	1
A	getUsersThroughRole()	0	3	1
A	hasLogicGroup()	0	3	1
A	filter()	0	8	2
A	addUserToRole()	0	3	1
A	isInLogicGroup()	0	3	1
A	__construct()	0	4	1

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Support;

use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use Illuminate\Support\Collection;

class LogicUserRoleRepository implements UserRole

Missing doc comment for class LogicUserRoleRepository

{

    /**

Missing short description in doc comment

     * @var UserRole
     */
    private $userRoleRepository;

Private member variable "userRoleRepository" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var \BristolSU\Support\Logic\Contracts\LogicTester
     */
    private $logicTester;

Private member variable "logicTester" must be prefixed with an underscore

    public function __construct(UserRole $userRoleRepository, \BristolSU\Support\Logic\Contracts\LogicTester $logicTester)

Missing doc comment for function __construct()

    {
        $this->userRoleRepository = $userRoleRepository;
        $this->logicTester = $logicTester;
    }
    
    /**

Missing short description in doc comment

Parameter $role should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getUsersThroughRole(Role $role): Collection
    {
        return $this->userRoleRepository->getUsersThroughRole($role);
    }

    /**

Missing short description in doc comment

Parameter $user should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getRolesThroughUser(User $user): Collection
    {
        return $this->filter($this->userRoleRepository->getRolesThroughUser($user));
    }

    /**

Missing short description in doc comment

Parameter $user should have a doc-comment as per coding-style.

Parameter $role should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function addUserToRole(User $user, Role $role): void
    {
        $this->userRoleRepository->addUserToRole($user, $role);
    }

    /**

Missing short description in doc comment

Parameter $user should have a doc-comment as per coding-style.

Parameter $role should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function removeUserFromRole(User $user, Role $role): void
    {
        $this->userRoleRepository->removeUserFromRole($user, $role);
    }

    private function hasLogicGroup()

Private method name "LogicUserRoleRepository::hasLogicGroup" must be prefixed with an underscore

Missing doc comment for function hasLogicGroup()

    {
        return $this->logicGroupId() !== null;
    }

    private function logicGroupId()

Private method name "LogicUserRoleRepository::logicGroupId" must be prefixed with an underscore

Missing doc comment for function logicGroupId()

    {
        $id = settings('logic_group', null);
        if($id === null) {

Expected "if (...) {\n"; found "if(...) {\n"

            return null;
        }
        return (int) $id;
    }

    private function logicGroup()

Private method name "LogicUserRoleRepository::logicGroup" must be prefixed with an underscore

Missing doc comment for function logicGroup()

    {
        return app(LogicRepository::class)->getById(
            $this->logicGroupId()

It seems like $this->logicGroupId() can also be of type null; however, parameter $id of BristolSU\Support\Logic\Contracts\LogicRepository::getById() does only seem to accept integer, maybe add an additional type check?

        );
    }

    private function isInLogicGroup(\BristolSU\ControlDB\Contracts\Models\Role $role)

Private method name "LogicUserRoleRepository::isInLogicGroup" must be prefixed with an underscore

Missing doc comment for function isInLogicGroup()

    {
        return $this->logicTester->evaluate($this->logicGroup(), null, $role->group(), $role);
    }

    private function filter(Collection $roles)

Private method name "LogicUserRoleRepository::filter" must be prefixed with an underscore

Missing doc comment for function filter()

    {
        if($this->hasLogicGroup()) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $roles->filter(function(\BristolSU\ControlDB\Contracts\Models\Role $role) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                return $this->isInLogicGroup($role);
            })->values();

For multi-line function calls, the closing parenthesis should be on a new line.

        }
        return $roles;
    }
}