ILIAS\BackgroundTasks\Task\Job Interface Reference

Inheritance diagram for ILIAS\BackgroundTasks\Task\Job:

Collaboration diagram for ILIAS\BackgroundTasks\Task\Job:

Public Member Functions
	run (array $input, Observer $observer)
	isStateless ()
	getInput ()
	getExpectedTimeOfTaskInSeconds ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Task
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()

Detailed Description

Definition at line 17 of file Job.php.

Member Function Documentation

getExpectedTimeOfTaskInSeconds()

ILIAS\BackgroundTasks\Task\Job::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implemented in ilCalendarCopyFilesToTempDirectoryJob, ilCalendarZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\Aggregation\ConcatenationJob, ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob, and ILIAS\BackgroundTasks\Implementation\Tasks\SlowPlusJob.

getInput()

ILIAS\BackgroundTasks\Task\Job::getInput

(

)

Returns

mixed returns the input array

Implements ILIAS\BackgroundTasks\Task.

Implemented in ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob.

isStateless()

ILIAS\BackgroundTasks\Task\Job::isStateless

(

)

Returns

bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implemented in ilCalendarCopyFilesToTempDirectoryJob, ilCalendarZipJob, ilCalFileZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\Aggregation\ConcatenationJob, ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob, and ILIAS\BackgroundTasks\Implementation\Tasks\SlowPlusJob.

run()

ILIAS\BackgroundTasks\Task\Job::run	(	array	$input,
		Observer	$observer
	)

Parameters

\ILIAS\BackgroundTasks\Value[]	$input	This will be a list of Values hinted by getInputTypes.
Observer	$observer	Notify the bucket about your progress!

Returns

Value The returned Value must be of the type hinted by getOutputType.

Implemented in ilCalendarCopyFilesToTempDirectoryJob.

---

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

• src/BackgroundTasks/Task/Job.php