bristol-su / assign-roles

app/Support/RequiredSettingRetrieval.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Support;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Repositories\Position;
use BristolSU\Support\Logic\Contracts\Audience\LogicAudience;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use BristolSU\Support\Logic\Facade\LogicTester;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use Illuminate\Support\Facades\Cache;

class RequiredSettingRetrieval

Missing doc comment for class RequiredSettingRetrieval

{

    /**

Missing short description in doc comment

     * @var LogicRepository
     */
    private $logicRepository;

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

    /**

Missing short description in doc comment

     * @var LogicAudience
     */
    private $logicAudience;

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

    /**

Missing short description in doc comment

     * @var Position
     */
    private $positionRepository;

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

    public function __construct(LogicRepository $logicRepository, LogicAudience $logicAudience, Position $positionRepository)

Missing doc comment for function __construct()

    {
        $this->logicRepository = $logicRepository;
        $this->logicAudience = $logicAudience;
        $this->positionRepository = $positionRepository;
    }

    public function getSettings(Group $group, array $settings, ModuleInstance $moduleInstance)

Missing doc comment for function getSettings()

    {
        if(Cache::has($this->getCacheKey($group, $moduleInstance))) {

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

            return Cache::get($this->getCacheKey($group, $moduleInstance));
        }
        foreach ((array_key_exists('required', $settings)?$settings['required']:[]) as $setting) {
            if ($this->groupIsForSetting($group, $setting)) {
                Cache::put($this->getCacheKey($group, $moduleInstance), $setting['required'], 7200);
                return $setting['required'];
            }
        }
        throw new SettingRetrievalException('Could not find a setting');
    }

    protected function getCacheKey(Group $group, ModuleInstance $moduleInstance)

Missing doc comment for function getCacheKey()

    {
        return RequiredSettingRetrieval::class . '.' . $moduleInstance->id() . '.' . $group->id();
    }
    
    protected function groupIsForSetting(Group $group, array $setting): bool

Missing doc comment for function groupIsForSetting()

    {
        if (!array_key_exists('logic_id', $setting)) {
            return false;
        }
        $logic = $this->logicRepository->getById($setting['logic_id']);
        return LogicTester::evaluate($logic, null, $group, null);
    }

}