BatchDisplayController Class Reference

Inheritance diagram for BatchDisplayController:

Public Member Functions
	initialize (&$request, &$response)
	validate ()
	getWorkPackage ($number)
	getDisplayText ($step)
	startProcess ($oids)
	loadNodes ($oids)
	endProcess ()
	loadNode ($oid)
	register ($oid)
	isRegistered ($oid)
	addNodeToResponse (&$node)
Public Member Functions inherited from BatchController
	initialize (&$request, &$response)
	addWorkPackage ($name, $size, $oids, $callback, $args=null)
	getWorkPackage ($number)
	getNumberOfSteps ()
	getDisplayText ($step)
	getSummaryText ()
	processPart ()
Public Member Functions inherited from LongTaskController
	initialize (&$request, &$response)
	hasView ()
	executeKernel ()
	getStepNumber ()
	getNumberOfSteps ()
	getDisplayText ($step)
	getSummaryText ()
	initializeTask ()
	processPart ()
Public Member Functions inherited from Controller
	Controller (&$delegate)
	initialize (&$request, &$response)
	validate ()
	hasView ()
	execute ()
	executeKernel ()
	getErrorMsg ()
	setErrorMsg ($msg)
	appendErrorMsg ($msg)
&	getRequest ()
&	getResponse ()
&	getView ()
&	getDelegate ()
	getViewTemplate ($controller, $context, $action)
	getCacheId ()
	assignViewDefaults (&$view)
	isLocalizedRequest ()

Public Attributes
	$REQUEST = 'BatchDisplayController.request'
	$REGISTRY = 'BatchDisplayController.registry'
	$ITERATOR_ID = 'BatchDisplayController.iteratorid'
	$_NODES_PER_CALL = 50
Public Attributes inherited from BatchController
	$WORK_PACKAGES_VARNAME = 'BatchController.workPackages'
	$NUM_STEPS_VARNAME = 'BatchController.numSteps'
	$_workPackages = array()
Public Attributes inherited from LongTaskController
	$STEP_SESSION_VARNAME = 'LongTaskController.curStep'
	$ONE_CALL_SESSION_VARNAME = 'LongTaskController.oneCall'
	$_curStep = 1
Public Attributes inherited from Controller
	$_request = null
	$_response = null
	$_errorMsg = ''
	$_view = null
	$_delegate = null

Detailed Description

BatchDisplayController is a controller that loads a tree of Nodes recursivly and returns the Nodes in lists of a given size. The reconstruction of the tree must be handled by the client.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

• GNU Lesser General Public License (LGPL) http://www.gnu.org/licenses/lgpl.html
• Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php

See the license.txt file distributed with this work for additional information.

Id:

class.BatchDisplayController.php 1079 2009-09-08 15:21:33Z iherwig

Input actions:

• see BatchController

Output actions:

• see BatchController

Parameters

[in,out]	oid	The oid of the Node to start loading from
[in]	translateValues	True/False. If true, list values will be translated using FormUtil::translateValue. If not given, all values will be returned as is, default: true
[in]	nodes_per_call	The number of nodes to process in one call, default: 50
[out]	objects	An array of Nodes

Author

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

Definition at line 46 of file class.BatchDisplayController.php.

Member Function Documentation

BatchDisplayController::initialize	(	&	$request,
		&	$response
	)

See Also

Controller::initialize()

Definition at line 59 of file class.BatchDisplayController.php.

References SessionData\getInstance().

Here is the call graph for this function:

BatchDisplayController::validate

(

)

See Also

Controller::validate()

Definition at line 85 of file class.BatchDisplayController.php.

References Controller\appendErrorMsg().

Here is the call graph for this function:

BatchDisplayController::getWorkPackage

(

$number

)

See Also

BatchController::getWorkPackage()

Definition at line 102 of file class.BatchDisplayController.php.

References Message\get().

Here is the call graph for this function:

BatchDisplayController::getDisplayText

(

$step

)

See Also

LongTaskController::getDisplayText()

Definition at line 114 of file class.BatchDisplayController.php.

BatchDisplayController::startProcess

(

$oids

)

Copy/Move the first node (oids parameter will be ignored)

Parameters

oids	The oids to process

Definition at line 122 of file class.BatchDisplayController.php.

References BatchController\addWorkPackage(), endProcess(), Message\get(), SessionData\getInstance(), and loadNode().

Here is the call graph for this function:

BatchDisplayController::loadNodes

(

$oids

)

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

Parameters

oids	The oids to process

Definition at line 159 of file class.BatchDisplayController.php.

References BatchController\addWorkPackage(), endProcess(), Message\get(), SessionData\getInstance(), PersistentIterator\load(), and loadNode().

Here is the call graph for this function:

BatchDisplayController::endProcess

(

)

Finish the process and set the result

Definition at line 210 of file class.BatchDisplayController.php.

References SessionData\getInstance().

Referenced by loadNodes(), and startProcess().

Here is the call graph for this function:

BatchDisplayController::loadNode

(

$oid

)

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

Parameters

oid	The oid of the node to copy

Definition at line 224 of file class.BatchDisplayController.php.

References addNodeToResponse(), Log\debug(), PersistenceFacade\getInstance(), Localization\getInstance(), SessionData\getInstance(), Log\info(), Log\isDebugEnabled(), Log\isInfoEnabled(), Controller\isLocalizedRequest(), isRegistered(), WCMFException\throwEx(), and NodeUtil\translateValues().

Referenced by loadNodes(), and startProcess().

Here is the call graph for this function:

BatchDisplayController::register

(

$oid

)

Register an object id in the registry

Parameters

oid	The object id to register

Definition at line 277 of file class.BatchDisplayController.php.

References SessionData\getInstance().

Here is the call graph for this function:

BatchDisplayController::isRegistered

(

$oid

)

Check if an object id is registered in the registry

Parameters

oid	The object id to check

Returns

True/False wether the oid is registered or not

Definition at line 289 of file class.BatchDisplayController.php.

References SessionData\getInstance().

Referenced by loadNode().

Here is the call graph for this function:

BatchDisplayController::addNodeToResponse

(

&

$node

)

Add a given node to the objects variable of the response

Parameters

node	A reference to the node to add

Definition at line 300 of file class.BatchDisplayController.php.

Referenced by loadNode().

Member Data Documentation

BatchDisplayController::$REQUEST = 'BatchDisplayController.request'

Definition at line 49 of file class.BatchDisplayController.php.

BatchDisplayController::$REGISTRY = 'BatchDisplayController.registry'

Definition at line 50 of file class.BatchDisplayController.php.

BatchDisplayController::$ITERATOR_ID = 'BatchDisplayController.iteratorid'

Definition at line 51 of file class.BatchDisplayController.php.

BatchDisplayController::$_NODES_PER_CALL = 50

Definition at line 54 of file class.BatchDisplayController.php.

---

The documentation for this class was generated from the following file:

• C:/Users/ingo/Daten/web/htdocs/wcmf3.x/SVN/framework/wcmf/application/controller/class.BatchDisplayController.php