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 ()
	@inheritDoc More...

	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)
	@inheritDoc More...

	canBeSkipped (array $input)
	@inheritDoc More...

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

	getType ()

	getInputTypes ()

	getOutputType ()

	getOutput ()

	setInput (array $values)

	getInput ()

	unfoldTask ()

	getRemoveOption ()

	getAbortOption ()

Public Member Functions inherited from ILIAS\BackgroundTasks\Task\UserInteraction
	getOptions (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)

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

	getMessage (array $input)

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

Class ilCertificateMigrationReducedInteraction.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

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

ilCertificateMigrationReducedInteraction constructor.

Parameters

ilLogger | null $log

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

      {
        global $DIC;
 
        if (null === $log) {
            $log = $DIC->logger()->cert();
        }
        $this->log = $log;
    }

References $DIC, and $log.

Member Function Documentation

◆ getOptions()

ilCertificateMigrationReducedInteraction::getOptions ( array $input )

Parameters

array $input

Returns: array|\ILIAS\BackgroundTasks\Task\UserInteraction\Option[]

Reimplemented from ilCertificateMigrationInteraction.

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

                                             : array
    {
        return [];
    }

◆ 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|\ILIAS\BackgroundTasks\Value

Reimplemented from ilCertificateMigrationInteraction.

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

    {
        $progress = $input[0]->getValue();
        $user_id = $input[1]->getValue();
 
        $this->log->debug('User interaction certificate migration for user with id: ' . $user_id);
        $this->log->debug('User interaction certificate migration State: ' . $bucket->getState());
        $this->log->info('User interaction certificate migration canceled for user with id: ' . $user_id);
 
        return $input;
    }