Inheritance diagram for ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger:

Public Member Functions
	getOptions (array $input)

	interaction (array $input, Option $user_selected_option, Bucket $bucket)

	getInputTypes ()

	getOutputType ()

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

	canBeSkipped (array $input)
	@inheritDoc More...

	getSkippedValue (array $input)

	isFinal ()

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

	getType ()

	getInputTypes ()

	getOutputType ()

	getOutput ()

	setInput (array $values)

	getInput ()

	unfoldTask ()

	getRemoveOption ()

	getAbortOption ()

	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)

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

const	MAIN_ABORT = 'bt_main_abort'

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

	extractType ($value)

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

Value	$output

Detailed Description

Definition at line 35 of file DownloadInteger.php.

Member Function Documentation

◆ getInputTypes()

ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger::getInputTypes ( )

Returns: Type[] Class-Name of the IO

Implements ILIAS\BackgroundTasks\Task.

Definition at line 71 of file DownloadInteger.php.

                                   : array
    {
        return [
            new SingleType(IntegerValue::class),
        ];
    }

◆ getOptions()

ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger::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 41 of file DownloadInteger.php.

                                            : array
    {
        return [
            new UserInteractionOption("download", "download"),
        ];
    }

◆ getOutputType()

ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger::getOutputType ( )

Implements ILIAS\BackgroundTasks\Task.

Definition at line 78 of file DownloadInteger.php.

                                   : Type
    {
        return new SingleType(IntegerValue::class);
    }

◆ interaction()

ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger::interaction	(	array	$input,
		Option	$user_selected_option,
		Bucket	$bucket
	)

Parameters

array	$input	The input value of this task.
Option	$user_selected_option	The Option the user chose.
Bucket	$bucket	Notify the bucket about your progress!

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 53 of file DownloadInteger.php.

                                                                                           : Value
    {
        $integerValue = $input[0];
        global $DIC;
 
        if ($user_selected_option->getValue() === "download") {
            $outputter = new \ilPHPOutputDelivery();
            $outputter->start("IntegerFile");
            echo $integerValue->getValue();
            $outputter->stop();
        }
 
        return $integerValue;
    }

References $DIC, ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, and ILIAS\BackgroundTasks\Task\UserInteraction\Option\getValue().

Here is the call graph for this function:

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

components/ILIAS/BackgroundTasks/src/Implementation/Tasks/DownloadInteger.php