ilCertificateTemplateDatabaseRepository Class Reference

Inheritance diagram for ilCertificateTemplateDatabaseRepository:

Collaboration diagram for ilCertificateTemplateDatabaseRepository:

Public Member Functions
	__construct (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)
	isBackgroundImageUsed (string $relative_image_path)
Public Member Functions inherited from ilCertificateTemplateRepository
	activatePreviousCertificate (int $objId)

Private Member Functions
	deactivatePreviousTemplates (int $objId)
	createCertificateTemplate (array $row)

Private Attributes
ilDBInterface	$database
ilLogger	$logger
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	(	ilDBInterface	$database,
		?ilLogger	$logger = null,
		?ilObjectDataCache	$objectDataCache = null
	)

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

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

      {
        $this->database = $database;

        if (null === $logger) {
            global $DIC;
            $logger = $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

Returns

ilCertificateTemplate

Definition at line 449 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'],
            isset($row['id']) ? (int) $row['id'] : null
        );
    }

Here is the caller graph for this function:

deactivatePreviousTemplates()

ilCertificateTemplateDatabaseRepository::deactivatePreviousTemplates ( int  $objId )

private

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

References ILIAS\Repository\logger().

Referenced by save().

                                                            : void
    {
        $this->logger->debug(sprintf('START - Deactivate previous certificate template for object: "%s"', $objId));

        $sql = '
UPDATE il_cert_template
SET currently_active = 0
WHERE obj_id = ' . $this->database->quote($objId, '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 248 of file class.ilCertificateTemplateDatabaseRepository.php.

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

                                                                  : void
    {
        $this->logger->debug(sprintf(
            'START - Set deleted flag for certificate template("%s") for object: "%s"',
            $templateId,
            $objectId
        ));

        $sql = '
UPDATE il_cert_template
SET deleted = 1, currently_active = 0
WHERE id = ' . $this->database->quote($templateId, 'integer') . '
AND obj_id = ' . $this->database->quote($objectId, '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
	)

Parameters

bool

$isGlobalLpEnabled

Returns

ilCertificateTemplate[]

Implements ilCertificateTemplateRepository.

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

References $query, 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 il_cert_template.*
            FROM il_cert_template
            INNER JOIN object_data od ON od.obj_id = il_cert_template.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 il_cert_template.obj_type = %s
            AND il_cert_template.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

)

Parameters

int

$objId

Returns

ilCertificateTemplate[]

Implements ilCertificateTemplateRepository.

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

References $query, createCertificateTemplate(), and ILIAS\Repository\logger().

Referenced by deleteTemplate(), and fetchPreviousCertificate().

                                                                : array
    {
        $this->logger->debug(sprintf('START - Fetch multiple certificate templates for object: "%s"', $objId));

        $result = [];

        $sql = '
SELECT * FROM
il_cert_template
WHERE obj_id = ' . $this->database->quote($objId, '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

)

Parameters

int

$objId

Returns

ilCertificateTemplate

Exceptions

ilException

Implements ilCertificateTemplateRepository.

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

References $query, createCertificateTemplate(), and ILIAS\Repository\logger().

                                                               : ilCertificateTemplate
    {
        $this->logger->debug(sprintf('START - Fetch currently active certificate template for object: "%s"', $objId));

        $sql = '
SELECT * FROM il_cert_template
WHERE obj_id = ' . $this->database->quote($objId, '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 ilException((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 150 of file class.ilCertificateTemplateDatabaseRepository.php.

References $query, createCertificateTemplate(), and ILIAS\Repository\logger().

                                                             : ilCertificateTemplate
    {
        $this->logger->debug(sprintf('START - Fetch currently active certificate template for object: "%s"', $objId));

        $this->database->setLimit(1);

        $sql = '
SELECT * FROM il_cert_template
WHERE obj_id = ' . $this->database->quote($objId, '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

)

Parameters

int

$objId

Returns

ilCertificateTemplate

Exceptions

ilException

Implements ilCertificateTemplateRepository.

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

References $query, createCertificateTemplate(), and ILIAS\Repository\logger().

                                                         : ilCertificateTemplate
    {
        $this->logger->debug(sprintf('START - Fetch first create certificate template for object: "%s"', $objId));

        $this->database->setLimit(1, 0);

        $sql = 'SELECT * FROM il_cert_template
WHERE obj_id = ' . $this->database->quote($objId, '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 ilException('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 215 of file class.ilCertificateTemplateDatabaseRepository.php.

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

                                                        : 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

)

Parameters

int

$templateId

Returns

ilCertificateTemplate

Exceptions

ilException

Implements ilCertificateTemplateRepository.

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

References $query, createCertificateTemplate(), and ILIAS\Repository\logger().

                                                  : ilCertificateTemplate
    {
        $this->logger->debug(sprintf('START - Fetch certificate template with id: "%s"', $templateId));

        $sql = '
SELECT * FROM
il_cert_template
WHERE id = ' . $this->database->quote($templateId, 'integer') . '
ORDER BY version ASC';

        $query = $this->database->query($sql);

        while ($row = $this->database->fetchAssoc($query)) {
            return $this->createCertificateTemplate($row);
        }

        throw new ilException(sprintf('No template with id "%s" found', $templateId));
    }

Here is the call graph for this function:

isBackgroundImageUsed()

ilCertificateTemplateDatabaseRepository::isBackgroundImageUsed

(

string

$relative_image_path

)

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

References ILIAS\Repository\logger().

                                                                      : bool
    {
        $this->logger->debug(sprintf(
            'START - Checking if any certificate template uses background image path "%s"',
            $relative_image_path
        ));

        $result = $this->database->queryF(
            'SELECT EXISTS(SELECT 1 FROM il_cert_template WHERE background_image_path = %s AND currently_active = 1) AS does_exist',
            ['text'],
            [$relative_image_path]
        );

        $exists = (bool) ($this->database->fetchAssoc($result)['does_exist'] ?? false);

        $this->logger->debug(sprintf(
            'END - Image path "%s" is ' . $exists ? "in use" : "unused",
            $relative_image_path
        ));

        return $exists;
    }

Here is the call graph for this function:

save()

ilCertificateTemplateDatabaseRepository::save

(

ilCertificateTemplate

$certificateTemplate

)

Implements ilCertificateTemplateRepository.

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

References $id, $objId, deactivatePreviousTemplates(), ilCertificateTemplate\getBackgroundImagePath(), ilCertificateTemplate\getCertificateContent(), ilCertificateTemplate\getCertificateHash(), ilCertificateTemplate\getCreatedTimestamp(), ilCertificateTemplate\getIliasVersion(), ilCertificateTemplate\getObjId(), ilCertificateTemplate\getObjType(), ilCertificateTemplate\getTemplateValues(), ilCertificateTemplate\getThumbnailImagePath(), ilCertificateTemplate\getVersion(), ILIAS\Repository\int(), ilCertificateTemplate\isCurrentlyActive(), ilCertificateTemplate\isDeleted(), and ILIAS\Repository\logger().

                                                                    : void
    {
        $this->logger->debug('START - Save new certificate template');

        $objId = $certificateTemplate->getObjId();

        $id = $this->database->nextId('il_cert_template');

        $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()],
            'background_image_path' => ['text', $certificateTemplate->getBackgroundImagePath()],
            'deleted' => ['integer', (int) $certificateTemplate->isDeleted()],
            'thumbnail_image_path' => ['text', $certificateTemplate->getThumbnailImagePath()]
        ];

        $this->database->insert('il_cert_template', $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
	)

Parameters

ilCertificateTemplate	$certificateTemplate
bool	$currentlyActive

Returns

int

Implements ilCertificateTemplateRepository.

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

References ilCertificateTemplate\getId().

                                                                                                     : int
    {
        $sql = 'UPDATE il_cert_template SET currently_active = ' . $this->database->quote($currentlyActive, 'integer') .
            ' WHERE id = ' . $this->database->quote($certificateTemplate->getId(), '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 395 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 il_cert_template SET background_image_path = %s WHERE currently_active = 1 AND (background_image_path = %s OR background_image_path = %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

$database

ilDBInterface ilCertificateTemplateDatabaseRepository::$database

private

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

Referenced by __construct().

$logger

ilLogger ilCertificateTemplateDatabaseRepository::$logger

private

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

Referenced by __construct().

$objectDataCache

ilObjectDataCache ilCertificateTemplateDatabaseRepository::$objectDataCache

private

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

Referenced by __construct().

---

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

• Services/Certificate/classes/Template/class.ilCertificateTemplateDatabaseRepository.php