bristol-su / assign-roles

app/Support/PositionSettingRetrieval.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\Authentication\Contracts\Authentication;
use BristolSU\Support\Logic\Contracts\Audience\LogicAudience;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use BristolSU\Support\Logic\Contracts\LogicTester;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use Exception;
use Illuminate\Support\Facades\Cache;

class PositionSettingRetrieval

Missing doc comment for class PositionSettingRetrieval

{

    /**

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)

Missing doc comment for function getSettings()

    {
        $settings = settings('position_settings', []);
        foreach ($settings as $setting) {
            if ($this->groupIsForSetting($group, $setting)) {
                return $setting;
            }
        }
        throw new SettingRetrievalException('Could not find a setting');
    }

    protected function groupIsForSetting(Group $group, array $setting): bool

Missing doc comment for function groupIsForSetting()

    {
        $user = app(Authentication::class)->getUser();
        $role = app(Authentication::class)->getRole();
        
        if (!array_key_exists('logic_id', $setting)) {
            return false;
        }
        $logic = $this->logicRepository->getById($setting['logic_id']);
        return app(LogicTester::class)->evaluate($logic, $user, $group, $role);
//        $groups = collect($this->logicAudience->groupAudience($logic))->map(function (Group $group) {

Line indented incorrectly; expected at least 8 spaces, found 0

//            return $group->id();

Line indented incorrectly; expected at least 8 spaces, found 0

//        });

Line indented incorrectly; expected at least 8 spaces, found 0

//        return $groups->contains($group->id());

Line indented incorrectly; expected at least 8 spaces, found 0

    }

    protected function getCacheKey(Group $group)

Missing doc comment for function getCacheKey()

    {
        $moduleInstance = app(ModuleInstance::class);
        if($moduleInstance->exists) {

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

            throw new \Exception('Module instance was used in ' . static::class . ' but was not bound to the container');
        }
        return PositionSettingRetrieval::class . '.' . $moduleInstance->id() . '.' . $group->id();
    }
    
    public function parse($setting)

Missing doc comment for function parse()

    {
        foreach ($setting['allowed'] as $index => $id) {
            $setting['allowed'][$index] = $this->getPosition($id);
        }
        foreach ($setting['only_one_role'] as $index => $id) {
            $setting['only_one_role'][$index] = $this->getPosition($id);
        }
        foreach ($setting['only_one_user'] as $index => $id) {
            $setting['only_one_user'][$index] = $this->getPosition($id);
        }
        foreach ($setting['user_only_has_one_role'] as $index => $id) {
            $setting['user_only_has_one_role'][$index] = $this->getPosition($id);
        }
        return $setting;
    }

    protected function getPosition($id)

Missing doc comment for function getPosition()

    {
        return $this->positionRepository->getById($id);
    }

}