BatchController Class Reference
[Controller]

BatchController allows to define work packages that will be processed in a sequence. It simplifies the usage of LongTaskController functionality for splitting different bigger tasks into many smaller (similar) tasks where the whole number of tasks isn't known at designtime. More...

Inheritance diagram for BatchController:

[legend]


Public Member Functions
	initialize (&$request, &$response)
	addWorkPackage ($name, $size, $oids, $callback, $args=null)
	getWorkPackage ($number)
	getNumberOfSteps ()
	getDisplayText ($step)
	processPart ()
Data Fields
	$WORK_PACKAGES_VARNAME = 'BatchController.workPackages'
	$NUM_STEPS_VARNAME = 'BatchController.numSteps'
	$_workPackages = array()

Detailed Description

BatchController allows to define work packages that will be processed in a sequence. It simplifies the usage of LongTaskController functionality for splitting different bigger tasks into many smaller (similar) tasks where the whole number of tasks isn't known at designtime.

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.BatchController.php 929 2009-02-22 23:20:49Z iherwig

Input actions:

continue Process next work package if any
unspecified: Initialized work packages

Output actions:

see LongTaskController

Author:: ingo herwig <ingo@wemove.com>

Definition at line 38 of file class.BatchController.php.

Member Function Documentation

initialize	(	&$	request,
		&$	response
	)

See also:: Controller::initialize()

Reimplemented from LongTaskController.

Reimplemented in BackupController, MySQLBackupController, PageExportController, and XMLExportController.

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

References addWorkPackage(), PersistenceFacade::getInstance(), SessionData::getInstance(), getWorkPackage(), and WCMFException::throwEx().

Here is the call graph for this function:

addWorkPackage	(	$	name,
		$	size,
		$	oids,
		$	callback,
		$	args = `null`
	)

Add a work package to session. This package will be devided into sub packages of given size.

Parameters:

	name	Display name of the package (will be supplemented by startNumber-endNumber, e.g. '1-7', '8-14', ...)
	size	Size of one sub package. This defines how many of the oids will be passed to the callback in one call (e.g. '7' means pass 7 oids per call)
	oids	An array of oids (or other application specific package identifiers) that will be distributed into sub packages of given size

Note:: The array must contain at least one value

Parameters:

callback

The name of method to call for this package type

Note:

The callback method must accept the following parameters:

one array parameter (the oids to process in the current call)
optionally array parameter (the additional arguments)

Parameters:

args

Assoziative array of additional callback arguments (application specific) [default: null]

Definition at line 99 of file class.BatchController.php.

References SessionData::getInstance(), and WCMFException::throwEx().

Referenced by XMLExportController::exportNodes(), XMLExportController::initExport(), and initialize().

Here is the call graph for this function:

getWorkPackage ( $ number )

Get definitions of work packages.

Parameters:

number

The number of the work package (first number is 0, number is incremented on every call)

Note:: This function gets called on first initialization run as often until it returns null. This allows to define different static work packages. If you would like to add work packages dynamically on subsequent runs this may be done by directly calling the BatchController::addWorkPackage() method.

Returns:: A work packages description as assoziative array with keys 'name', 'size', 'oids', 'callback' as required for BatchController::addWorkPackage() method or null to terminate.