FormActionEvent

FormActionEvent.php : 14 Copy path

Extends FormEvent

Methods¶

__construct() ¶

FormActionEvent.php : 44 Copy path

    
                        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>	[]	-

getClickedButton() ¶

FormActionEvent.php : 57 Copy path

public getClickedButton() : string|null

Return values

string|null

getOption() ¶

FormActionEvent.php : 73 Copy path

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

getOptions() ¶

FormActionEvent.php : 62 Copy path

public getOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

getPayload() ¶

FormActionEvent.php : 117 Copy path

public getPayload(string $name) : mixed

Parameters

Name	Type	Default value	Description
$name	string	-	-

getPayloads() ¶

FormActionEvent.php : 102 Copy path

public getPayloads() : array<string|int, mixed>

Return values

array<string|int, mixed>

getResponse() ¶

FormActionEvent.php : 87 Copy path

public getResponse() : Response|null

Return values

Response|null

hasOption() ¶

FormActionEvent.php : 82 Copy path

public hasOption(string $optionName) : bool

Parameters

Name	Type	Default value	Description
$optionName	string	-	-

Return values

bool

hasPayload() ¶

FormActionEvent.php : 112 Copy path

public hasPayload(string $name) : bool

Parameters

Name	Type	Default value	Description
$name	string	-	-

Return values

bool

hasResponse() ¶

FormActionEvent.php : 97 Copy path

public hasResponse() : bool

Return values

bool

setPayload() ¶

FormActionEvent.php : 122 Copy path

public setPayload(string $name, mixed $payload) : void

Parameters

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

setPayloads() ¶

FormActionEvent.php : 107 Copy path

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

Parameters

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

setResponse() ¶

FormActionEvent.php : 92 Copy path

public setResponse(Response $response) : void

Parameters

Name	Type	Default value	Description
$response	Response	-	-