bristol-su / assign-roles

app/Rules/UserBelongsToRole.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Repositories\User;
use Illuminate\Contracts\Validation\Rule;

class UserBelongsToRole implements Rule

Missing doc comment for class UserBelongsToRole

{

    /**

Missing short description in doc comment

     * @var Role
     */
    private $role;

The private property $role is not used, and could be removed.

Private member variable "role" 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

    /**

Missing short description in doc comment

     * @var int
     */
    private $roleId;

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

    public function __construct(int $roleId, User $userRepository)

Missing doc comment for function __construct()

    {
        $this->roleId = $roleId;
        $this->userRepository = $userRepository;
        $this->roleId = $roleId;
    }

    /**

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)
    {
        return $this->userRepository->getById($value)->roles()->filter(function(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 $role->id() === $this->roleId;
        })->count() > 0;

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

    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function message()
    {
        return 'The user does not belong to the role';
    }
}