ilSumOfFileSizesTooLargeInteraction Class Reference

Class ilSumOfFileSizesTooLargeInteraction. More...

Inheritance diagram for ilSumOfFileSizesTooLargeInteraction:

Collaboration diagram for ilSumOfFileSizesTooLargeInteraction:

Public Member Functions
	__construct ()
	getInputTypes ()
	Returns Type[] A list of types that are taken as input. More...
	getOutputType ()
	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...
	interaction (array $input, Option $user_selected_option, Bucket $bucket)
	getOptions (array $input)
	Parameters Value[] $input The input value of this task. Returns Option[] Options are buttons the user can press on this interaction. More...
	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) More...
	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. More...
	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. More...
	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...

Data Fields
const	OPTION_OK = 'ok'
const	OPTION_SKIP = 'skip'
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'

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

Private Attributes
	$logger = null

Additional Inherited Members
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($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 17 of file class.ilSumOfFileSizesTooLargeInteraction.php.

Constructor & Destructor Documentation

__construct()

ilSumOfFileSizesTooLargeInteraction::__construct

(

)

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

References $DIC.

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

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.

Returns

bool

See also

getSkippedValue.

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

                                               : bool
    {
        $copy_definition = $input[0];
        if ($copy_definition->getAdheresToLimit()->getValue()) {
            // 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 true;
        } else {
            return false;
        }
    }

getInputTypes()

ilSumOfFileSizesTooLargeInteraction::getInputTypes

(

)

Returns

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

Implements ILIAS\BackgroundTasks\Task.

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

    {
        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 95 of file class.ilSumOfFileSizesTooLargeInteraction.php.

References $message.

    {
        return $message = $this->lng->txt('ui_msg_files_violate_maxsize');
    }

getOptions()

ilSumOfFileSizesTooLargeInteraction::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 86 of file class.ilSumOfFileSizesTooLargeInteraction.php.

    {
        return array();
    }

getOutputType()

ilSumOfFileSizesTooLargeInteraction::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

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

    {
        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 63 of file class.ilSumOfFileSizesTooLargeInteraction.php.

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

getSkippedValue()

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

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

                                                  : Value
    {
        return $input[0];
    }

interaction()

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

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

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

    {
        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 $definition = $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 127 of file class.ilSumOfFileSizesTooLargeInteraction.php.

                             : bool
    {
        return false;
    }

Field Documentation

$lng

ilSumOfFileSizesTooLargeInteraction::$lng

protected

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

$logger

ilSumOfFileSizesTooLargeInteraction::$logger = null

private

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

OPTION_OK

const ilSumOfFileSizesTooLargeInteraction::OPTION_OK = 'ok'

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

OPTION_SKIP

const ilSumOfFileSizesTooLargeInteraction::OPTION_SKIP = 'skip'

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

---

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

• Services/BackgroundTasks/classes/UserInteractions/class.ilSumOfFileSizesTooLargeInteraction.php