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.

ingo herwig

Definition at line 48 of file BatchDisplayController.php.

+ Inheritance diagram for BatchDisplayController:

Public Member Functions

 initialize (Request $request, Response $response)
- Public Member Functions inherited from BatchController
 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)
 initialize (Request $request, Response $response)
 execute ($method=null)
 getRequest ()
 getResponse ()

Public Attributes

const REGISTRY_VAR = 'registry'
const ITERATOR_ID_VAR = 'BatchDisplayController.iteratorid'
- 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, $oids, $callback, $args=null)
 processPart ($step)
 getRequestValue ($name)
 getNumberOfSteps ()
 getDisplayText ($step)
 getDownloadFile ()
 getWorkPackage ($number)
 cleanup ()
- Protected Member Functions inherited from Controller
 validate ()
 doExecute ($method=null)
 executeSubAction ($action)
 redirect ($location, $key=null, $data=null)
 getLogger ()
 getSession ()
 getPersistenceFacade ()
 getPermissionManager ()
 getActionMapper ()
 getLocalization ()
 getMessage ()
 getConfiguration ()
 requireTransaction ()
 endTransaction ($commit)
 isLocalizedRequest ()
 checkLanguageParameter ()
 generateCsrfToken ($name)
 validateCsrfToken ($name)
 getLocalSessionValue ($key, $default=null)
 setLocalSessionValue ($key, $value)
 clearLocalSessionValues ()

Member Function Documentation

◆ initialize()

initialize ( Request  $request,
Response  $response 
See also

Definition at line 62 of file BatchDisplayController.php.

◆ validate()

validate ( )
See also

Definition at line 88 of file BatchDisplayController.php.

◆ getWorkPackage()

getWorkPackage (   $number)

◆ startProcess()

startProcess (   $oids)

Initialize the iterator (object ids parameter will be ignored)

$oidsThe object ids to process

Definition at line 123 of file BatchDisplayController.php.

◆ loadNodes()

loadNodes (   $oids)

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

$oidsThe object ids to process

Definition at line 157 of file BatchDisplayController.php.

◆ endProcess()

endProcess ( )

Finish the process and set the result.

Definition at line 199 of file BatchDisplayController.php.

◆ loadNode()

loadNode ( ObjectId  $oid)

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

$oidThe object id of the node to copy

Definition at line 207 of file BatchDisplayController.php.

◆ register()

register ( ObjectId  $oid)

Register an object id in the registry.

$oidThe object id to register

Definition at line 259 of file BatchDisplayController.php.

◆ isRegistered()

isRegistered ( ObjectId  $oid)

Check if an object id is registered in the registry.

$oidThe object id to check
Boolean whether the object id is registered or not

Definition at line 270 of file BatchDisplayController.php.

◆ addNodeToResponse()

addNodeToResponse ( Node  $node)

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

$nodeThe Node instance to add

Definition at line 279 of file BatchDisplayController.php.

Member Data Documentation


const REGISTRY_VAR = 'registry'

Definition at line 51 of file BatchDisplayController.php.


const ITERATOR_ID_VAR = 'BatchDisplayController.iteratorid'

Definition at line 54 of file BatchDisplayController.php.