bristol-su / assign-roles

app/Rules/RoleHasSpaceToAssign.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

use BristolSU\ControlDB\Contracts\Repositories\Role;
use BristolSU\Module\AssignRoles\Support\PositionSettingRetrieval;
use BristolSU\Support\Authentication\Contracts\Authentication;
use Illuminate\Contracts\Validation\Rule;

/**
 * Does the role given have space to assign?
 * 
 * This is not the case if the role should only have a single user, and it already has a user
 * 
 * @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 RoleHasSpaceToAssign 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 Role
     */
    private $roleRepository;

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

    public function __construct(Authentication $authentication, PositionSettingRetrieval $positionSettingRetrieval, Role $roleRepository)

Missing doc comment for function __construct()

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

    /**

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;
        }
        if(in_array($value, $settings['only_one_user'])) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $this->roleRepository->getById($value)->users()->count() === 0;
        }
        return true;
    }

    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 'A user is already assigned to this role';
    }
}