bristol-su / assign-roles

app/Rules/UserIsNotLoggedIntoRole.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

use BristolSU\Support\Authentication\Contracts\Authentication;
use Illuminate\Contracts\Validation\Rule;

class UserIsNotLoggedIntoRole implements Rule

Missing doc comment for class UserIsNotLoggedIntoRole

{

    /**

Missing short description in doc comment

     * @var Authentication
     */
    private $authentication;

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

    public function __construct(Authentication $authentication)

Missing doc comment for function __construct()

    {
        $this->authentication = $authentication;
    }

    /**

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->authentication->getRole() === null || 
            $this->authentication->getRole()->id() !== (int) $value;
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function message()
    {
        return 'You cannot unassign a role you are logged in as';
    }
}