StepExpired Event
The StepExpired event is raised if the Wizard has a step timeout set and a step in not processed within the timeout period.
Namespace | BeastBytes\Wizard\Event |
|---|---|
Inherits | |
Uses |
Methods
Name | Description |
|---|---|
__construct() | Event constructor |
getResponse() | Returns the response |
getWizard() | Returns the Wizard instance that raised the event |
isPropagationStopped() | Returns a value indicating whether event propagation is stopped |
isWizardStopped() | Returns a value indicating whether the wizard is stopped |
setResponse() | Sets the response |
stopPropagation() | Stops event propagation |
stopWizard() | Stops the wizard |
Method Details
__construct()
Constructor
Parameter | Type | Default | Description |
|---|---|---|---|
$wizard | WizardInterface | Required | The Wizard instance that raised the event |
getResponse()
Returns the response.
See also:
Return | ?ResponseInterface | The response or null if no response is set |
|---|
getWizard()
Returns the Wizard instance that raised the event.
Return | WizardInterface | The Wizard instance that raised the event |
|---|
isPropagationStopped()
Returns a value indicating whether event propagation is stopped.
See also:
Return | bool | Whether event propagation is stopped false: if event propagation is not stopped true: if event propagation is stopped |
|---|
isWizardStopped()
Returns a value indicating whether the Wizard is stopped
See also:
Return | bool | Whether the Wizard is stopped false: if the Wizard is not stopped true: if the Wizard is stopped |
|---|
setResponse()
Sets the response.
See also:
Parameter | Type | Default | Description |
|---|---|---|---|
$response | ResponseInterface | Required | The response |
stopPropagation()
Stops event propagation.
See also: isPropagationStopped()
stopWizard()
Stops the Wizard.
See also: