ActionInstance.php

Go to the documentation of this file.

<?php

namespace BristolSU\Support\Action;

use BristolSU\ControlDB\Contracts\Repositories\User;
use BristolSU\Support\Action\History\ActionHistory;
use BristolSU\Support\Authentication\Contracts\Authentication;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use BristolSU\Support\Revision\HasRevisions;
use BristolSU\Support\User\Contracts\UserAuthentication;
use FormSchema\Transformers\VFGTransformer;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class ActionInstance extends Model
{
    use HasRevisions;
    
    protected $fillable = [
        'name', 'description', 'event', 'action', 'module_instance_id', 'user_id', 'should_queue'
    ];

    protected $appends = [
        'event_fields', 'action_schema'
    ];

    protected $casts = [
        'should_queue' => 'boolean'
    ];

    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);
        self::creating(function($model) {
            if($model->user_id === null && ($user = app(UserAuthentication::class)->getUser()) !== null) {
                $model->user_id = $user->controlId();
            }
        });
    }

    public function actionInstanceFields() {
        return $this->hasMany(ActionInstanceField::class);
    }

    public function getEventFieldsAttribute()
    {
        return $this->event::getFieldMetaData();
    }

    public function getActionSchemaAttribute()
    {
        return (new VFGTransformer())->transformToArray($this->action::options());
    }

    public function moduleInstance()
    {
        return $this->belongsTo(ModuleInstance::class);
    }

    public function user(): \BristolSU\ControlDB\Contracts\Models\User
    {
        if($this->user_id === null) {
            throw new \Exception(sprintf('Action Instance #%u is not owned by a user.', $this->id));
        }
        return app(User::class)->getById($this->user_id);
    }

    public function history()
    {
        return $this->hasMany(ActionHistory::class);
    }
}