Zend Framework
Back to top  

Abstract controller

Convenience methods for pre-built plugins (@see __call):

 Methods

Method overloading: return/call plugins

__call(string $method, array $params) : mixed

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

Parameters

$method

string

$params

array

Returns

mixed

acceptableViewModelSelector() 

acceptableViewModelSelector(array $matchAgainst, bool $returnDefault, \Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart $resultReference) : \Zend\View\Model\ModelInterface

magic
method

Parameters

$matchAgainst

array

$returnDefault

bool

$resultReference

\Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart

Returns

\Zend\View\Model\ModelInterface

createConsoleNotFoundModel() 

createConsoleNotFoundModel() : \Zend\View\Model\ConsoleModel

magic
method

Returns

\Zend\View\Model\ConsoleModel

createHttpNotFoundModel() 

createHttpNotFoundModel() : \Zend\View\Model\ViewModel

magic
method

Returns

\Zend\View\Model\ViewModel

Dispatch a request

dispatch(\Zend\Stdlib\RequestInterface $request, \Zend\Stdlib\ResponseInterface $response) : \Zend\Stdlib\ResponseInterface | mixed

events dispatch.pre, dispatch.post

Parameters

$request

\Zend\Stdlib\RequestInterface

$response

null\Zend\Stdlib\ResponseInterface

Returns

\Zend\Stdlib\ResponseInterfacemixed

filePostRedirectGet() 

filePostRedirectGet(\Zend\Form\FormInterface $form, $redirect =, $redirectToUrl =) : bool | array | \Zend\Http\Response

magic
method

Parameters

$form

\Zend\Form\FormInterface

=

$redirect$redirectToUrl

=

$redirect$redirectToUrl

Returns

boolarray\Zend\Http\Response

fileprg() 

fileprg(\Zend\Form\FormInterface $form, $redirect =, $redirectToUrl =) : bool | array | \Zend\Http\Response

magic
method

Parameters

$form

\Zend\Form\FormInterface

=

$redirect$redirectToUrl

=

$redirect$redirectToUrl

Returns

boolarray\Zend\Http\Response

flashMessenger() 

flashMessenger() : \Zend\Mvc\Controller\Plugin\FlashMessenger

magic
method

Returns

\Zend\Mvc\Controller\Plugin\FlashMessenger

forward() 

forward() : \Zend\Mvc\Controller\Plugin\Forward

magic
method

Returns

\Zend\Mvc\Controller\Plugin\Forward

Get the attached event

getEvent() : \Zend\Mvc\MvcEvent

Will create a new MvcEvent if none provided.

Returns

\Zend\Mvc\MvcEvent

Retrieve the event manager

getEventManager() : \Zend\EventManager\EventManagerInterface

Lazy-loads an EventManager instance if none registered.

Returns

\Zend\EventManager\EventManagerInterface

Transform an "action" token into a method name

getMethodFromAction(string $action) : string

Parameters

$action

string

Returns

string

Get plugin manager

getPluginManager() : \Zend\Mvc\Controller\PluginManager

Returns

\Zend\Mvc\Controller\PluginManager

Get request object

getRequest() : \Zend\Stdlib\RequestInterface

Returns

\Zend\Stdlib\RequestInterface

Get response object

getResponse() : \Zend\Stdlib\ResponseInterface

Returns

\Zend\Stdlib\ResponseInterface

Retrieve serviceManager instance

getServiceLocator() : \Zend\ServiceManager\ServiceLocatorInterface

Returns

\Zend\ServiceManager\ServiceLocatorInterface

identity() 

identity() : mixed | null

magic
method

Returns

mixednull

layout() 

layout(string $template) : \Zend\Mvc\Controller\Plugin\Layout | \Zend\View\Model\ModelInterface

magic
method

Parameters

$template

string

Returns

\Zend\Mvc\Controller\Plugin\Layout\Zend\View\Model\ModelInterface

Execute the request

onDispatch(\Zend\Mvc\MvcEvent $e) : mixed

Parameters

$e

\Zend\Mvc\MvcEvent

Returns

mixed

params() 

params(string $param, mixed $default) : \Zend\Mvc\Controller\Plugin\Params | mixed

magic
method

Parameters

$param

string

$default

mixed

Returns

\Zend\Mvc\Controller\Plugin\Paramsmixed

Get plugin instance

plugin(string $name, array $options) : mixed

Parameters

$name

string

Name of plugin to return

$options

nullarray

Options to pass to plugin constructor (if not already instantiated)

Returns

mixed

postRedirectGet() 

postRedirectGet(string $redirect, bool $redirectToUrl) : \Zend\Http\Response | array

magic
method

Parameters

$redirect

string

$redirectToUrl

bool

Returns

\Zend\Http\Responsearray

prg() 

prg(string $redirect, bool $redirectToUrl) : \Zend\Http\Response | array

magic
method

Parameters

$redirect

string

$redirectToUrl

bool

Returns

\Zend\Http\Responsearray

redirect() 

redirect() : \Zend\Mvc\Controller\Plugin\Redirect

magic
method

Returns

\Zend\Mvc\Controller\Plugin\Redirect

Set an event to use during dispatch

setEvent(\Zend\EventManager\EventInterface $e) : void

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

Parameters

$e

\Zend\EventManager\EventInterface

Set the event manager instance used by this context

setEventManager(\Zend\EventManager\EventManagerInterface $events) : \Zend\Mvc\Controller\AbstractController

Parameters

$events

\Zend\EventManager\EventManagerInterface

Returns

\Zend\Mvc\Controller\AbstractController

Set plugin manager

setPluginManager(\Zend\Mvc\Controller\PluginManager $plugins) : \Zend\Mvc\Controller\AbstractController

Parameters

$plugins

\Zend\Mvc\Controller\PluginManager

Returns

\Zend\Mvc\Controller\AbstractController

Set serviceManager instance

setServiceLocator(\Zend\ServiceManager\ServiceLocatorInterface $serviceLocator) : void

Parameters

$serviceLocator

\Zend\ServiceManager\ServiceLocatorInterface

url() 

url() : \Zend\Mvc\Controller\Plugin\Url

magic
method

Returns

\Zend\Mvc\Controller\Plugin\Url

Register the default events for this controller

attachDefaultListeners() : void

 Properties

 

$event

$event : \Zend\EventManager\EventInterface

 

$eventIdentifier

$eventIdentifier : null | string | string[]

 

$events

$events : \Zend\EventManager\EventManagerInterface

 

$plugins

$plugins : \Zend\Mvc\Controller\PluginManager

 

$request

$request : \Zend\Stdlib\RequestInterface

 

$response

$response : \Zend\Stdlib\ResponseInterface

 

$serviceLocator

$serviceLocator : \Zend\ServiceManager\ServiceLocatorInterface