PrepareFormEvent
class PrepareFormEvent extends AbstractImmutableEvent
Class for SchemaPrepareFormEvent event Example: new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $form]);
Traits
Returns the most suitable event class for a Joomla core event name
Methods
Get the concrete event class name for the given event name.
Creates a new CMS event object for a given event name and subject. The following arguments must be given: subject object The subject of the event. This is the core object you are going to manipulate.
Constructor.
Get an event argument value.
Set the value of an event argument.
Details
static protected string
getEventClassByEventName(string $eventName)
Get the concrete event class name for the given event name.
This method falls back to the generic Joomla\Event\Event class if the event name is unknown to this trait.
static AbstractEvent
create(string $eventName, array $arguments = [])
Creates a new CMS event object for a given event name and subject. The following arguments must be given: subject object The subject of the event. This is the core object you are going to manipulate.
eventClass string The Event class name. If you do not provide it Joomla\CMS\Events\
mixed
getArgument(string $name, mixed $default = null)
Get an event argument value.
It will use a pre-processing method if one exists. The method has the signature:
onGet
where:
$value is the value currently stored in the $arguments array of the event It returns the value to return to the caller.
$this
setArgument(string $name, mixed $value)
Add argument to event.
It will use a pre-processing method if one exists. The method has the signature:
onSet
where:
$value is the value being set by the user It returns the value to return to set in the $arguments array of the event.