bristol-su / assign-roles

app/Rules/UserIsAvailableToBeAssigned.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Repositories\User;
use BristolSU\Module\AssignRoles\Support\PositionSettingRetrieval;
use BristolSU\Support\Authentication\Contracts\Authentication;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use BristolSU\Support\Logic\Facade\LogicTester;
use Illuminate\Contracts\Validation\Rule;

/**
 * Is the user available to be assigned?
 * 
 * If the user belongs to a user, which has a position that is 'user only has one user', they will not be available
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class UserIsAvailableToBeAssigned implements Rule
{

    /**

Missing short description in doc comment

     * @var PositionSettingRetrieval
     */
    private $positionSettingRetrieval;

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

    /**

Missing short description in doc comment

     * @var Authentication
     */
    private $authentication;

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

    /**

Missing short description in doc comment

     * @var User
     */
    private $userRepository;

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

    public function __construct(Authentication $authentication, PositionSettingRetrieval $positionSettingRetrieval, User $userRepository)

Missing doc comment for function __construct()

    {
        $this->positionSettingRetrieval = $positionSettingRetrieval;
        $this->authentication = $authentication;
        $this->userRepository = $userRepository;
    }

    /**

Missing short description in doc comment

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

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

     * @inheritDoc
     */

Missing @return tag in function comment

    public function passes($attribute, $value)
    {
        try {
            $settings = $this->positionSettingRetrieval->getSettings($this->group());

It seems like $this->group() can also be of type null; however, parameter $group of BristolSU\Module\AssignRoles\Support\PositionSettingRetrieval::getSettings() does only seem to accept BristolSU\ControlDB\Contracts\Models\Group, maybe add an additional type check?

        } catch (\Exception $e) {
            return false;
        }
        $user = $this->userRepository->getById($value);

        return $user->roles()->filter(function(Role $role) use ($settings, $user) {

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

The import $user is not used and could be removed.

            return in_array($role->id(), $settings['user_only_has_one_role']);
        })->count() === 0;

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

    }

    protected function group()

Missing doc comment for function group()

    {
        return $this->authentication->getGroup();
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function message()
    {
        return 'The user is already in a role';
    }
}