Copied!

FormActionEvent

FormActionEvent.php : 14
Extends FormEvent

Methods

public__construct()

FormActionEvent.php : 44 
public __construct(FormInterface $form, mixed $data, string|null $clickedButton[, array<string|int, mixed> $options = [] ][, array<string|int, mixed> $payloads = [] ])

Parameters

Name Type Default value Description
$form FormInterface - -
$data mixed - -
$clickedButton string|null - -
$options array<string|int, mixed> [] -
$payloads array<string|int, mixed> [] -

publicgetClickedButton()

FormActionEvent.php : 57 
public getClickedButton() : string|null

Return values

string|null

publicgetOption()

FormActionEvent.php : 73 
public getOption(string $optionName[, mixed $defaultValue = null ]) : mixed

Parameters

Name Type Default value Description
$optionName string -

The option name
$defaultValue mixed null

default value to return if option is not set

publicgetOptions()

FormActionEvent.php : 62 
public getOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

publicgetPayload()

FormActionEvent.php : 117 
public getPayload(string $name) : mixed

Parameters

Name Type Default value Description
$name string - -

publicgetPayloads()

FormActionEvent.php : 102 
public getPayloads() : array<string|int, mixed>

Return values

array<string|int, mixed>

publicgetResponse()

FormActionEvent.php : 87 
public getResponse() : Response|null

Return values

Response|null

publichasOption()

FormActionEvent.php : 82 
public hasOption(string $optionName) : bool

Parameters

Name Type Default value Description
$optionName string - -

Return values

bool

publichasPayload()

FormActionEvent.php : 112 
public hasPayload(string $name) : bool

Parameters

Name Type Default value Description
$name string - -

Return values

bool

publichasResponse()

FormActionEvent.php : 97 
public hasResponse() : bool

Return values

bool

publicsetPayload()

FormActionEvent.php : 122 
public setPayload(string $name, mixed $payload) : void

Parameters

Name Type Default value Description
$name string - -
$payload mixed - -

publicsetPayloads()

FormActionEvent.php : 107 
public setPayloads(array<string|int, mixed> $payloads) : void

Parameters

Name Type Default value Description
$payloads array<string|int, mixed> - -

publicsetResponse()

FormActionEvent.php : 92 
public setResponse(Response $response) : void

Parameters

Name Type Default value Description
$response Response - -