Inheritance diagram for ILIAS\BackgroundTasks\Task\UserInteraction:
Collaboration diagram for ILIAS\BackgroundTasks\Task\UserInteraction:
Public Member Functions | |
| getOptions (array $input) | |
| canBeSkipped (array $input) | |
| Decide whether the UserInteraction is presented to the user and he has to decide or user UserInteraction is skipped by the TaskManager. More... | |
| getSkippedValue (array $input) | |
| isFinal () | |
| interaction (array $input, Option $user_selected_option, Bucket $bucket) | |
| getMessage (array $input) | |
| 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 UserInteraction.php.
Member Function Documentation
◆ canBeSkipped()
| ILIAS\BackgroundTasks\Task\UserInteraction::canBeSkipped | ( | array | $input | ) |
Decide whether the UserInteraction is presented to the user and he has to decide or user UserInteraction is skipped by the TaskManager.
You must return a valid Value then,
- Parameters
-
Value[] $input The input value of this task.
- Returns
- bool
- See also
- getSkippedValue.
Implemented in ilSumOfWorkspaceFileSizesTooLargeInteraction, ilSumOfFileSizesTooLargeInteraction, ilMailDeliveryJobUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.
Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\SyncTaskManager\run().
Here is the caller graph for this function:
◆ getMessage()
| ILIAS\BackgroundTasks\Task\UserInteraction::getMessage | ( | array | $input | ) |
- Parameters
-
Value[] $input The input value of this task.
- Returns
- string $message enables the UserInteraction to be used as a notification (for example when a bucket fails due to an expected condition not being met)
Implemented in ilSumOfWorkspaceFileSizesTooLargeInteraction, ilSumOfFileSizesTooLargeInteraction, ilMailDeliveryJobUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.
◆ getOptions()
| ILIAS\BackgroundTasks\Task\UserInteraction::getOptions | ( | array | $input | ) |
- Parameters
-
Value[] $input The input value of this task.
- Returns
- Option[] Options are buttons the user can press on this interaction.
Implemented in ilExDownloadSubmissionsZipInteraction, ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilDownloadZipInteraction, ilSumOfFileSizesTooLargeInteraction, ilCalendarDownloadZipInteraction, ilMailDeliveryJobUserInteraction, ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger, and ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction.
◆ getSkippedValue()
| ILIAS\BackgroundTasks\Task\UserInteraction::getSkippedValue | ( | array | $input | ) |
- Parameters
-
Value[] $input
- Returns
- Value
- See also
- canBeSkipped, whenever you decide to skip the UserInteraction, you have to return a valid Value to proceed.
Implemented in ilSumOfWorkspaceFileSizesTooLargeInteraction, ilSumOfFileSizesTooLargeInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.
◆ interaction()
| ILIAS\BackgroundTasks\Task\UserInteraction::interaction | ( | array | $input, |
| Option | $user_selected_option, | ||
| Bucket | $bucket | ||
| ) |
- Parameters
-
\ILIAS\BackgroundTasks\Value[] $input The input value of this task. Option $user_selected_option The Option the user chose. Bucket $bucket Notify the bucket about your progress!
- Returns
- Value
Implemented in ilExDownloadSubmissionsZipInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilDownloadZipInteraction, ilSumOfFileSizesTooLargeInteraction, ilCalendarDownloadZipInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction.
◆ isFinal()
| ILIAS\BackgroundTasks\Task\UserInteraction::isFinal | ( | ) |
- Returns
- bool true if this is the last skippable interaction in your chain/bucket, defaults to true.
Implemented in ilSumOfFileSizesTooLargeInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.
The documentation for this interface was generated from the following file:
- src/BackgroundTasks/Task/UserInteraction.php
