EventFired.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Completion\CompletionConditions\EventFired;

use BristolSU\Support\Events\Contracts\EventRepository;
use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\Completion\Contracts\CompletionCondition;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance;
use FormSchema\Generator\Field;
use FormSchema\Schema\Form;

class EventFired extends CompletionCondition
{

    private $eventRepository;

    public function __construct(string $moduleAlias, EventRepository $eventRepository)
    {
        parent::__construct($moduleAlias);
        $this->eventRepository = $eventRepository;
    }

    public function options(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            Field::select('event_type')->label('Event')->required(true)->hint('What event should be fired to mark this as complete?')
                ->help('Select an event which occurs within the module. When this event is fired, the module will be marked as complete. This cannot be undone.')
                ->values(collect($this->eventRepository->allForModule($this->moduleAlias()))->map(function($event) {
                    return ['id' => $event['event'], 'name' => $event['name']];
                })->toArray())->selectOptions(['noneSelectedText' => 'Please Select an Event', 'hideNoneSelectedText' => false])
        )->getSchema();
    }

    public function name(): string
    {
        return 'Event Fired.';
    }

    public function description(): string
    {
        return 'Event Fired. Warning: this will not be dynamically calculated so reverting a change to undo the condition will not mark the module as incomplete.';
    }

    public function alias(): string
    {
        return 'portalsystem_event_fired';
    }

    public function isComplete($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): bool
    {
        return true;
    }
}