ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask Class Reference

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

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

Public Member Functions
	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
	getInputTypes ()
	getOutputType ()

Data Fields
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'

Protected Member Functions
	checkTypes (array $values)
	extractType ($value)

Protected Attributes
array	$input = []
Value	$output

Private Member Functions
	getValues (array $values)

Detailed Description

Definition at line 35 of file AbstractTask.php.

Member Function Documentation

checkTypes()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::checkTypes ( array  $values )

protected

Definition at line 56 of file AbstractTask.php.

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\extractType(), and ILIAS\BackgroundTasks\Task\getInputTypes().

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\setInput().

    {
        $expectedTypes = $this->getInputTypes();

        foreach ($expectedTypes as $i => $expectedType) {
            $givenType = $this->extractType($values[$i]);
            if (!$givenType->isExtensionOf($expectedType)) {
                throw new InvalidArgumentException("Types did not match when setting input for "
                    . static::class
                    . ". Expected type $expectedType given type $givenType.");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

extractType()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::extractType (   $value )

protected

Parameters

$value

Value|Task

Exceptions

InvalidArgumentException

Definition at line 74 of file AbstractTask.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\checkTypes().

                                          : Type
    {
        if (is_a($value, Value::class)) {
            return $value->getType();
        }
        if (is_a($value, Task::class)) {
            return $value->getOutputType();
        }

        throw new InvalidArgumentException("Input values must be Tasks or Values (extend BT\\Task or BT\\Value).");
    }

Here is the caller graph for this function:

getAbortOption()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::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.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 160 of file AbstractTask.php.

                                    : Option
    {
        return new UserInteractionOption('abort', self::MAIN_ABORT);
    }

getInput()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::getInput

(

)

Returns

Value[]

Implements ILIAS\BackgroundTasks\Task.

Definition at line 122 of file AbstractTask.php.

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

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\unfoldTask().

                              : array
    {
        return $this->input;
    }

Here is the caller graph for this function:

getOutput()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::getOutput

(

)

Returns

Value Returns a thunk value (yet to be calculated). It's used for task composition and type checks.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 90 of file AbstractTask.php.

References ILIAS\BackgroundTasks\Task\getOutputType().

                               : Value
    {
        $thunk = new ThunkValue($this->getOutputType());
        $thunk->setParentTask($this);

        return $thunk;
    }

Here is the call graph for this function:

getRemoveOption()

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

                                     : Option
    {
        return new UserInteractionOption('remove', self::MAIN_REMOVE);
    }

getType()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::getType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 127 of file AbstractTask.php.

                             : string
    {
        return static::class;
    }

getValues()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::getValues ( array  $values )

private

Parameters

$values

(Value|Task)[]

Returns

Value[]

Definition at line 102 of file AbstractTask.php.

References ILIAS\UI\Implementation\Component\Input\$inputs.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\setInput().

                                             : array
    {
        $inputs = [];

        foreach ($values as $value) {
            if ($value instanceof Task) {
                $inputs[] = $value->getOutput();
            } elseif ($value instanceof Value) {
                $inputs[] = $value;
            } else {
                $inputs[] = $this->wrapScalar($value);
            }
        }

        return $inputs;
    }

Here is the caller graph for this function:

setInput()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::setInput

(

array

$values

)

Parameters

Value[]|Task[]

$values

Implements ILIAS\BackgroundTasks\Task.

Definition at line 50 of file AbstractTask.php.

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\checkTypes(), and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\getValues().

                                           : void
    {
        $this->input = $this->getValues($values);
        $this->checkTypes($this->input);
    }

Here is the call graph for this function:

unfoldTask()

ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::unfoldTask

(

)

Unfold the task.

If task A has dependency B and B' and B has dependency C, the resulting list will be [A, B, C, B'].

Returns

Task[]

Implements ILIAS\BackgroundTasks\Task.

Definition at line 137 of file AbstractTask.php.

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\getInput().

                                : array
    {
        $list = [$this];
        foreach ($this->getInput() as $input) {
            if ($input instanceof ThunkValue) {
                $list = array_merge($list, $input->getParentTask()->unfoldTask());
            }
        }

        return $list;
    }

Here is the call graph for this function:

Field Documentation

$input

array ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::$input = []

protected

Definition at line 44 of file AbstractTask.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob\getInput(), ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\getInput(), ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob\getOutputType(), and ilMailDeliveryJob\run().

$output

Value ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::$output

protected

Definition at line 45 of file AbstractTask.php.

Referenced by ILIAS\BackgroundTasks\Implementation\Tasks\PlusJob\getOutputType(), ilMailDeliveryJob\run(), and ilMassMailDeliveryJob\run().

MAIN_ABORT

const ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::MAIN_ABORT = 'bt_main_abort'

Definition at line 40 of file AbstractTask.php.

MAIN_REMOVE

const ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask::MAIN_REMOVE = 'bt_main_remove'

Definition at line 39 of file AbstractTask.php.

---

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

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