BatchDisplayController Class Reference

Detailed Description

BatchDisplayController is used to load a tree of Node instances recursivly and return them in lists of a given size.

The reconstruction of the tree must be handled by the client.

The controller supports the following actions:

Action default

Load the Nodes.

Parameter	Description
in / out oid	The object id of the Node to start loading from
in translateValues	Boolean whether list values should be translated to their display values (optional, default: true)
in nodesPerCall	The number of Node instances to load in one call (default: 50)
out list	Array of Node instances

For additional actions and parameters see BatchController actions.

Author

ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 49 of file BatchDisplayController.php.

Inheritance diagram for BatchDisplayController:

Public Member Functions
	initialize (Request $request, Response $response)
Public Member Functions inherited from Controller
	__construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration)
	execute ($method=null)
	getRequest ()
	getResponse ()

Public Attributes
const	REGISTRY_VAR = 'registry'
const	ITERATOR_ID_VAR = 'BatchDisplayController.iteratorid'
const	NODES_PER_CALL = 50
Public Attributes inherited from BatchController
const	REQUEST_VAR = 'request'
const	ONE_CALL_VAR = 'oneCall'
const	STEP_VAR = 'step'
const	NUM_STEPS_VAR = 'numSteps'
const	DOWNLOAD_STEP_VAR = 'downloadStep'
const	PACKAGES_VAR = 'packages'
Public Attributes inherited from Controller
const	CSRF_TOKEN_PARAM = 'csrf_token'

Protected Member Functions
	validate ()
	getWorkPackage ($number)
	startProcess ($oids)
	loadNodes ($oids)
	endProcess ()
	loadNode (ObjectId $oid)
	register (ObjectId $oid)
	isRegistered (ObjectId $oid)
	addNodeToResponse (Node $node)
Protected Member Functions inherited from BatchController
	doExecute ($method=null)
	getStepNumber ()
	addWorkPackage ($name, $size, array $oids, $callback, $args=null)
	processPart ($step)
	getRequestValue ($name)
	getNumberOfSteps ()
	getDisplayText ($step)
	getDownloadFile ()
	cleanup ()
Protected Member Functions inherited from Controller
	executeSubAction ($action)
	redirect ($location, $key=null, $data=null)
	getLogger ()
	getSession ()
	getPersistenceFacade ()
	getPermissionManager ()
	getActionMapper ()
	getLocalization ()
	getMessage ()
	getConfiguration ()
	requireTransaction ()
	endTransaction ($commit)
	isLocalizedRequest ()
	checkLanguageParameter ()
	generateCsrfToken ($name, $refresh=true)
	validateCsrfToken ($name, $invalidate=true)
	getLocalSessionValue ($key, $default=null)
	setLocalSessionValue ($key, $value)
	clearLocalSessionValues ()

Member Function Documentation

initialize()

initialize	(	Request	$request,
		Response	$response
	)

See also

Controller::initialize()

Reimplemented from BatchController.

Definition at line 63 of file BatchDisplayController.php.

validate()

validate ( )

protected

See also

Controller::validate()

Reimplemented from Controller.

Definition at line 89 of file BatchDisplayController.php.

getWorkPackage()

getWorkPackage (   $number )

protected

See also

BatchController::getWorkPackage()

Reimplemented from BatchController.

Definition at line 110 of file BatchDisplayController.php.

startProcess()

startProcess (   $oids )

protected

Initialize the iterator (object ids parameter will be ignored)

Parameters

$oids

The object ids to process

Definition at line 124 of file BatchDisplayController.php.

loadNodes()

loadNodes (   $oids )

protected

Load nodes provided by the persisted iterator (object ids parameter will be ignored)

Parameters

$oids

The object ids to process

Definition at line 158 of file BatchDisplayController.php.

endProcess()

endProcess ( )

protected

Finish the process and set the result.

Definition at line 200 of file BatchDisplayController.php.

loadNode()

loadNode ( ObjectId  $oid )

protected

Load the node with the given object id and assign it to the response.

Parameters

$oid	The object id of the node to copy

Definition at line 208 of file BatchDisplayController.php.

register()

register ( ObjectId  $oid )

protected

Register an object id in the registry.

Parameters

$oid	The object id to register

Definition at line 260 of file BatchDisplayController.php.

isRegistered()

isRegistered ( ObjectId  $oid )

protected

Check if an object id is registered in the registry.

Parameters

$oid	The object id to check

Returns

Boolean whether the object id is registered or not

Definition at line 271 of file BatchDisplayController.php.

addNodeToResponse()

addNodeToResponse ( Node  $node )

protected

Add a given node to the list variable of the response.

Parameters

$node

The Node instance to add

Definition at line 280 of file BatchDisplayController.php.

Member Data Documentation

REGISTRY_VAR

const REGISTRY_VAR = 'registry'

Definition at line 52 of file BatchDisplayController.php.

ITERATOR_ID_VAR

const ITERATOR_ID_VAR = 'BatchDisplayController.iteratorid'

Definition at line 55 of file BatchDisplayController.php.

NODES_PER_CALL

const NODES_PER_CALL = 50

Definition at line 58 of file BatchDisplayController.php.