ILIAS  trunk Revision v11.0_alpha-1831-g8615d53dadb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction Class Reference

Class NotFoundUserInteraction. More...

+ Inheritance diagram for ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction:
+ Collaboration diagram for ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction:

Public Member Functions

 getInputTypes ()
 
 getOutputType ()
 
 getOptions (array $input)
 
 interaction (array $input, Option $user_selected_option, Bucket $bucket)
 
- 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...
 

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

Member Function Documentation

◆ getInputTypes()

ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction::getInputTypes ( )
Returns
mixed[]

Implements ILIAS\BackgroundTasks\Task.

Definition at line 37 of file NotFoundUserInteraction.php.

37  : array
38  {
39  return [];
40  }

◆ getOptions()

ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction::getOptions ( array  $input)
Returns
mixed[]

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 50 of file NotFoundUserInteraction.php.

50  : array
51  {
52  return [];
53  }

◆ getOutputType()

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

Implements ILIAS\BackgroundTasks\Task.

Definition at line 42 of file NotFoundUserInteraction.php.

42  : Type
43  {
44  return new SingleType('none');
45  }

◆ interaction()

ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction::interaction ( array  $input,
Option  $user_selected_option,
Bucket  $bucket 
)
Parameters
Value[]$input The input value of this task.
Option$user_selected_optionThe Option the user chose.
Bucket$bucketNotify the bucket about your progress!

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 55 of file NotFoundUserInteraction.php.

55  : Value
56  {
57  return new BooleanValue();
58  }

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