bristol-su / assign-roles

app/Rules/PositionIsAllowed.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Rules;

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

class PositionIsAllowed implements Rule

Missing doc comment for class PositionIsAllowed

{

    /**

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

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

Missing doc comment for function __construct()

    {
        $this->positionSettingRetrieval = $positionSettingRetrieval;
        $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)
    {
        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;
        }
        
        return in_array($value, $settings['allowed']);
    }

    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 position is not available to use';
    }
}