ILIAS\BackgroundTasks\Task Interface Reference

Inheritance diagram for ILIAS\BackgroundTasks\Task:

Collaboration diagram for ILIAS\BackgroundTasks\Task:

Public Member Functions
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()

Detailed Description

Definition at line 21 of file Task.php.

Member Function Documentation

getAbortOption()

ILIAS\BackgroundTasks\Task::getAbortOption

(

)

Returns

Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible.

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

getInput()

ILIAS\BackgroundTasks\Task::getInput

(

)

Returns

Value[]

Implemented in ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask, ILIAS\BackgroundTasks\Task\Job, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\BasicTaskManager\__construct(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveTask().

Here is the caller graph for this function:

getInputTypes()

ILIAS\BackgroundTasks\Task::getInputTypes

(

)

Returns

Type[] A list of types that are taken as input.

Implemented in ilMassMailDeliveryJob, ilExerciseManagementCollectFilesJob, ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger, ilMailDeliveryJob, ILIAS\BackgroundTasks\Implementation\Tasks\Aggregation\ConcatenationJob, ILIAS\File\Sanitation\SanitationReportJob, ilCheckSumOfWorkspaceFileSizesJob, ilSumOfFileSizesTooLargeInteraction, ilCopyWorkspaceFilesToTempDirectoryJob, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilCopyFilesToTempDirectoryJob, ilCalendarCopyFilesToTempDirectoryJob, ilCollectWorkspaceFilesJob, ilCheckSumOfFileSizesJob, ilCollectFilesJob, ilDownloadZipInteraction, ilCalendarDownloadZipInteraction, ilMailDeliveryJobUserInteraction, ilExDownloadSubmissionsZipInteraction, ilZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\SlowPlusJob, ilSubmissionsZipJob, ilCalendarZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob, ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\checkTypes().

Here is the caller graph for this function:

getOutput()

ILIAS\BackgroundTasks\Task::getOutput

(

)

Returns

Value

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

getOutputType()

ILIAS\BackgroundTasks\Task::getOutputType

(

)

Returns

Type A single type.

Implemented in ilMassMailDeliveryJob, ilMailDeliveryJob, ilExerciseManagementCollectFilesJob, ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger, ILIAS\BackgroundTasks\Implementation\Tasks\Aggregation\ConcatenationJob, ILIAS\File\Sanitation\SanitationReportJob, ilCheckSumOfWorkspaceFileSizesJob, ilDownloadZipInteraction, ilCalendarDownloadZipInteraction, ilExDownloadSubmissionsZipInteraction, ilCopyWorkspaceFilesToTempDirectoryJob, ilCopyFilesToTempDirectoryJob, ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilCalendarCopyFilesToTempDirectoryJob, ilCollectWorkspaceFilesJob, ilCheckSumOfFileSizesJob, ilCollectFilesJob, ilMailDeliveryJobUserInteraction, ilZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\SlowPlusJob, ilSubmissionsZipJob, ilCalendarZipJob, ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob, ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\getOutput().

Here is the caller graph for this function:

getRemoveOption()

ILIAS\BackgroundTasks\Task::getRemoveOption

(

)

Returns

Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position)

See also

self::getAbortOption();

Implemented in ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask, ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilDownloadZipInteraction, ilCalendarDownloadZipInteraction, ilExDownloadSubmissionsZipInteraction, and ilMailDeliveryJobUserInteraction.

getType()

ILIAS\BackgroundTasks\Task::getType

(

)

Returns

string

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

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveTask().

Here is the caller graph for this function:

setInput()

ILIAS\BackgroundTasks\Task::setInput

(

array

$values

)

Parameters

$values

(Value|Task)[]

Returns

void

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

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\BasicTaskManager\__construct(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId().

Here is the caller graph for this function:

unfoldTask()

ILIAS\BackgroundTasks\Task::unfoldTask

(

)

Returns

Task[] A list of tasks that is chained with this task. The first element will be this tasks, the following his dependencies.

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

Referenced by ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket\setTask().

Here is the caller graph for this function:

---

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

• src/BackgroundTasks/Task.php