Class ilCertificateMigrationInteraction. More...

Inheritance diagram for ilCertificateMigrationInteraction:

Collaboration diagram for ilCertificateMigrationInteraction:

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

Data Fields
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'

Additional Inherited Members
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)

	extractType ($value)

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

	$output

Detailed Description

Class ilCertificateMigrationInteraction.

Author: Ralph Dittrich dittr.nosp@m.ich@.nosp@m.quali.nosp@m.tus..nosp@m.de

Definition at line 15 of file class.ilCertificateMigrationInteraction.php.

Member Function Documentation

◆ getInputTypes()

ilCertificateMigrationInteraction::getInputTypes ( )

Returns: array|\ILIAS\BackgroundTasks\Types\Type[]

Implements ILIAS\BackgroundTasks\Task.

Definition at line 23 of file class.ilCertificateMigrationInteraction.php.

                                    : array
    {
        return [
            new SingleType(IntegerValue::class),
            new SingleType(IntegerValue::class),
        ];
    }

◆ getOptions()

ilCertificateMigrationInteraction::getOptions ( array $input )

Parameters

array $input

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

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Reimplemented in ilCertificateMigrationReducedInteraction.

Definition at line 51 of file class.ilCertificateMigrationInteraction.php.

                                             : array
    {
        return [
            new UserInteractionOption('my_certificates', self::OPTION_GOTO_LIST),
        ];
    }

◆ getOutputType()

ilCertificateMigrationInteraction::getOutputType ( )

Returns: SingleType|\ILIAS\BackgroundTasks\Types\Type

Implements ILIAS\BackgroundTasks\Task.

Definition at line 34 of file class.ilCertificateMigrationInteraction.php.

                                    : SingleType
    {
        return new SingleType(StringValue::class);
    }

◆ getRemoveOption()

ilCertificateMigrationInteraction::getRemoveOption ( )

@inheritDoc

Reimplemented from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask.

Definition at line 42 of file class.ilCertificateMigrationInteraction.php.

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

◆ interaction()

ilCertificateMigrationInteraction::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 in ilCertificateMigrationReducedInteraction.

Definition at line 64 of file class.ilCertificateMigrationInteraction.php.

    {
        global $DIC;
 
        $progress = $input[0]->getValue();
        $user_id = $input[1]->getValue();
        $logger = $DIC->logger()->cert();
 
        $logger->debug('User interaction certificate migration for user with id: ' . $user_id);
        $logger->debug('User interaction certificate migration State: ' . $bucket->getState());
        if ($user_selected_option->getValue() != self::OPTION_GOTO_LIST) {
            $logger->info('User interaction certificate migration canceled for user with id: ' . $user_id);
            return $input;
        }
 
        $DIC->ctrl()->redirectByClass([
            'ilPersonalDesktopGUI',
            'ilAchievementsGUI',
            'ilUserCertificateGUI'
        ], 'listCertificates');
 
        return $input;
    }

References $DIC, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input.

Field Documentation

◆ OPTION_CANCEL

const ilCertificateMigrationInteraction::OPTION_CANCEL = 'cancel'

Definition at line 18 of file class.ilCertificateMigrationInteraction.php.

◆ OPTION_GOTO_LIST

const ilCertificateMigrationInteraction::OPTION_GOTO_LIST = 'listCertificates'

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

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

Services/Certificate/classes/BackgroundTasks/class.ilCertificateMigrationInteraction.php

Public Member Functions

Data Fields

Additional Inherited Members