Inheritance diagram for ilCertificateTemplateDatabaseRepository:

Collaboration diagram for ilCertificateTemplateDatabaseRepository:

Public Member Functions
	__construct (private readonly ilDBInterface $database, ilLogger $logger=null, ilObjectDataCache $objectDataCache=null)

	save (ilCertificateTemplate $certificateTemplate)

	updateActivity (ilCertificateTemplate $certificateTemplate, bool $currentlyActive)

	fetchTemplate (int $templateId)

	fetchCertificateTemplatesByObjId (int $objId)

	fetchCurrentlyUsedCertificate (int $objId)

	fetchCurrentlyActiveCertificate (int $objId)

	fetchPreviousCertificate (int $objId)

	deleteTemplate (int $templateId, int $objectId)

	fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress (bool $isGlobalLpEnabled, int $forRefId=null)

	fetchFirstCreatedTemplate (int $objId)

	updateDefaultBackgroundImagePaths (string $old_relative_path, string $new_relative_path)

	isResourceUsed (string $relative_image_identification)

Public Member Functions inherited from ilCertificateTemplateRepository
	activatePreviousCertificate (int $objId)

	fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress (bool $isGlobalLpEnabled, ?int $forRefId=null)

Data Fields
const	TABLE_NAME = 'il_cert_template'

Private Member Functions
	deactivatePreviousTemplates (int $objId)

	createCertificateTemplate (array $row)

Private Attributes
readonly ilLogger	$logger

readonly ilObjectDataCache	$objectDataCache

Detailed Description

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de Repository that allows interaction with the database in the context of certificate templates.

Definition at line 26 of file class.ilCertificateTemplateDatabaseRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateTemplateDatabaseRepository::__construct	(	private readonly ilDBInterface	$database,
		ilLogger	$logger = `null`,
		ilObjectDataCache	$objectDataCache = `null`
	)

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

References $DIC, $logger, $objectDataCache, ILIAS\Repository\logger(), and ILIAS\Repository\objectDataCache().

       {
         if (null === $logger) {
             global $DIC;
             $logger = $DIC->logger()->cert();
         }
         $this->logger = $logger;
 
         if (null === $objectDataCache) {
             global $DIC;
             $objectDataCache = $DIC['ilObjDataCache'];
         }
         $this->objectDataCache = $objectDataCache;
     }

Here is the call graph for this function:

Member Function Documentation

◆ createCertificateTemplate()

ilCertificateTemplateDatabaseRepository::createCertificateTemplate ( array $row )

private

Parameters

array<string,mixed> $row

Definition at line 477 of file class.ilCertificateTemplateDatabaseRepository.php.

Referenced by fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress(), fetchCertificateTemplatesByObjId(), fetchCurrentlyActiveCertificate(), fetchCurrentlyUsedCertificate(), fetchFirstCreatedTemplate(), and fetchTemplate().

                                                           : ilCertificateTemplate
     {
         return new ilCertificateTemplate(
             (int) $row['obj_id'],
             $row['obj_type'],
             $row['certificate_content'],
             $row['certificate_hash'],
             $row['template_values'],
             (int) $row['version'],
             $row['ilias_version'],
             (int) $row['created_timestamp'],
             (bool) $row['currently_active'],
             (string) ($row['background_image_path'] ?? ''),
             (string) ($row['thumbnail_image_path'] ?? ''),
             (string) ($row['background_image_ident'] ?? ''),
             (string) ($row['thumbnail_image_ident'] ?? ''),
             isset($row['id']) ? (int) $row['id'] : null
         );
     }

Here is the caller graph for this function:

◆ deactivatePreviousTemplates()

ilCertificateTemplateDatabaseRepository::deactivatePreviousTemplates ( int $objId )

private

Definition at line 398 of file class.ilCertificateTemplateDatabaseRepository.php.

References ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

Referenced by save().

                                                             : void
     {
         $this->logger->debug(sprintf('START - Deactivate previous certificate template for object: "%s"', $objId));
 
         $sql = '
             UPDATE ' . self::TABLE_NAME . '
             SET currently_active = 0
             WHERE obj_id = ' . $this->database->quote($objId, ilDBConstants::T_INTEGER);
 
         $this->database->manipulate($sql);
 
         $this->logger->debug(sprintf('END - Certificate template deactivated for object: "%s"', $objId));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteTemplate()

ilCertificateTemplateDatabaseRepository::deleteTemplate	(	int	$templateId,
		int	$objectId
	)

Implements ilCertificateTemplateRepository.

Definition at line 259 of file class.ilCertificateTemplateDatabaseRepository.php.

References $objId, ilCertificateTemplateRepository\activatePreviousCertificate(), fetchCertificateTemplatesByObjId(), ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

                                                                   : void
     {
         $this->logger->debug(
             sprintf(
                 'START - Set deleted flag for certificate template("%s") for object: "%s"',
                 $templateId,
                 $objectId
             )
         );
 
         $sql = '
             UPDATE ' . self::TABLE_NAME . '
             SET deleted = 1, currently_active = 0
             WHERE id = ' . $this->database->quote($templateId, ilDBConstants::T_INTEGER) . '
             AND obj_id = ' . $this->database->quote($objectId, ilDBConstants::T_INTEGER);
 
         $this->database->manipulate($sql);
 
         $this->logger->debug(
             sprintf(
                 'END - Deleted flag set fo certificate template("%s") for object: "%s"',
                 $templateId,
                 $objectId
             )
         );
     }

Here is the call graph for this function:

◆ fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress()

ilCertificateTemplateDatabaseRepository::fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress	(	bool	$isGlobalLpEnabled,
		int	$forRefId = `null`
	)

Definition at line 313 of file class.ilCertificateTemplateDatabaseRepository.php.

References createCertificateTemplate(), ILIAS\Repository\logger(), and ilLPObjSettings\LP_MODE_DEACTIVATED.

      : array {
         $this->logger->debug(
             'START - Fetch all active course certificate templates with disabled learning progress: "%s"'
         );
 
         $joinLpSettings = '';
         $whereLpSettings = '';
         $onSettingsForRefId = '';
 
         if ($isGlobalLpEnabled) {
             $joinLpSettings = 'LEFT JOIN ut_lp_settings uls ON uls.obj_id = od.obj_id';
             $whereLpSettings = sprintf(
                 'AND (uls.u_mode IS NULL OR uls.u_mode = %s)',
                 $this->database->quote(ilLPObjSettings::LP_MODE_DEACTIVATED, 'integer')
             );
         }
 
         if (is_int($forRefId)) {
             $onSettingsForRefId = " AND settings.value IS NOT NULL AND (JSON_CONTAINS(settings.value, '\"{$forRefId}\"', '$') = 1 OR JSON_CONTAINS(settings.value, '{$forRefId}', '$')) ";
         }
 
         $sql = '
             SELECT ' . self::TABLE_NAME . '.*
             FROM ' . self::TABLE_NAME . '
             INNER JOIN object_data od ON od.obj_id = ' . self::TABLE_NAME . ".obj_id
             INNER JOIN settings ON settings.module = %s AND settings.keyword = {$this->database->concat(
             [
                 [$this->database->quote('cert_subitems_', 'text'), 'text'],
                 ['od.obj_id', 'text']
             ],
             false
         )} $onSettingsForRefId $joinLpSettings
             WHERE " . self::TABLE_NAME . '.obj_type = %s
             AND ' . self::TABLE_NAME . '.currently_active = %s
             ' . $whereLpSettings;
         $query = $this->database->queryF(
             $sql,
             ['text', 'text', 'integer'],
             ['crs', 'crs', 1]
         );
 
         $result = [];
         while ($row = $this->database->fetchAssoc($query)) {
             $result[] = $this->createCertificateTemplate($row);
         }
 
         $this->logger->debug(
             sprintf(
                 'END - All active course certificate templates with disabled learning progress: "%s"',
                 json_encode($result, JSON_THROW_ON_ERROR)
             )
         );
 
         return $result;
     }

Here is the call graph for this function:

◆ fetchCertificateTemplatesByObjId()

ilCertificateTemplateDatabaseRepository::fetchCertificateTemplatesByObjId ( int $objId )

Returns: ilCertificateTemplate[]

Implements ilCertificateTemplateRepository.

Definition at line 128 of file class.ilCertificateTemplateDatabaseRepository.php.

References createCertificateTemplate(), ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

Referenced by deleteTemplate(), and fetchPreviousCertificate().

                                                                 : array
     {
         $this->logger->debug(sprintf('START - Fetch multiple certificate templates for object: "%s"', $objId));
 
         $result = [];
 
         $sql = '
             SELECT * FROM ' .
             self::TABLE_NAME . ' ' .
             'WHERE obj_id = ' . $this->database->quote($objId, ilDBConstants::T_INTEGER) . ' ' .
             'AND deleted = 0 ' .
             'ORDER BY version ASC'
         ;
 
         $query = $this->database->query($sql);
 
         while ($row = $this->database->fetchAssoc($query)) {
             $result[] = $this->createCertificateTemplate($row);
         }
 
         $this->logger->debug(
             sprintf(
                 'END - Fetching of certificate templates for object: "%s" with "%s" results',
                 $objId,
                 count($result)
             )
         );
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchCurrentlyActiveCertificate()

ilCertificateTemplateDatabaseRepository::fetchCurrentlyActiveCertificate ( int $objId )

Exceptions

ilCouldNotFindCertificateTemplate

Implements ilCertificateTemplateRepository.

Definition at line 202 of file class.ilCertificateTemplateDatabaseRepository.php.

References createCertificateTemplate(), ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

                                                                : ilCertificateTemplate
     {
         $this->logger->debug(sprintf('START - Fetch currently active certificate template for object: "%s"', $objId));
 
         $sql = '
             SELECT * FROM ' . self::TABLE_NAME . '
             WHERE obj_id = ' . $this->database->quote($objId, ilDBConstants::T_INTEGER) . '
             AND deleted = 0
             AND currently_active = 1
         ';
 
         $query = $this->database->query($sql);
 
         while ($row = $this->database->fetchAssoc($query)) {
             $this->logger->debug(sprintf('END - Found active certificate for: "%s"', $objId));
 
             return $this->createCertificateTemplate($row);
         }
 
         throw new ilCouldNotFindCertificateTemplate(sprintf('NO active certificate template found for: "%s"', $objId));
     }

Here is the call graph for this function:

◆ fetchCurrentlyUsedCertificate()

ilCertificateTemplateDatabaseRepository::fetchCurrentlyUsedCertificate ( int $objId )

Implements ilCertificateTemplateRepository.

Definition at line 159 of file class.ilCertificateTemplateDatabaseRepository.php.

References createCertificateTemplate(), ILIAS\Repository\logger(), ILIAS\Repository\objectDataCache(), and ilDBConstants\T_INTEGER.

                                                              : ilCertificateTemplate
     {
         $this->logger->debug(sprintf('START - Fetch currently active certificate template for object: "%s"', $objId));
 
         $this->database->setLimit(1);
 
         $sql = '
             SELECT * FROM ' . self::TABLE_NAME . '
             WHERE obj_id = ' . $this->database->quote($objId, ilDBConstants::T_INTEGER) . '
             AND deleted = 0
             ORDER BY id DESC
         ';
 
         $query = $this->database->query($sql);
 
         while ($row = $this->database->fetchAssoc($query)) {
             $this->logger->debug(sprintf('END - Found active certificate for: "%s"', $objId));
 
             return $this->createCertificateTemplate($row);
         }
 
         $this->logger->debug(sprintf('END - Found NO active certificate for: "%s"', $objId));
 
         return new ilCertificateTemplate(
             $objId,
             $this->objectDataCache->lookupType($objId),
             '',
             '',
             '',
             0,
             '0',
             0,
             false,
             '',
             '',
             '',
             ''
         );
     }

Here is the call graph for this function:

◆ fetchFirstCreatedTemplate()

ilCertificateTemplateDatabaseRepository::fetchFirstCreatedTemplate ( int $objId )

Exceptions

ilCouldNotFindCertificateTemplate

Implements ilCertificateTemplateRepository.

Definition at line 375 of file class.ilCertificateTemplateDatabaseRepository.php.

References createCertificateTemplate(), ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

                                                          : ilCertificateTemplate
     {
         $this->logger->debug(sprintf('START - Fetch first create certificate template for object: "%s"', $objId));
 
         $this->database->setLimit(1, 0);
 
         $sql = '
             SELECT * FROM ' . self::TABLE_NAME . '
             WHERE obj_id = ' . $this->database->quote($objId, ilDBConstants::T_INTEGER) . '
             ORDER BY id ASC 
             ';
 
         $query = $this->database->query($sql);
 
         while ($row = $this->database->fetchAssoc($query)) {
             $this->logger->debug(sprintf('END - Found first create certificate template for object: "%s"', $objId));
 
             return $this->createCertificateTemplate($row);
         }
 
         throw new ilCouldNotFindCertificateTemplate('No matching template found. MAY missing DBUpdate. Please check if the correct version is installed.');
     }

Here is the call graph for this function:

◆ fetchPreviousCertificate()

ilCertificateTemplateDatabaseRepository::fetchPreviousCertificate ( int $objId )

Implements ilCertificateTemplateRepository.

Definition at line 224 of file class.ilCertificateTemplateDatabaseRepository.php.

References $version, fetchCertificateTemplatesByObjId(), ilCertificateTemplate\getVersion(), ILIAS\Repository\logger(), and ILIAS\Repository\objectDataCache().

                                                         : ilCertificateTemplate
     {
         $this->logger->debug(sprintf('START - Fetch previous active certificate template for object: "%s"', $objId));
 
         $templates = $this->fetchCertificateTemplatesByObjId($objId);
 
         $resultTemplate = new ilCertificateTemplate(
             $objId,
             $this->objectDataCache->lookupType($objId),
             '',
             '',
             '',
             0,
             '0',
             0,
             true,
             '',
             '',
             '',
             ''
         );
 
         $version = 0;
         foreach ($templates as $template) {
             if ($template->getVersion() > $version) {
                 $version = $template->getVersion();
                 $resultTemplate = $template;
             }
         }
 
         $this->logger->debug(sprintf('Latest version active certificate template for object: "%s"', $objId));
 
         return $resultTemplate;
     }

Here is the call graph for this function:

◆ fetchTemplate()

ilCertificateTemplateDatabaseRepository::fetchTemplate ( int $templateId )

Exceptions

ilCouldNotFindCertificateTemplate

Implements ilCertificateTemplateRepository.

Definition at line 105 of file class.ilCertificateTemplateDatabaseRepository.php.

References createCertificateTemplate(), ILIAS\Repository\logger(), and ilDBConstants\T_INTEGER.

                                                   : ilCertificateTemplate
     {
         $this->logger->debug(sprintf('START - Fetch certificate template with id: "%s"', $templateId));
 
         $sql = '
             SELECT * FROM
             ' . self::TABLE_NAME . '
             WHERE id = ' . $this->database->quote($templateId, ilDBConstants::T_INTEGER) . '
             ORDER BY version ASC
         ';
 
         $query = $this->database->query($sql);
 
         while ($row = $this->database->fetchAssoc($query)) {
             return $this->createCertificateTemplate($row);
         }
 
         throw new ilCouldNotFindCertificateTemplate(sprintf('No template with id "%s" found', $templateId));
     }

Here is the call graph for this function:

◆ isResourceUsed()

ilCertificateTemplateDatabaseRepository::isResourceUsed ( string $relative_image_identification )

Definition at line 445 of file class.ilCertificateTemplateDatabaseRepository.php.

References ILIAS\Repository\logger(), and ilDBConstants\T_TEXT.

                                                                          : bool
     {
         $this->logger->debug(
             sprintf(
                 'START - Checking if any certificate template uses resource id "%s"',
                 $relative_image_identification
             )
         );
 
         $result = $this->database->queryF(
             'SELECT EXISTS(SELECT 1 FROM ' . self::TABLE_NAME . ' WHERE 
             (background_image_ident = %s OR thumbnail_image_ident = %s)
              AND currently_active = 1) AS does_exist',
             [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
             [$relative_image_identification, $relative_image_identification]
         );
 
         $exists = (bool) ($this->database->fetchAssoc($result)['does_exist'] ?? false);
 
         $this->logger->debug(
             sprintf(
                 'END - Image path "%s" is ' . $exists ? 'in use' : 'unused',
                 $relative_image_identification
             )
         );
 
         return $exists;
     }

Here is the call graph for this function:

◆ save()

ilCertificateTemplateDatabaseRepository::save ( ilCertificateTemplate $certificateTemplate )

Implements ilCertificateTemplateRepository.

Definition at line 50 of file class.ilCertificateTemplateDatabaseRepository.php.

                                                                     : void
     {
         $this->logger->debug('START - Save new certificate template');
 
         $objId = $certificateTemplate->getObjId();
 
         $id = $this->database->nextId(self::TABLE_NAME);
 
         $this->deactivatePreviousTemplates($objId);
 
         $columns = [
             'id' => ['integer', $id],
             'obj_id' => ['integer', $objId],
             'obj_type' => ['text', $certificateTemplate->getObjType()],
             'certificate_content' => ['clob', $certificateTemplate->getCertificateContent()],
             'certificate_hash' => ['text', $certificateTemplate->getCertificateHash()],
             'template_values' => ['clob', $certificateTemplate->getTemplateValues()],
             'version' => ['integer', $certificateTemplate->getVersion()],
             'ilias_version' => ['text', $certificateTemplate->getIliasVersion()],
             'created_timestamp' => ['integer', $certificateTemplate->getCreatedTimestamp()],
             'currently_active' => ['integer', (int) $certificateTemplate->isCurrentlyActive()],
             'deleted' => ['integer', (int) $certificateTemplate->isDeleted()],
             'background_image_ident' => [ilDBConstants::T_TEXT, $certificateTemplate->getBackgroundImageIdentification()],
             'thumbnail_image_ident' => [ilDBConstants::T_TEXT, $certificateTemplate->getThumbnailImageIdentification()]
         ];
 
         if (
             $this->database->tableColumnExists('il_cert_user_cert', 'background_image_path') &&
             $this->database->tableColumnExists('il_cert_user_cert', 'thumbnail_image_path')
         ) {
             $columns['background_image_path'] = [ilDBConstants::T_TEXT, $certificateTemplate->getBackgroundImagePath()];
             $columns['thumbnail_image_path'] = [ilDBConstants::T_TEXT, $certificateTemplate->getThumbnailImagePath()];
         }
 
         $this->database->insert(self::TABLE_NAME, $columns);
 
         $this->logger->debug(
             sprintf(
                 'END - certificate template saved with columns: %s',
                 json_encode($columns, JSON_THROW_ON_ERROR)
             )
         );
     }

Here is the call graph for this function:

◆ updateActivity()

ilCertificateTemplateDatabaseRepository::updateActivity	(	ilCertificateTemplate	$certificateTemplate,
		bool	$currentlyActive
	)

Implements ilCertificateTemplateRepository.

Definition at line 94 of file class.ilCertificateTemplateDatabaseRepository.php.

References ilCertificateTemplate\getId(), and ilDBConstants\T_INTEGER.

                                                                                                      : int
     {
         $sql = 'UPDATE ' . self::TABLE_NAME . ' SET currently_active = ' . $this->database->quote(
             $currentlyActive,
             ilDBConstants::T_INTEGER
         ) .
             ' WHERE id = ' . $this->database->quote($certificateTemplate->getId(), ilDBConstants::T_INTEGER);
 
         return $this->database->manipulate($sql);
     }

Here is the call graph for this function:

◆ updateDefaultBackgroundImagePaths()

ilCertificateTemplateDatabaseRepository::updateDefaultBackgroundImagePaths	(	string	$old_relative_path,
		string	$new_relative_path
	)

Definition at line 412 of file class.ilCertificateTemplateDatabaseRepository.php.

References ILIAS\Repository\logger().

                                                                                                            : void
     {
         $this->logger->debug(
             sprintf(
                 'START - Update all default background image paths from "%s" to "%s"',
                 $old_relative_path,
                 $new_relative_path
             )
         );
 
         $affected_rows = $this->database->manipulateF(
             'UPDATE ' . self::TABLE_NAME . ' SET background_image_ident = %s ' .
             'WHERE currently_active = 1 AND (background_image_ident = %s OR background_image_ident = %s )',
             [
                 'text',
                 'text',
                 'text'
             ],
             [
                 $new_relative_path,
                 $old_relative_path,
                 '/certificates/default/background.jpg'
             ]
         );
 
         $this->logger->debug(
             sprintf(
                 'END - Updated %s certificate templates using old path',
                 $affected_rows
             )
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $logger

readonly ilLogger ilCertificateTemplateDatabaseRepository::$logger

private

Definition at line 29 of file class.ilCertificateTemplateDatabaseRepository.php.

Referenced by __construct().

◆ $objectDataCache

readonly ilObjectDataCache ilCertificateTemplateDatabaseRepository::$objectDataCache

private

Definition at line 30 of file class.ilCertificateTemplateDatabaseRepository.php.

Referenced by __construct().

◆ TABLE_NAME

const ilCertificateTemplateDatabaseRepository::TABLE_NAME = 'il_cert_template'

Definition at line 28 of file class.ilCertificateTemplateDatabaseRepository.php.

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

components/ILIAS/Certificate/classes/Template/class.ilCertificateTemplateDatabaseRepository.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createCertificateTemplate()

◆ deactivatePreviousTemplates()

◆ deleteTemplate()

◆ fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress()

◆ fetchCertificateTemplatesByObjId()

◆ fetchCurrentlyActiveCertificate()

◆ fetchCurrentlyUsedCertificate()

◆ fetchFirstCreatedTemplate()

◆ fetchPreviousCertificate()

◆ fetchTemplate()

◆ isResourceUsed()

◆ save()

◆ updateActivity()

◆ updateDefaultBackgroundImagePaths()

Field Documentation

◆ $logger

◆ $objectDataCache

◆ TABLE_NAME