\hhu\z\agents\toplevelBinaryAgent

Agent to display binary data (e. g. images).

Summary

Methods

Properties

Constants

run()
render()
getIntermediateAgent()
load()
factory()
index()

$controller

STAGE_LOAD
STAGE_RUN
INLINEERROR_AGENT

__construct()
addSubAgent()
actionConstruct()
loadController()
log()
_addSubAgent()

$log
$subAgents

N/A

loadIntermediateAgent()
_loadIntermediateAgent()
_run()
runIntermediateAgent()
error()
getAgentType()
getClassName()
newSubAgent()
renderSubAgent()
errorInline()
newInlineError()
newInlineErrorService()

$request
$response
$layout
$intermediateAgent

N/A

File: agents/toplevel/BinaryAgent.inc
Package: Default
Class hierarchy: \nre\core\Agent

\nre\agents\ToplevelAgent

\hhu\z\agents\ToplevelAgent

\hhu\z\agents\toplevel\BinaryAgent

Tags

author	Oliver Hanraths oliver.hanraths@uni-duesseldorf.de

Constants

STAGE_LOAD

STAGE_LOAD

Stage: Load

STAGE_RUN

STAGE_RUN

Stage: Run

INLINEERROR_AGENT

INLINEERROR_AGENT

Name of BottomlevelAgent for showing inline errors

Properties

$controller

$controller : \nre\core\Controller

Controller of this Agent

Type

\nre\core\Controller

$log

$log : \nre\core\Logger

Log-system

Type

\nre\core\Logger

$subAgents

$subAgents : array

SubAgents

Type

array

$request

$request : \nre\core\Request

Current request

Type

\nre\core\Request

$response

$response : \nre\core\Response

Current response

Type

\nre\core\Response

$layout

$layout : \nre\core\Layout

Layout instace

Type

\nre\core\Layout

$intermediateAgent

$intermediateAgent : \nre\agents\IntermediateAgent

IntermediateAgent instance

Type

\nre\agents\IntermediateAgent

Methods

run()

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

Run the Controller of this Agent and its SubAgents.

Parameters

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

Throws

\nre\exceptions\ParamsNotValidException
\nre\exceptions\IdNotFoundException
\nre\exceptions\DatamodelException
\nre\exceptions\ActionNotFoundException

Returns

\Exception —

Last occurred exception of SubAgents

render()

render(array  $data = array()) : string

Generate output of the Controller of this Agent and its SubAgents.

Parameters

array

$data

View data

Returns

string —

Generated output

getIntermediateAgent()

getIntermediateAgent() : \nre\agents\IntermediateAgent

Return the IntermediateAgent.

Returns

\nre\agents\IntermediateAgent —

IntermediateAgent

load()

load(string  $agentName)

Load the class of an Agent.

Parameters

string

$agentName

Name of the Agent to load

Throws

\nre\exceptions\AgentNotFoundException
\nre\exceptions\AgentNotValidException

static

Inherited from: \nre\core\Agent

Tags

static

factory()

factory(string  $agentName, \nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)

Instantiate an Agent (Factory Pattern).

Parameters

string	$agentName	Name of the Agent to instantiate
\nre\core\Request	$request	Current request
\nre\core\Response	$response
\nre\core\Logger	$log	Log-system

Throws

\nre\exceptions\DatamodelException
\nre\exceptions\DriverNotValidException
\nre\exceptions\DriverNotFoundException
\nre\exceptions\ViewNotFoundException
\nre\exceptions\ModelNotValidException
\nre\exceptions\ModelNotFoundException
\nre\exceptions\ControllerNotValidException
\nre\exceptions\ControllerNotFoundException

static

Inherited from: \nre\core\Agent

Tags

static

index()

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

Action: index.

Parameters

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

__construct()

__construct(\nre\core\Request  $request, \nre\core\Response  $response, \nre\core\Logger  $log = null)

Construct a new BinaryAgent.

Parameters

\nre\core\Request	$request	Current request
\nre\core\Response	$response	Current response
\nre\core\Logger	$log	Logger instance

addSubAgent()

addSubAgent(string  $agentName)

Load a SubAgent and add it.

Parameters

string

$agentName

Name of the Agent to load

Throws

\nre\exceptions\ServiceUnavailableException
\nre\exceptions\AgentNotFoundException
\nre\exceptions\AgentNotValidException

actionConstruct()

actionConstruct()

Construct SubAgents (per Action).

loadController()

loadController()

Load the Controller of this Agent.

Throws

\nre\exceptions\DatamodelException
\nre\exceptions\DriverNotValidException
\nre\exceptions\DriverNotFoundException
\nre\exceptions\ViewNotFoundException
\nre\exceptions\ModelNotValidException
\nre\exceptions\ModelNotFoundException
\nre\exceptions\ControllerNotValidException
\nre\exceptions\ControllerNotFoundException

log()

log(\Exception  $exception, integer  $logMode)

Log an error.

Parameters

\Exception	$exception	Occurred exception
integer	$logMode	Log mode

_addSubAgent()

_addSubAgent(string  $agentName)

Load a SubAgent and add it.

Parameters

string

$agentName

Name of the Agent to load

Throws

\nre\exceptions\ServiceUnavailableException
\nre\exceptions\DatamodelException
\nre\exceptions\AgentNotFoundException
\nre\exceptions\AgentNotValidException

loadIntermediateAgent()

loadIntermediateAgent()

Load IntermediateAgent defined by the current request.

Throws

\nre\exceptions\ServiceUnavailableException

_loadIntermediateAgent()

_loadIntermediateAgent()

Load IntermediateAgent defined by the current request.

Throws

\nre\exceptions\ServiceUnavailableException

_run()

_run(\nre\core\Request  $request, \nre\core\Response  $response) : \Exception

Run the Controller of this Agent and its SubAgents.

Parameters

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

Throws

\nre\exceptions\AccessDeniedException
\nre\exceptions\IdNotFoundException
\nre\exceptions\ServiceUnavailableException
\nre\exceptions\DatamodelException

Returns

\Exception —

Last occurred exception of SubAgents

runIntermediateAgent()

runIntermediateAgent()

Run IntermediateAgent.

Throws

\nre\exceptions\AccessDeniedException
\nre\exceptions\ParamsNotValidException
\nre\exceptions\IdNotFoundException
\nre\exceptions\ServiceUnavailableException
\nre\exceptions\DatamodelException

error()

error(\Exception  $exception, integer  $httpStatusCode, string  $stage = self::STAGE_LOAD)

Handle an error that occurred during loading/cnostructing/running of the IntermediateAgent.

Parameters

\Exception	$exception	Occurred exception
integer	$httpStatusCode	HTTP-statuscode
string	$stage	Stage of execution

Throws

\nre\exceptions\ServiceUnavailableException

getAgentType()

getAgentType() : string

Determine the type of an Agent.

Returns

string —

Agent type

static

Inherited from: \nre\core\Agent

Tags

static

getClassName()

getClassName(string  $agentName, string  $agentType) : string

Determine the classname for the given Agent name.

Parameters

string	$agentName	Agent name to get classname of
string	$agentType	Agent type of given Agent name

Returns

string —

Classname for the Agent name

static

Inherited from: \nre\core\Agent

Tags

static

newSubAgent()

newSubAgent(string  $agentName) : array

Create a new SubAgent.

Parameters

string

$agentName

Agent name

Throws

\nre\exceptions\DatamodelException

Returns

array —

SubAgent

renderSubAgent()

renderSubAgent(array  $subAgent) : string

Render a SubAgent.

Parameters

array

$subAgent

SubAgent to render

Returns

string —

Generated output

errorInline()

errorInline(array  $subAgent, \nre\core\Request  $request, \nre\core\Excepiton  $exception) : array

Handle the exception of a SubAgent.

Parameters

array	$subAgent	Original (Sub-) Agent
\nre\core\Request	$request	Current request
\nre\core\Excepiton	$exception	Occurred exception

Returns

array —

InlineError-SubAgent

newInlineError()

newInlineError(string  $label, \Exception  $exception)

Create a new InlineError.

Parameters

string	$label	Name of the original Agent
\Exception	$exception	Occurred exception

newInlineErrorService()

newInlineErrorService()

Handle a hardcore error that could not be handled by the system.