PHP Class Gc\Mvc\Controller\Action

Inheritance: extends Zend\Mvc\Controller\AbstractActionController

Show file Open project: gotcms/gotcms Class Usage Examples

Protected Properties

Property	Type	Description
$aclPage	array	Abstract acl
$installerRoutes	array	Route available for installer
$routeMatch	Zend\Mvc\Router\RouteMatch	RouteMatch
$session	Zend\Session\Container	Session storage

Public Methods

Method	Description
events ( ) : StaticEventManager	Retrieve event manager
getRouteMatch ( ) : Zend\Mvc\Router\Http\RouteMatch	Return matched route
getSession ( ) : Zend\Session\Container	Get session storage
init ( ) : mixed	Initiliaze
onDispatch ( MvcEvent $e ) : mixed	Execute the request
returnJson ( array $data ) : Zend\View\Model\JsonModel	Return json model
setAcl ( array $array ) : void	Override aclPage property
useFlashMessenger ( boolean $forceDisplay = true ) : void	Initiliaze flash messenger

Protected Methods

Method	Description
checkAcl ( Model $userModel ) : Zend\Http\Response \| null	Check user acl
construct ( ) : Zend\Http\Response \| null	Constructor

Method Details

checkAcl() protected method

Check user acl

protected checkAcl ( Model $userModel ) : Zend\Http\Response \| null
$userModel	Gc\User\Model	User model
return	Zend\Http\Response \| null

construct() protected method

Constructor

protected construct ( ) : Zend\Http\Response \| null
return	Zend\Http\Response \| null

events() public method

Retrieve event manager

public events ( ) : StaticEventManager
return	Gc\Event\StaticEventManager

getRouteMatch() public method

Return matched route

public getRouteMatch ( ) : Zend\Mvc\Router\Http\RouteMatch
return	Zend\Mvc\Router\Http\RouteMatch

getSession() public method

Get session storage

public getSession ( ) : Zend\Session\Container
return	Zend\Session\Container

init() public method

Initiliaze

public init ( ) : mixed
return	mixed

onDispatch() public method

Execute the request

public onDispatch ( MvcEvent $e ) : mixed
$e	Zend\Mvc\MvcEvent	Mvc Event
return	mixed

returnJson() public method

Return json model

public returnJson ( array $data ) : Zend\View\Model\JsonModel
$data	array	Data
return	Zend\View\Model\JsonModel

setAcl() public method

Override aclPage property

public setAcl ( array $array ) : void
$array	array	Array for acl pages
return	void

useFlashMessenger() public method

Initiliaze flash messenger

public useFlashMessenger ( boolean $forceDisplay = true ) : void
$forceDisplay	boolean	Force display
return	void

Property Details

$aclPage protected property

Abstract acl

protected array $aclPage
return	array

$installerRoutes protected property

Route available for installer

protected array $installerRoutes
return	array

$routeMatch protected property

RouteMatch

protected RouteMatch,Zend\Mvc\Router $routeMatch
return	Zend\Mvc\Router\RouteMatch

$session protected property

Session storage

protected Container,Zend\Session $session
return	Zend\Session\Container