bristol-su / assign-roles

app/Support/LogicUserRoleRepository.php

<?php

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

{

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

    public function __construct(UserRole $userRoleRepository, \BristolSU\Support\Logic\Contracts\LogicTester $logicTester)
    {
        $this->userRoleRepository = $userRoleRepository;
        $this->logicTester = $logicTester;
    }
    
    /**
     * @inheritDoc
     */
    public function getUsersThroughRole(Role $role): Collection
    {
        return $this->userRoleRepository->getUsersThroughRole($role);
    }

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

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

    /**
     * @inheritDoc
     */
    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

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

    private function logicGroupId()

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

    {
        $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

    {
        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

    {
        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

    {
        if($this->hasLogicGroup()) {
            return $roles->filter(function(\BristolSU\ControlDB\Contracts\Models\Role $role) {
                return $this->isInLogicGroup($role);
            })->values();
        }
        return $roles;
    }
}