bristol-su / assign-roles

app/Rules/UserBelongsToGroup.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Contracts\Repositories\User as UserRepository;
use BristolSU\Support\Authentication\Contracts\Authentication;
use Illuminate\Contracts\Validation\Rule;

/**
 * Is the user a member of the group
 * 
 * @package BristolSU\Module\AssignRoles\Rules
 */

Missing @category tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class UserBelongsToGroup implements Rule
{

    /**

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 UserRepository
     */
    private $userRepository;

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

    public function __construct(Authentication $authentication, UserRepository $userRepository)

Missing doc comment for function __construct()

    {
        $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)
    {
        $user = app(UserRepository::class)->getById((int) $value);

The assignment to $user is dead and can be removed.

        $groupToMatch = $this->group();
        return $this->userRepository->getById($value)->groups()->filter(function(Group $group) use ($groupToMatch) {

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 $group->id() === $groupToMatch->id();
        })->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 not a member of the group';
    }
}