\hhu\z\controllersErrorController

Controller of the Agent to show an error page.

Summary

Methods

Properties

Constants

preFilter()
postFilter()
load()
factory()
run()
render()
index()

$components

No constants found

__construct()
log()
set()
redirect()
checkModels()
getView()
loadModels()
loadView()

$log
$linker
$agent
$view
$viewData
$request
$response

N/A

getClassName()
loadComponents()

No private properties found

N/A

File: controllers/ErrorController.inc
Package: Default
Class hierarchy: \nre\core\Controller

\hhu\z\Controller

\hhu\z\controllers\ErrorController

Properties

$components

$components : array

Required components

Type

array

$log

$log : \hhu\z\Logger

Logger instance

Type

\hhu\z\Logger

$linker

$linker : \hhu\z\Linker

Linker instance

Type

\hhu\z\Linker

$agent

$agent : \nre\core\Agent

Corresponding Agent

Type

\nre\core\Agent

$view

$view : \nre\core\View

View of the Controller

Type

\nre\core\View

$viewData

$viewData : array

Data to pass to the View

Type

array

$request

$request : \nre\core\Request

Current request

Type

\nre\core\Request

$response

$response : \nre\core\Response

Current response

Type

\nre\core\Response

Methods

preFilter()

preFilter(\nre\core\Request  $request, \nre\core\Response  $response)

Prefilter that is executed before running the Controller.

Parameters

\nre\core\Request	$request	Current request
\nre\core\Response	$response	Current response

postFilter()

postFilter(\nre\core\Request  $request, \nre\core\Response  $response)

Prefilter that is executed after running the Controller.

Parameters

\nre\core\Request	$request	Current request
\nre\core\Response	$response	Current response

load()

load(string  $controllerName)

Load the class of a Controller.

Parameters

string

$controllerName

Name of the Controller to load

Throws

\nre\core\ControllerNotFoundException
\nre\core\ControllerNotValidException

factory()

factory(string  $controllerName, string  $layoutName, string  $action,   $agent)

Instantiate a Controller (Factory Pattern).

Parameters

string	$controllerName	Name of the Controller to instantiate
string	$layoutName	Name of the current Layout
string	$action	Current Action
	$agent

Throws

\nre\core\DatamodelException
\nre\core\DriverNotFoundException
\nre\core\DriverNotValidException
\nre\core\ModelNotValidException
\nre\core\ModelNotFoundException
\nre\core\ViewNotFoundException

run()

run(\nre\core\Request  $request, \nre\core\Response  $response)

Run the Controller.

This method executes the Action of the Controller defined by the current Request.

Parameters

\nre\core\Request	$request	Current request
\nre\core\Response	$response	Current response

Throws

\nre\core\ParamsNotValidException
\nre\core\IdNotFoundException
\nre\core\DatamodelException
\nre\core\ActionNotFoundException

render()

render(array  $viewData = null) : string

Generate the output.

Parameters

array

$viewData

Data to pass to the View

Returns

string —

Generated output

index()

index(integer  $httpStatusCode)

Action: index.

Set HTTP-header and print an error message.

Parameters

integer

$httpStatusCode

HTTP-statuscode of the error that occurred

__construct()

__construct(string  $layoutName, string  $action, \nre\core\Agent  $agent)

Construct a new Controller.

Parameters

string	$layoutName	Name of the current Layout
string	$action	Current Action
\nre\core\Agent	$agent	Corresponding Agent

Throws

\nre\core\DriverNotFoundException
\nre\core\DriverNotValidException
\nre\core\ModelNotValidException
\nre\core\ModelNotFoundException
\nre\core\ViewNotFoundException

log()

log(string  $message, integer  $logMode = \nre\core\Logger::LOGMODE_AUTO)

Log an error.

Parameters

string	$message	Error message to log
integer	$logMode	Log mode (optional)

set()

set(string  $name, mixed  $data)

Set data for the View.

Parameters

string	$name	Key
mixed	$data	Value

redirect()

redirect(string  $url)

Redirect to the given URL.

Parameters

string

$url

Relative URL

checkModels()

checkModels(string  $modelName) : boolean

Check if Models of this Controller are loaded and available.

Parameters

string

$modelName

Arbitrary number of Models to check

Returns

boolean —

All given Models are loaded and available

getView()

getView() : \nre\core\View

Get the View of the Controller

Returns

\nre\core\View —

View of the Controller

loadModels()

loadModels()

Load the Models of this Controller.

Throws

\nre\core\DatamodelException
\nre\core\DriverNotFoundException
\nre\core\DriverNotValidException
\nre\core\ModelNotValidException
\nre\core\ModelNotFoundException

loadView()

loadView(string  $layoutName, string  $action)

Load the View of this Controller.

Parameters

string	$layoutName	Name of the current Layout
string	$action	Current Action

Throws

\nre\core\ViewNotFoundException

getClassName()

getClassName(string  $controllerName) : string

Determine the classname for the given Controller name.

Parameters

string

$controllerName

Controller name to get classname of

Returns

string —

Classname for the Controller name

loadComponents()

loadComponents()

Load the Components of this Controller.

Throws

\nre\core\ComponentNotValidException
\nre\core\ComponentNotFoundException