Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Attributes | List of all members
MvcEvent Class Reference

Public Member Functions

 setApplication (ApplicationInterface $application)
 Set application instance.
 
 getApplication ()
 Get application instance.
 
 getRouter ()
 Get router.
 
 setRouter (RouteStackInterface $router)
 Set router.
 
 getRouteMatch ()
 Get route match.
 
 setRouteMatch (RouteMatch $matches)
 Set route match.
 
 getRequest ()
 Get request.
 
 setRequest (Request $request)
 Set request.
 
 getResponse ()
 Get response.
 
 setResponse (Response $response)
 Set response.
 
 setViewModel (Model $viewModel)
 Set the view model.
 
 getViewModel ()
 Get the view model.
 
 getResult ()
 Get result.
 
 setResult ($result)
 Set result.
 
 isError ()
 Does the event represent an error response?
 
 setError ($message)
 Set the error message (indicating error in handling request)
 
 getError ()
 Retrieve the error message, if any.
 
 getController ()
 Get the currently registered controller name.
 
 setController ($name)
 Set controller name.
 
 getControllerClass ()
 Get controller class.
 
 setControllerClass ($class)
 Set controller class.
 
- Public Member Functions inherited from Event
 __construct ($name=null, $target=null, $params=null)
 Constructor.
 
 getName ()
 Get event name.
 
 getTarget ()
 Get the event target.
 
 setParams ($params)
 Set parameters.
 
 getParams ()
 Get all parameters.
 
 getParam ($name, $default=null)
 Get an individual parameter.
 
 setName ($name)
 Set the event name.
 
 setTarget ($target)
 Set the event target/context.
 
 setParam ($name, $value)
 Set an individual parameter to a value.
 
 stopPropagation ($flag=true)
 Stop further event propagation.
 
 propagationIsStopped ()
 Is propagation stopped?
 

Public Attributes

const EVENT_BOOTSTRAP = 'bootstrap'
 #@+ Mvc events triggered by eventmanager
 
const EVENT_DISPATCH = 'dispatch'
 
const EVENT_DISPATCH_ERROR = 'dispatch.error'
 
const EVENT_FINISH = 'finish'
 
const EVENT_RENDER = 'render'
 
const EVENT_RENDER_ERROR = 'render.error'
 
const EVENT_ROUTE = 'route'
 

Protected Attributes

 $application
 #@-
 
 $request
 
 $response
 
 $result
 
 $router
 
 $routeMatch
 
 $viewModel
 
- Protected Attributes inherited from Event
 $name
 
 $target
 
 $params = []
 
 $stopPropagation = false
 

Member Function Documentation

getApplication ( )

Get application instance.

Returns
ApplicationInterface
getController ( )

Get the currently registered controller name.

Returns
string
getControllerClass ( )

Get controller class.

Returns
string
getError ( )

Retrieve the error message, if any.

Returns
string
getRequest ( )

Get request.

Returns
Request
getResponse ( )

Get response.

Returns
Response
getResult ( )

Get result.

Returns
mixed
getRouteMatch ( )

Get route match.

Returns
null|RouteMatch
getRouter ( )

Get router.

Returns
RouteStackInterface
getViewModel ( )

Get the view model.

Returns
Model
isError ( )

Does the event represent an error response?

Returns
bool
setApplication ( ApplicationInterface  $application)

Set application instance.

Parameters
ApplicationInterface$application
Returns
MvcEvent
setController (   $name)

Set controller name.

Parameters
string$name
Returns
MvcEvent
setControllerClass (   $class)

Set controller class.

Parameters
string$class
Returns
MvcEvent
setError (   $message)

Set the error message (indicating error in handling request)

Parameters
string$message
Returns
MvcEvent
setRequest ( Request  $request)

Set request.

Parameters
Request$request
Returns
MvcEvent
setResponse ( Response  $response)

Set response.

Parameters
Response$response
Returns
MvcEvent
setResult (   $result)

Set result.

Parameters
mixed$result
Returns
MvcEvent
setRouteMatch ( RouteMatch  $matches)

Set route match.

Parameters
RouteMatch$matches
Returns
MvcEvent
setRouter ( RouteStackInterface  $router)

Set router.

Parameters
RouteStackInterface$router
Returns
MvcEvent
setViewModel ( Model  $viewModel)

Set the view model.

Parameters
Model$viewModel
Returns
MvcEvent

Member Data Documentation

$application
protected

#@-

$request
protected
$response
protected
$result
protected
$routeMatch
protected
$router
protected
$viewModel
protected
const EVENT_BOOTSTRAP = 'bootstrap'

#@+ Mvc events triggered by eventmanager

const EVENT_DISPATCH = 'dispatch'
const EVENT_DISPATCH_ERROR = 'dispatch.error'
const EVENT_FINISH = 'finish'
const EVENT_RENDER = 'render'
const EVENT_RENDER_ERROR = 'render.error'
const EVENT_ROUTE = 'route'