BristolSU\Support\Action\Contracts\TriggerableEvent Interface Reference

Public Member Functions
	getFields ()

Static Public Member Functions
static	getFieldMetaData ()

Detailed Description

Interface TriggerableEvent

Definition at line 10 of file TriggerableEvent.php.

Member Function Documentation

getFieldMetaData()

static BristolSU\Support\Action\Contracts\TriggerableEvent::getFieldMetaData ( )

static

Register metadata about the fields the event supplies.

For each field returned in getFields, pass in a label and a helptext. e.g. [ 'user_id' => [ 'label' => 'User ID', 'helptext' => 'The ID of the user who posted the comment.' ], ... ]

Returns

array

getFields()

BristolSU\Support\Action\Contracts\TriggerableEvent::getFields

(

)

Get the fields that the event registers.

If the event has parameters which should be used in the framework, return them here.

e.g. [ 'user_id' => 1, 'comment_id' => 4, 'post_id' => 3 ]

Returns

array

Referenced by BristolSU\Support\Action\ActionDispatcher\handle().

---

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

• src/Action/Contracts/TriggerableEvent.php