Action.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Action\Contracts;

use BristolSU\Support\Action\ActionResponse;
use BristolSU\Support\Action\History\HasHistory;
use BristolSU\Support\Action\History\RecordsHistory;
use Exception;
use FormSchema\Schema\Form;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;

abstract class Action implements ShouldQueue, RecordsHistory
{
    use Dispatchable, Queueable, HasHistory;

    private $data;

    private $response;

    public function __construct(array $data = [])
    {
        $this->data = $data;
    }

    abstract public static function options(): Form;

    public function handle()
    {
        try {
            $this->response = app()->call([$this, 'run']);
        } catch (Exception $e) {
            $this->response = ActionResponse::failure(($e->getMessage() === '' ? 'An error was thrown during processing' : $e->getMessage()));
        }
        if ($this instanceof RecordsHistory) {
            $this->saveHistory($this->getResponse());
        }
    }

    public function getResponse(): ?ActionResponse
    {
        return $this->response;
    }

    public function option(string $key, $default = null)
    {
        if (array_key_exists($key, $this->data)) {
            return $this->data[$key];
        }
        return $default;
    }

    public function getData(): array
    {
        return $this->data;
    }

    abstract public function run(): ActionResponse;

}