ModuleBuilder.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Module;

use BristolSU\Support\Events\Contracts\EventRepository;
use BristolSU\Support\Action\Contracts\TriggerableEvent;
use BristolSU\Support\Completion\Contracts\CompletionCondition;
use BristolSU\Support\Completion\Contracts\CompletionConditionRepository;
use BristolSU\Support\Connection\Contracts\ServiceRequest;
use BristolSU\Support\Module\Contracts\ModuleBuilder as ModuleBuilderContract;
use \BristolSU\Support\Module\Contracts\Module as ModuleContract;
use BristolSU\Support\ModuleInstance\Contracts\Settings\ModuleSettingsStore;
use BristolSU\Support\Permissions\Contracts\PermissionRepository;
use Exception;
use FormSchema\Transformers\VFGTransformer;
use Illuminate\Contracts\Config\Repository;

class ModuleBuilder implements ModuleBuilderContract
{

    private $module;
    
    private $permissionRepository;
    
    private $config;

    private $alias;

    private $eventRepository;
    
    private $completionConditionRepository;
    
    private $moduleSettingsStore;
    
    private $serviceRequest;

    public function __construct(ModuleContract $module,
                                PermissionRepository $permissionRepository,
                                Repository $config,
                                EventRepository $eventRepository,
                                CompletionConditionRepository $completionConditionRepository,
                                ModuleSettingsStore $moduleSettingsStore,
                                ServiceRequest $serviceRequest)
    {
        $this->module = $module;
        $this->permissionRepository = $permissionRepository;
        $this->config = $config;
        $this->eventRepository = $eventRepository;
        $this->completionConditionRepository = $completionConditionRepository;
        $this->moduleSettingsStore = $moduleSettingsStore;
        $this->serviceRequest = $serviceRequest;
    }

    public function create(string $alias)
    {
        $this->alias = $alias;
    }

    protected function getAlias(): string
    {
        if ($this->alias === null) {
            throw new Exception('Set an alias before using the builder');
        }
        return $this->alias;
    }

    public function setAlias()
    {
        $this->module->setAlias($this->getAlias());
    }

    public function setPermissions()
    {
        $this->module->setPermissions(
            $this->permissionRepository->forModule($this->getAlias())
        );
    }

    public function setName()
    {
        $this->module->setName(
            $this->config->get($this->getAlias().'.name')
        );
    }

    public function setDescription()
    {
        $this->module->setDescription(
            $this->config->get($this->getAlias().'.description')
        );
    }

    public function setSettings()
    {
        $this->module->setSettings(
            (new VFGTransformer)->transformToArray(
                $this->moduleSettingsStore->get($this->getAlias())
            )
        );
    }

    public function setTriggers()
    {
        $this->module->setTriggers(
            array_filter($this->eventRepository
                ->allForModule($this->getAlias()),
                function($event) {
                    return in_array(TriggerableEvent::class, class_implements($event['event']));
                })
        );
    }

    public function setServices()
    {
        $this->module->setServices([
            'required' => $this->serviceRequest->getRequired($this->getAlias()),
            'optional' => $this->serviceRequest->getOptional($this->getAlias())
        ]);
    }

    public function setFor()
    {
        $this->module->setFor(
            $this->config->get($this->getAlias().'.for', 'user')
        );
    }
    
    public function getModule(): ModuleContract
    {
        return $this->module;
    }

    public function setCompletionConditions()
    {
        $this->module->setCompletionConditions(
            collect($this->completionConditionRepository->getAllForModule($this->getAlias()))->toArray()
        );
    }
}