ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction Class Reference

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

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

Public Member Functions
	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...
Public Member Functions inherited from ILIAS\BackgroundTasks\Task
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Task\UserInteraction
	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 29 of file AbstractUserInteraction.php.

Member Function Documentation

canBeSkipped()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction::canBeSkipped

(

array

$input

)

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Reimplemented in ilDownloadZipInteraction, ilSumOfFileSizesTooLargeInteraction, ilMailDeliveryJobUserInteraction, and ilSumOfWorkspaceFileSizesTooLargeInteraction.

Definition at line 42 of file AbstractUserInteraction.php.

                                              : bool
    {
        return false;
    }

getMessage()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction::getMessage

(

array

$input

)

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Reimplemented in ilSumOfFileSizesTooLargeInteraction, ilMailDeliveryJobUserInteraction, and ilSumOfWorkspaceFileSizesTooLargeInteraction.

Definition at line 34 of file AbstractUserInteraction.php.

                                            : string
    {
        return $message = "";
    }

getSkippedValue()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction::getSkippedValue

(

array

$input

)

Parameters

Value[]

$input

See also

canBeSkipped, whenever you decide to skip the UserInteraction, you have to return a valid Value to proceed.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Reimplemented in ilSumOfFileSizesTooLargeInteraction, and ilSumOfWorkspaceFileSizesTooLargeInteraction.

Definition at line 47 of file AbstractUserInteraction.php.

                                                 : Value
    {
        return $input[0];
    }

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input.

isFinal()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction::isFinal

(

)

Returns

bool true if this is the last skippable interaction in your chain/bucket, defaults to true.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Reimplemented in ilSumOfFileSizesTooLargeInteraction, and ilSumOfWorkspaceFileSizesTooLargeInteraction.

Definition at line 52 of file AbstractUserInteraction.php.

                             : bool
    {
        return true;
    }

---

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

• components/ILIAS/BackgroundTasks/src/Implementation/Tasks/AbstractUserInteraction.php