BristolSU\Support\Action\ActionInstance Class Reference

Inheritance diagram for BristolSU\Support\Action\ActionInstance:

Collaboration diagram for BristolSU\Support\Action\ActionInstance:

Public Member Functions
	__construct (array $attributes=[])
	actionInstanceFields ()
	getEventFieldsAttribute ()
	getActionSchemaAttribute ()
	moduleInstance ()
	user ()
	history ()
Public Member Functions inherited from BristolSU\Support\Revision\HasRevisions
	initializeHasRevisions ()
	getSystemUserId ()

Protected Attributes
	$fillable
	$appends
	$casts
Protected Attributes inherited from BristolSU\Support\Revision\HasRevisions
	$historyLimit
	$revisionCleanup

Detailed Description

ActionInstance Model.

Represents an Action and Event link in the database

Definition at line 20 of file ActionInstance.php.

Constructor & Destructor Documentation

__construct()

BristolSU\Support\Action\ActionInstance::__construct

(

array

$attributes = []

)

Initialise an Action Instance model.

Save the ID of the current user on creation

Parameters

array

$attributes

Definition at line 57 of file ActionInstance.php.

Member Function Documentation

actionInstanceFields()

BristolSU\Support\Action\ActionInstance::actionInstanceFields

(

)

Action Instance field relationships

Returns

Definition at line 71 of file ActionInstance.php.

Referenced by BristolSU\Support\Action\ActionBuilder\build().

getActionSchemaAttribute()

BristolSU\Support\Action\ActionInstance::getActionSchemaAttribute

(

)

Get the field meta data for the action

Returns

mixed

Definition at line 90 of file ActionInstance.php.

getEventFieldsAttribute()

BristolSU\Support\Action\ActionInstance::getEventFieldsAttribute

(

)

Get the field meta data for the event

Returns

mixed

Definition at line 80 of file ActionInstance.php.

history()

BristolSU\Support\Action\ActionInstance::history

(

)

Definition at line 119 of file ActionInstance.php.

moduleInstance()

BristolSU\Support\Action\ActionInstance::moduleInstance

(

)

Module Instance relationship

Returns

Definition at line 100 of file ActionInstance.php.

user()

BristolSU\Support\Action\ActionInstance::user

(

)

Get the user who created the action instance

Returns

Exceptions

Definition at line 111 of file ActionInstance.php.

Member Data Documentation

$appends

BristolSU\Support\Action\ActionInstance::$appends

protected

Initial value:

= [
        'event_fields', 'action_schema'
    ]

Definition at line 37 of file ActionInstance.php.

$casts

BristolSU\Support\Action\ActionInstance::$casts

protected

Initial value:

= [
        'should_queue' => 'boolean'
    ]

Definition at line 46 of file ActionInstance.php.

$fillable

BristolSU\Support\Action\ActionInstance::$fillable

protected

Initial value:

= [
        'name', 'description', 'event', 'action', 'module_instance_id', 'user_id', 'should_queue'
    ]

Definition at line 28 of file ActionInstance.php.

---

The documentation for this class was generated from the following file:

• src/Action/ActionInstance.php