ilSumOfFileSizesTooLargeInteraction Class Reference

Class ilSumOfFileSizesTooLargeInteraction. More...

Inheritance diagram for ilSumOfFileSizesTooLargeInteraction:

Collaboration diagram for ilSumOfFileSizesTooLargeInteraction:

Public Member Functions
	__construct ()
	getInputTypes ()
	getOutputType ()
	getRemoveOption ()
	interaction (array $input, Option $user_selected_option, Bucket $bucket)
	getOptions (array $input)
	getMessage (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 ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction
	getMessage (array $input)
	canBeSkipped (array $input)
	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...

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

Private Attributes
const	OPTION_OK = 'ok'

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)

Detailed Description

Class ilSumOfFileSizesTooLargeInteraction.

Author

Lukas Zehnder lz@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Definition at line 32 of file class.ilSumOfFileSizesTooLargeInteraction.php.

Constructor & Destructor Documentation

__construct()

ilSumOfFileSizesTooLargeInteraction::__construct

(

)

Definition at line 41 of file class.ilSumOfFileSizesTooLargeInteraction.php.

References $DIC, and ILIAS\Repository\lng().

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('background_tasks');
    }

Here is the call graph for this function:

Member Function Documentation

canBeSkipped()

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

See also

getSkippedValue.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 94 of file class.ilSumOfFileSizesTooLargeInteraction.php.

                                              : bool
    {
        $copy_definition = $input[0];
        // skip the user interaction if the adherence to the global limit for the sum of file sizes
        // hasn't been violated (as this interaction is used as an error message and mustn't be
        // shown when everything is fine))
        return (bool) $copy_definition->getAdheresToLimit()->getValue();
    }

getInputTypes()

ilSumOfFileSizesTooLargeInteraction::getInputTypes

(

)

Returns

SingleType[]

Implements ILIAS\BackgroundTasks\Task.

Definition at line 51 of file class.ilSumOfFileSizesTooLargeInteraction.php.

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

getMessage()

ilSumOfFileSizesTooLargeInteraction::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)

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 88 of file class.ilSumOfFileSizesTooLargeInteraction.php.

References ILIAS\Repository\lng().

                                            : string
    {
        return $this->lng->txt('ui_msg_files_violate_maxsize');
    }

Here is the call graph for this function:

getOptions()

ilSumOfFileSizesTooLargeInteraction::getOptions

(

array

$input

)

Returns

mixed[]

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 82 of file class.ilSumOfFileSizesTooLargeInteraction.php.

                                            : array
    {
        return [];
    }

getOutputType()

ilSumOfFileSizesTooLargeInteraction::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 58 of file class.ilSumOfFileSizesTooLargeInteraction.php.

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

getRemoveOption()

ilSumOfFileSizesTooLargeInteraction::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();

Implements ILIAS\BackgroundTasks\Task.

Definition at line 64 of file class.ilSumOfFileSizesTooLargeInteraction.php.

                                     : Option
    {
        return new UserInteractionOption('ok', self::OPTION_OK);
    }

getSkippedValue()

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

Definition at line 104 of file class.ilSumOfFileSizesTooLargeInteraction.php.

                                                 : Value
    {
        return $input[0];
    }

interaction()

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

Parameters

	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!

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 69 of file class.ilSumOfFileSizesTooLargeInteraction.php.

References ILIAS\BackgroundTasks\Task\UserInteraction\Option\getValue(), and ILIAS\BackgroundTasks\Bucket\setState().

                                                                                           : Value
    {
        if ($user_selected_option->getValue() === self::OPTION_OK) {
            // Set state to finished to stop the BackgroundTask and remove it from the popover.
            $bucket->setState(3);
        }

        return $input[0];
    }

Here is the call graph for this function:

isFinal()

ilSumOfFileSizesTooLargeInteraction::isFinal

(

)

Returns

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

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 110 of file class.ilSumOfFileSizesTooLargeInteraction.php.

                             : bool
    {
        return false;
    }

Field Documentation

$lng

ilLanguage ilSumOfFileSizesTooLargeInteraction::$lng

protected

Definition at line 39 of file class.ilSumOfFileSizesTooLargeInteraction.php.

OPTION_OK

const ilSumOfFileSizesTooLargeInteraction::OPTION_OK = 'ok'

private

Definition at line 37 of file class.ilSumOfFileSizesTooLargeInteraction.php.

---

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

• components/ILIAS/BackgroundTasks_/classes/UserInteractions/class.ilSumOfFileSizesTooLargeInteraction.php