Summary

Fully Qualified Name:	Laminas\Mvc\Console\Controller\AbstractConsoleController
Extends:	AbstractActionController

Description

Methods

Name	Description	Defined By
__call()	Method overloading: return/call plugins	AbstractController
dispatch()	{@inheritdoc}	AbstractConsoleController
getConsole()		AbstractConsoleController
getEvent()	Get the attached event	AbstractController
getEventManager()	Retrieve the event manager	AbstractController
getMethodFromAction()	Transform an "action" token into a method name	AbstractController
getPluginManager()	Get plugin manager	AbstractController
getRequest()	Get request object	AbstractController
getResponse()	Get response object	AbstractController
indexAction()	Default action if none provided	AbstractActionController
notFoundAction()	Action called if matched action does not exist.	AbstractConsoleController
onDispatch()	Execute the request	AbstractActionController
plugin()	Get plugin instance	AbstractController
setConsole()		AbstractConsoleController
setEvent()	Set an event to use during dispatch	AbstractController
setEventManager()	Set the event manager instance used by this context	AbstractController
setPluginManager()	Set plugin manager	AbstractController

Method Details

__call()

Method overloading: return/call plugins

If the plugin is a functor, call it, passing the parameters provided. Otherwise, return the plugin instance.

Parameter Name	Type	Description
$method	string
$params	array

Returns: mixed

dispatch()

{@inheritdoc}

Parameter Name	Type	Description
$request
$response

Returns:

getConsole()

Returns: \ConsoleAdapter

getEvent()

Get the attached event

Will create a new MvcEvent if none provided.

Returns: \MvcEvent

getEventManager()

Retrieve the event manager

Lazy-loads an EventManager instance if none registered.

Returns: \EventManagerInterface

getMethodFromAction()

Transform an "action" token into a method name

Parameter Name	Type	Description
$action	string

Returns: string

getPluginManager()

Get plugin manager

Returns: \PluginManager

getRequest()

Get request object

Returns: \Request

getResponse()

Get response object

Returns: \Response

indexAction()

Default action if none provided

Returns: \ViewModel

notFoundAction()

Action called if matched action does not exist.

Returns: \ViewModel

onDispatch()

Execute the request

Parameter Name	Type	Description
$e	\MvcEvent

Returns: mixed

plugin()

Get plugin instance

Parameter Name	Type	Description
$name	string	Name
$options	null|array	Options

Returns: mixed

setConsole()

Parameter Name	Type	Description
$console	\ConsoleAdapter

Returns:

setEvent()

Set an event to use during dispatch

By default, will re-cast to MvcEvent if another event type is provided.

Parameter Name	Type	Description
$e	\Event

Returns: void

setEventManager()

Set the event manager instance used by this context

Parameter Name	Type	Description
$events	\EventManagerInterface

Returns: \AbstractController

setPluginManager()

Set plugin manager

Parameter Name	Type	Description
$plugins	\PluginManager

Returns: \AbstractController