Class ilCertificateMigrationGUI. More...

Collaboration diagram for ilCertificateMigrationGUI:

Public Member Functions
	__construct (\ilCtrl $ctrl=null, \ilLanguage $lng=null, \ilAccessHandler $access=null, \ILIAS\DI\BackgroundTaskServices $backgroundTasks=null, \ilObjUser $user=null, \ilLearningHistoryService $learningHistoryService=null, \ilSetting $certificateSettings=null, \ilCertificateMigrationValidator $migrationValidator=null, \ilErrorHandling $errorHandler=null, \ilLog $logger=null)
	ilCertificateMigrationGUI constructor. More...

	executeCommand ()
	execute command More...

	getCommand (string $cmd)
	Retrieves the ilCtrl command. More...

	startMigrationAndReturnMessage ()

Protected Attributes
	$ctrl

	$lng

	$access

	$tpl

	$user

	$backgroundTasks

	$learningHistoryService

Private Attributes
	$logger

	$migrationValidator

	$errorHandler

Detailed Description

Class ilCertificateMigrationGUI.

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

ilCertificateMigrationGUI: ilPersonalProfileGUI, ilUserCertificateGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateMigrationGUI::__construct	(	\ilCtrl	$ctrl = `null`,
		\ilLanguage	$lng = `null`,
		\ilAccessHandler	$access = `null`,
		\ILIAS\DI\BackgroundTaskServices	$backgroundTasks = `null`,
		\ilObjUser	$user = `null`,
		\ilLearningHistoryService	$learningHistoryService = `null`,
		\ilSetting	$certificateSettings = `null`,
		\ilCertificateMigrationValidator	$migrationValidator = `null`,
		\ilErrorHandling	$errorHandler = `null`,
		\ilLog	$logger = `null`
	)

ilCertificateMigrationGUI constructor.

Parameters

\ilCtrl	$ctrl
\ilLanguage	$lng
ilAccessHandler \| null	$access
\ILIAS\DI\BackgroundTaskServices	$backgroundTasks
\ilObjUser	$user
\ilLearningHistoryService	$learningHistoryService
ilSetting \| null	$certificateSettings
ilCertificateMigrationValidator \| null	$migrationValidator
ilErrorHandling \| null	$errorHandler
ilLog \| null	$logger

Definition at line 56 of file class.ilCertificateMigrationGUI.php.

References $access, $backgroundTasks, $ctrl, $DIC, $errorHandler, $learningHistoryService, $lng, $logger, $migrationValidator, $user, and user().

       {
         global $DIC;
 
         if (null === $ctrl) {
             $ctrl = $DIC->ctrl();
         }
         if (null === $lng) {
             $lng = $DIC->language();
         }
         if (null === $access) {
             $access = $DIC->access();
         }
         if (null === $backgroundTasks) {
             $backgroundTasks = $DIC->backgroundTasks();
         }
         if (null === $user) {
             $user = $DIC->user();
         }
         if (null === $learningHistoryService) {
             $learningHistoryService = $DIC->learningHistory();
         }
 
         if (null === $certificateSettings) {
             $certificateSettings = new \ilSetting('certificate');
         }
 
         if (null === $migrationValidator) {
             $migrationValidator = new \ilCertificateMigrationValidator($certificateSettings);
         }
         $this->migrationValidator = $migrationValidator;
 
         if (null === $errorHandler) {
             $errorHandler = $DIC['ilErr'];
         }
         $this->errorHandler = $errorHandler;
 
         if (null === $logger) {
             $logger = $DIC->logger()->cert();
         }
         $this->logger = $logger;
 
         $this->ctrl = $ctrl;
         $lng->loadLanguageModule('cert');
         $this->lng = $lng;
         $this->access = $access;
         $this->user = $user;
         $this->backgroundTasks = $backgroundTasks;
         $this->learningHistoryService = $learningHistoryService;
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilCertificateMigrationGUI::executeCommand ( )

execute command

Returns: mixed

Definition at line 121 of file class.ilCertificateMigrationGUI.php.

References $ret, and getCommand().

     {
         $cmd = $this->ctrl->getCmd();
         $next_class = $this->ctrl->getNextClass($this);
 
         $cmd = $this->getCommand($cmd);
         switch ($next_class) {
             default:
                 $ret = $this->$cmd();
                 break;
         }
 
         return $ret;
     }

Here is the call graph for this function:

◆ getCommand()

ilCertificateMigrationGUI::getCommand ( string $cmd )

Retrieves the ilCtrl command.

Parameters

string $cmd

Returns: mixed

Definition at line 141 of file class.ilCertificateMigrationGUI.php.

Referenced by executeCommand().

                                             : string
     {
         return $cmd;
     }

Here is the caller graph for this function:

◆ startMigrationAndReturnMessage()

ilCertificateMigrationGUI::startMigrationAndReturnMessage ( )

Returns: string

Exceptions

Definition at line 150 of file class.ilCertificateMigrationGUI.php.

References $factory, and user().

                                                      : string
     {
         $isMigrationAvailable = $this->migrationValidator->isMigrationAvailable(
             $this->user,
             new \ilCertificateMigration($this->user->getId())
         );
         if (false === $isMigrationAvailable) {
             $this->logger->error('Tried to execute user certificate migration, but the migration has already been executed');
             return '';
         }
 
         $factory = $this->backgroundTasks->taskFactory();
         $taskManager = $this->backgroundTasks->taskManager();
 
         $bucket = new \ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket();
         $bucket->setUserId($this->user->getId());
 
         $task = $factory->createTask(\ilCertificateMigrationJob::class, [(int) $this->user->getId()]);
 
         $interaction = \ilCertificateMigrationInteraction::class;
         if (!$this->learningHistoryService->isActive()) {
             $interaction = \ilCertificateMigrationReducedInteraction::class;
         }
         $certificates_interaction = $factory->createTask($interaction, [
             $task,
             (int) $this->user->getId()
         ]);
 
         $bucket->setTask($certificates_interaction);
         $bucket->setTitle('Certificate Migration');
         $bucket->setDescription('Migrates certificates for active user');
 
         $taskManager->run($bucket);
 
         return $this->lng->txt('certificate_migration_confirm_started');
     }