| Fully Qualified Name: | Laminas\Mvc\Controller\Plugin\Forward |
| Extends: | AbstractPlugin |
| Name | Description | Defined By |
|---|---|---|
| __construct() | Forward | |
| dispatch() | Dispatch another controller | Forward |
| getController() | Get the current controller instance | AbstractPlugin |
| getListenersToDetach() | Get information on listeners that need to be detached before dispatching. | Forward |
| setController() | Set the current controller instance | AbstractPlugin |
| setListenersToDetach() | Set information on listeners that need to be detached before dispatching. | Forward |
| setMaxNestedForwards() | Set maximum number of nested forwards allowed | Forward |
| Parameter Name | Type | Description |
|---|---|---|
| $controllers | \ControllerManager |
Returns:
Dispatch another controller
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | Controller |
| $params | null|array | Parameters |
Returns: mixed
Get the current controller instance
Returns: null|\Dispatchable
Get information on listeners that need to be detached before dispatching.
Each entry in the array contains three keys:
id (identifier for event-emitting component), event (the hooked event) and class (the class of listener that should be detached).
Returns: array
Set the current controller instance
| Parameter Name | Type | Description |
|---|---|---|
| $controller | \Dispatchable |
Returns: void
Set information on listeners that need to be detached before dispatching.
| Parameter Name | Type | Description |
|---|---|---|
| $listeners | array | Listener |
Returns: self
Set maximum number of nested forwards allowed
| Parameter Name | Type | Description |
|---|---|---|
| $maxNestedForwards | int |
Returns: self