Class DownloadSanitationReportUserInteraction. More...

Inheritance diagram for ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction:

Collaboration diagram for ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction:

Public Member Functions
	getInputTypes ()

	getOutputType ()

	getOptions (array $input)

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction
	getMessage (array $input)

	canBeSkipped (array $input)

	getSkippedValue (array $input)

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)

	getOutput ()

	getInput ()

	getType ()

	unfoldTask ()
	Unfold the task. More...

	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(); More...

	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. More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Task\UserInteraction
	interaction (array $input, Option $user_selected_option, Bucket $bucket)

Data Fields
const	OPTION_DOWNLOAD = "download"

const	OPTION_SANITIZE = "sanitize"

Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'

const	MAIN_ABORT = 'bt_main_abort'

Additional Inherited Members
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)

	extractType ($value)

Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	$input = []

	$output

Detailed Description

Class DownloadSanitationReportUserInteraction.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 19 of file DownloadSanitationReportUserInteraction.php.

Member Function Documentation

◆ getInputTypes()

ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction::getInputTypes ( )

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

Implements ILIAS\BackgroundTasks\Task.

Definition at line 25 of file DownloadSanitationReportUserInteraction.php.

     {
         return [new ListType(IntegerValue::class)];
     }

◆ getOptions()

ILIAS\File\Sanitation\DownloadSanitationReportUserInteraction::getOptions ( array $input )

Parameters

Value[] $input The input value of this task.

Returns: Option[] Options are buttons the user can press on this interaction.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 37 of file DownloadSanitationReportUserInteraction.php.

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, $list, ILIAS\BackgroundTasks\Bucket\getTitle(), ILIAS\BackgroundTasks\Task\UserInteraction\Option\getValue(), and ILIAS\BackgroundTasks\Task\UserInteraction\interaction().

     {
         return [
             new UserInteractionOption("download", self::OPTION_DOWNLOAD),
             // new UserInteractionOption("sanitize", self::OPTION_SANITIZE),
         ];
     }