bristol-su / assign-roles

app/Rules/RoleBelongsToGroup.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepository;
use BristolSU\Support\Authentication\Contracts\Authentication;
use Illuminate\Contracts\Validation\Rule;

/**
 * Test if a role belongs to a 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 RoleBelongsToGroup implements Rule
{

    /**

Missing short description in doc comment

     * @var RoleRepository
     */
    private $roleRepository;

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

    public function __construct(RoleRepository $roleRepository, Authentication $authentication)

Missing doc comment for function __construct()

    {
        $this->roleRepository = $roleRepository;
        $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)
    {
        $role = $this->roleRepository->getById($value);
        return $this->group()->id() === $role->groupId();
    }

    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 role does not belong to your group';
    }
}