ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilCertificateMigrationReducedInteraction Class Reference

Class ilCertificateMigrationReducedInteraction. More...

+ Inheritance diagram for ilCertificateMigrationReducedInteraction:
+ Collaboration diagram for ilCertificateMigrationReducedInteraction:

Public Member Functions

 __construct (\ilLogger $log=null)
 ilCertificateMigrationReducedInteraction constructor. More...
 
 getOptions (array $input)
 
 interaction (array $input, \ILIAS\BackgroundTasks\Task\UserInteraction\Option $user_selected_option, \ILIAS\BackgroundTasks\Bucket $bucket)
 
- Public Member Functions inherited from ilCertificateMigrationInteraction
 getInputTypes ()
 
 getOutputType ()
 
 getRemoveOption ()
 
 getOptions (array $input)
 
 interaction (array $input, \ILIAS\BackgroundTasks\Task\UserInteraction\Option $user_selected_option, \ILIAS\BackgroundTasks\Bucket $bucket)
 
- Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction
 getMessage (array $input)
 
 canBeSkipped (array $input)
 
 getSkippedValue (array $input)
 
- 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\UserInteraction
 interaction (array $input, Option $user_selected_option, Bucket $bucket)
 

Protected Attributes

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

Additional Inherited Members

- Data Fields inherited from ilCertificateMigrationInteraction
const OPTION_GOTO_LIST = 'listCertificates'
 
const OPTION_CANCEL = 'cancel'
 
- 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 ($values)
 
 extractType ($value)
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilCertificateMigrationReducedInteraction::__construct ( \ilLogger  $log = null)

ilCertificateMigrationReducedInteraction constructor.

Parameters
ilLogger | null$log

Definition at line 17 of file class.ilCertificateMigrationReducedInteraction.php.

References $DIC, and $log.

19  {
20  global $DIC;
21 
22  if (null === $log) {
23  $log = $DIC->logger()->cert();
24  }
25  $this->log = $log;
26  }
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ getOptions()

ilCertificateMigrationReducedInteraction::getOptions ( array  $input)
Parameters
array$input
Returns
array|[]

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

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

32  : array
33  {
34  return [];
35  }

◆ interaction()

ilCertificateMigrationReducedInteraction::interaction ( array  $input,
\ILIAS\BackgroundTasks\Task\UserInteraction\Option  $user_selected_option,
\ILIAS\BackgroundTasks\Bucket  $bucket 
)
Parameters
array$input
\ILIAS\BackgroundTasks\Task\UserInteraction\Option$user_selected_option
\ILIAS\BackgroundTasks\Bucket$bucket
Returns
array|

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

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

44  {
45  $progress = $input[0]->getValue();
46  $user_id = $input[1]->getValue();
47 
48  $this->log->debug('User interaction certificate migration for user with id: ' . $user_id);
49  $this->log->debug('User interaction certificate migration State: ' . $bucket->getState());
50  $this->log->info('User interaction certificate migration canceled for user with id: ' . $user_id);
51 
52  return $input;
53  }

Field Documentation

◆ $log

ilCertificateMigrationReducedInteraction::$log
protected

Definition at line 11 of file class.ilCertificateMigrationReducedInteraction.php.

Referenced by __construct().


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