HasHistory.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Action\History;

use BristolSU\Support\Action\ActionResponse;
use Exception;
use Illuminate\Http\Response;

trait HasHistory
{

    private $actionInstanceId;

    private $eventFields;

    private $settings;

    public function setActionInstanceId(int $actionInstanceId): void
    {
        $this->actionInstanceId = $actionInstanceId;
    }

    public function setEventFields(array $eventFields): void
    {
        $this->eventFields = $eventFields;
    }

    public function setSettings(array $settings): void
    {
        $this->settings = $settings;
    }

    public function saveHistory(ActionResponse $response): void
    {
        if ($this->actionInstanceId === null){
            throw new Exception('The action instance ID must not be null');
        }

        ActionHistory::create([
            'action_instance_id' => $this->actionInstanceId,
            'event_fields' => ($this->eventFields ?? []),
            'settings' => ($this->settings ?? []),
            'success' => $response->getSuccess(),
            'message' => $response->getMessage()
        ]);
    }

}