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)
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()

Detailed Description

Definition at line 31 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 ilCollectFilesJob, ilCalendarCopyFilesToTempDirectoryJob, ilCopyFilesToTempDirectoryJob, ilExerciseManagementCollectFilesJob, ilCollectWorkspaceFilesJob, ilCheckSumOfFileSizesJob, ilCheckSumOfWorkspaceFileSizesJob, ilCopyWorkspaceFilesToTempDirectoryJob, ilMailDeliveryJob, ilZipJob, ilMassMailDeliveryJob, ilSubmissionsZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\Aggregation\ConcatenationJob, ilCalendarZipJob, ILIAS\MediaCast\BackgroundTasks\DownloadAllZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob, and ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob.

Referenced by ilBTPopOverGUI\getItemForObserver().

Here is the caller graph for this function:

getInput()

ILIAS\BackgroundTasks\Task\Job::getInput

(

)

Returns

array 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 ilExerciseManagementCollectFilesJob, ilMailDeliveryJob, ilMassMailDeliveryJob, ilCollectFilesJob, ilCalendarCopyFilesToTempDirectoryJob, ilCheckSumOfFileSizesJob, ilZipJob, ilCopyFilesToTempDirectoryJob, ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob, ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob, ilCheckSumOfWorkspaceFileSizesJob, ilCollectWorkspaceFilesJob, ILIAS\BackgroundTasks\Implementation\Tasks\Aggregation\ConcatenationJob, ilCopyWorkspaceFilesToTempDirectoryJob, ilCalendarZipJob, ilSubmissionsZipJob, and ILIAS\MediaCast\BackgroundTasks\DownloadAllZipJob.

run()

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

Parameters

Implemented in ilExerciseManagementCollectFilesJob, ilCalendarCopyFilesToTempDirectoryJob, ilCheckSumOfFileSizesJob, ilCopyFilesToTempDirectoryJob, ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob, ilCalendarZipJob, ilSubmissionsZipJob, ilCopyWorkspaceFilesToTempDirectoryJob, ilMassMailDeliveryJob, and ilMailDeliveryJob.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob\getOutputType().

Here is the caller graph for this function:

---

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

• components/ILIAS/BackgroundTasks/src/Task/Job.php