Skip to content

FormActionsEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\FormActionsEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.6.10

Form Actions Event class.

View source

Public Properties

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
formActionsarray – The form actions that will be displayed for the current page.
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject, null – The sender of this event.

formActions

Type
array
Default value
null

The form actions that will be displayed for the current page.

Each action should be defined by an array with any of the following keys:

  • label – The human-facing label for the action.
  • action – The controller action path that should be requested when the action is selected.
  • redirect – The redirect param that should be passed to the controller action if the action is selected. Note that this value should be hashed via Craft::$app->security->hashData().
  • confirm – A confirmation message that should be displayed when the action is selected.
  • params – An array of param names/values that should be passed to the controller action if the action is selected.
  • destructivetrue or false depending on whether the action should be considered destructive.
  • shortcuttrue or false depending on whether the action should be triggered by the Command/Ctrl + S keyboard shortcut.
  • shifttrue or false depending on whether the keyboard shortcut requires the Shift key to be pressed.

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
trigger()Triggers a class-level event.