\hhu\z\agentsQuesttypeAgent

Abstract class for implementing a QuesttypeAgent.

Summary

Methods

Properties

Constants

load()
factory()
run()
render()
checkClass()
saveAnswersOfCharacter()
matchAnswersOfCharacter()

$controller

INLINEERROR_AGENT

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

$log
$subAgents

N/A

getAgentType()
getClassName()
newSubAgent()
renderSubAgent()
errorInline()
newInlineError()
newInlineErrorService()
loadClass()

$request
$response

N/A

abstract

File: app/agents/QuesttypeAgent.inc
Package: Default
Class hierarchy: \nre\core\Agent

\nre\agents\BottomlevelAgent

\hhu\z\agents\QuesttypeAgent

Tags

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

Constants

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

Methods

load()

load(string  $questtypeName)

Load a QuesttypeAgent.

Parameters

string

$questtypeName

Name of the QuesttypeAgent to load

Throws

\hhu\z\exceptions\QuesttypeAgentNotFoundException
\hhu\z\exceptions\QuesttypeAgentNotValidException

static

Tags

static

factory()

factory(string  $questtypeName, \hhu\z\agents\Request  $request, \hhu\z\agents\Response  $response, \hhu\z\agents\Logger  $log = null)

Instantiate a QuesttypeAgent (Factory Pattern).

Parameters

string	$questtypeName	Name of the QuesttypeAgent to instantiate
\hhu\z\agents\Request	$request	Current request
\hhu\z\agents\Response	$response	Current respone
\hhu\z\agents\Logger	$log	Log-system

Throws

\nre\exceptions\DatamodelException
\nre\exceptions\DriverNotValidException
\nre\exceptions\DriverNotFoundException
\nre\exceptions\ViewNotFoundException
\hhu\z\exceptions\QuesttypeModelNotValidException
\hhu\z\exceptions\QuesttypeModelNotFoundException
\hhu\z\exceptions\QuesttypeControllerNotValidException
\hhu\z\exceptions\QuesttypeControllerNotFoundException

static

Tags

static

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

checkClass()

checkClass(string  $className, string  $parentClassName)

Check inheritance of the QuesttypeAgent-class.

Parameters

string	$className	Name of the class to check
string	$parentClassName	Name of the parent class

Throws

\nre\exceptions\ClassNotValidException

static

Tags

static

saveAnswersOfCharacter()

saveAnswersOfCharacter(array  $seminary, array  $questgroup, array  $quest, array  $character, array  $answers)

Save the answers of a Character for a Quest.

Parameters

array	$seminary	Current Seminary data
array	$questgroup	Current Questgroup data
array	$quest	Current Quest data
array	$character	Current Character data
array	$answers	Character answers for the Quest

matchAnswersOfCharacter()

matchAnswersOfCharacter(array  $seminary, array  $questgroup, array  $quest, array  $character, array  $answers)

Check if answers of a Character for a Quest match the correct ones.

Parameters

array	$seminary	Current Seminary data
array	$questgroup	Current Questgroup data
array	$quest	Current Quest data
array	$character	Current Character data
array	$answers	Character answers for the Quest

__construct()

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

Construct a new QuesttypeAgent.

Parameters

\nre\core\Request	$request	Current request
\nre\core\Response	$response	Current 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
\hhu\z\exceptions\QuesttypeModelNotValidException
\hhu\z\exceptions\QuesttypeModelNotFoundException
\hhu\z\exceptions\QuesttypeControllerNotValidException
\hhu\z\exceptions\QuesttypeControllerNotFoundException

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
\hhu\z\exceptions\QuesttypeModelNotValidException
\hhu\z\exceptions\QuesttypeModelNotFoundException
\hhu\z\exceptions\QuesttypeControllerNotValidException
\hhu\z\exceptions\QuesttypeControllerNotFoundException

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\AgentNotFoundException
\nre\exceptions\AgentNotValidException

_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

getAgentType()

getAgentType() : string

Determine the type of an Agent.

Returns

string —

Agent type

static

Inherited from: \nre\core\Agent

Tags

static

getClassName()

getClassName(string  $questtypeName, string  $agentType = null) : string

Determine the Agent-classname for the given Questtype-name.

Parameters

string	$questtypeName	Questtype-name to get Agent-classname of
string	$agentType	Agent type of given Agent name

Returns

string —

Classname for the Questtype-name

static

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.

loadClass()

loadClass(string  $questtypeName, string  $fullClassName)

Load the class of a QuesttypeAgent.

Parameters

string	$questtypeName	Name of the QuesttypeAgent to load
string	$fullClassName	Name of the class to load

Throws

\nre\exceptions\ClassNotFoundException

static

Tags

static