Collaboration diagram for ilCertificateTemplateRepository:

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)
	Fetch latest created certificate EVEN IF it is deleted. More...

	deleteTemplate (int $templateId, int $objectId)

	fetchActiveTemplatesByType (string $type)

	fetchFirstCreatedTemplate (int $objId)

	updateDefaultBackgroundImagePaths (string $oldRelativePath, string $newRelativePath)

	isBackgroundImageUsed (string $relativeImagePath)

Private Member Functions
	deactivatePreviousTemplates (int $objId)

	createCertificateTemplate (array $row)

Private Attributes
	$database

	$logger

	$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 10 of file class.ilCertificateTemplateRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateTemplateRepository::__construct	(	\ilDBInterface	$database,
		\ilLogger	$logger = `null`,
		\ilObjectDataCache	$objectDataCache = `null`
	)

Parameters

\ilDBInterface	$database
\ilLogger	$logger
\ilObjectDataCache \| null	$objectDataCache

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

      {
        $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;
    }

References $database, $DIC, $logger, and $objectDataCache.

Member Function Documentation

◆ createCertificateTemplate()

ilCertificateTemplateRepository::createCertificateTemplate ( array $row )

private

Parameters

array $row

Returns: ilCertificateTemplate

Definition at line 427 of file class.ilCertificateTemplateRepository.php.

                                                           : ilCertificateTemplate
    {
        return new ilCertificateTemplate(
            $row['obj_id'],
            $row['obj_type'],
            $row['certificate_content'],
            $row['certificate_hash'],
            $row['template_values'],
            $row['version'],
            $row['ilias_version'],
            $row['created_timestamp'],
            (boolean) $row['currently_active'],
            $row['background_image_path'],
            $row['thumbnail_image_path'],
            $row['id']
        );
    }

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

Here is the caller graph for this function:

◆ deactivatePreviousTemplates()

ilCertificateTemplateRepository::deactivatePreviousTemplates ( int $objId )

private

Parameters

int $objId

Exceptions

ilDatabaseException

Definition at line 359 of file class.ilCertificateTemplateRepository.php.

    {
        $this->logger->info(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->info(sprintf('END - Certificate template deactivated for object: "%s"', $objId));
    }

References $objId.

Referenced by save().

Here is the caller graph for this function:

◆ deleteTemplate()

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

Parameters

int	$templateId
int	$objectId

Exceptions

ilDatabaseException

Definition at line 256 of file class.ilCertificateTemplateRepository.php.

    {
        $this->logger->info(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->info(sprintf('END - Deleted flag set fo certificate template("%s") for object: "%s"', $templateId, $objectId));
    }

◆ fetchActiveTemplatesByType()

ilCertificateTemplateRepository::fetchActiveTemplatesByType ( string $type )

Parameters

string $type

Returns: ilCertificateTemplate[]

Definition at line 307 of file class.ilCertificateTemplateRepository.php.

                                                             : array
    {
        $this->logger->info(sprintf('START - Fetch all active certificate templates for object type: "%s"', $type));
 
        $sql = '
            SELECT il_cert_template.* FROM il_cert_template
            INNER JOIN object_data od ON od.obj_id =  il_cert_template.obj_id
            WHERE obj_type = ' . $this->database->quote($type, 'text') . '
            AND currently_active = 1
        ';
        $query = $this->database->query($sql);
 
        $result = array();
        while ($row = $this->database->fetchAssoc($query)) {
            $result[] = $this->createCertificateTemplate($row);
        }
 
        $this->logger->info(sprintf('END - All certificate templates for object type: "%s": "%s"', $type, json_encode($result)));
 
        return $result;
    }

References $query, $result, $type, and createCertificateTemplate().

Here is the call graph for this function:

◆ fetchCertificateTemplatesByObjId()

ilCertificateTemplateRepository::fetchCertificateTemplatesByObjId ( int $objId )

Parameters

int $objId

Returns: \ilCertificateTemplate[]

Definition at line 119 of file class.ilCertificateTemplateRepository.php.

                                                                 : array
    {
        $this->logger->info(sprintf('START - Fetch multiple certificate templates for object: "%s"', $objId));
 
        $result = array();
 
        $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->info(sprintf('END - Fetching of certificate templates for object: "%s" with "%s" results', $objId, count($result)));
 
        return $result;
    }

References $objId, $query, $result, and createCertificateTemplate().

Referenced by fetchPreviousCertificate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchCurrentlyActiveCertificate()

ilCertificateTemplateRepository::fetchCurrentlyActiveCertificate ( int $objId )

Parameters

int $objId

Returns: \ilCertificateTemplate

Exceptions

ilException

Definition at line 190 of file class.ilCertificateTemplateRepository.php.

                                                                : \ilCertificateTemplate
    {
        $this->logger->info(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->info(sprintf('END - Found active certificate for: "%s"', $objId));
 
            return $this->createCertificateTemplate($row);
        }
 
        throw new ilException((sprintf('NO active certificate template found for: "%s"', $objId)));
    }

References $objId, $query, and createCertificateTemplate().

Here is the call graph for this function:

◆ fetchCurrentlyUsedCertificate()

ilCertificateTemplateRepository::fetchCurrentlyUsedCertificate ( int $objId )

Parameters

int $objId

Returns: \ilCertificateTemplate

Definition at line 147 of file class.ilCertificateTemplateRepository.php.

                                                              : \ilCertificateTemplate
    {
        $this->logger->info(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->info(sprintf('END - Found active certificate for: "%s"', $objId));
 
            return $this->createCertificateTemplate($row);
        }
 
        $this->logger->info(sprintf('END - Found NO active certificate for: "%s"', $objId));
 
        return new ilCertificateTemplate(
            $objId,
            $this->objectDataCache->lookUpType($objId),
            '',
            '',
            '',
            0,
            0,
            0,
            false,
            '',
            ''
        );
    }

References $objId, $query, and createCertificateTemplate().

Here is the call graph for this function:

◆ fetchFirstCreatedTemplate()

ilCertificateTemplateRepository::fetchFirstCreatedTemplate ( int $objId )

Parameters

int $objId

Returns: \ilCertificateTemplate

Exceptions

ilException

Definition at line 334 of file class.ilCertificateTemplateRepository.php.

                                                          : \ilCertificateTemplate
    {
        $this->logger->info(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->info(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.');
    }

References $objId, $query, and createCertificateTemplate().

Here is the call graph for this function:

◆ fetchPreviousCertificate()

ilCertificateTemplateRepository::fetchPreviousCertificate ( int $objId )

Fetch latest created certificate EVEN IF it is deleted.

Parameters

int $objId

Returns: \ilCertificateTemplate

Definition at line 218 of file class.ilCertificateTemplateRepository.php.

                                                         : \ilCertificateTemplate
    {
        $this->logger->info(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->info(sprintf('Latest version active certificate template for object: "%s"', $objId));
 
        return $resultTemplate;
    }

References $objId, and fetchCertificateTemplatesByObjId().

Here is the call graph for this function:

◆ fetchTemplate()

ilCertificateTemplateRepository::fetchTemplate ( int $templateId )

Definition at line 96 of file class.ilCertificateTemplateRepository.php.

                                                   : ilCertificateTemplate
    {
        $this->logger->info(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));
    }

References $query, and createCertificateTemplate().

Here is the call graph for this function:

◆ isBackgroundImageUsed()

ilCertificateTemplateRepository::isBackgroundImageUsed ( string $relativeImagePath )

Definition at line 400 of file class.ilCertificateTemplateRepository.php.

                                                                     : bool
    {
        $this->logger->debug(sprintf(
            'START - Checking if any certificate template uses background image path "%s"',
            $relativeImagePath
        ));
 
        $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'],
            [$relativeImagePath]
        );
 
        $exists = (bool) ($this->database->fetchAssoc($result)['does_exist'] ?? false);
 
        $this->logger->debug(sprintf(
            'END - Image path "%s" is ' . $exists ? "in use" : "unused",
            $relativeImagePath
        ));
 
        return $exists;
    }

References $result.

◆ save()

ilCertificateTemplateRepository::save ( ilCertificateTemplate $certificateTemplate )

Parameters

ilCertificateTemplate $certificateTemplate

Exceptions

ilDatabaseException

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

    {
        $this->logger->info('START - Save new certificate template');
 
        $objId = $certificateTemplate->getObjId();
 
        $id = $this->database->nextId('il_cert_template');
 
        $this->deactivatePreviousTemplates($objId);
 
        $columns = array(
            'id' => array('integer', $id),
            'obj_id' => array('integer', $objId),
            'obj_type' => array('text', $certificateTemplate->getObjType()),
            'certificate_content' => array('clob', $certificateTemplate->getCertificateContent()),
            'certificate_hash' => array('text', $certificateTemplate->getCertificateHash()),
            'template_values' => array('clob', $certificateTemplate->getTemplateValues()),
            'version' => array('integer', $certificateTemplate->getVersion()),
            'ilias_version' => array('text', $certificateTemplate->getIliasVersion()),
            'created_timestamp' => array('integer', $certificateTemplate->getCreatedTimestamp()),
            'currently_active' => array('integer', (integer) $certificateTemplate->isCurrentlyActive()),
            'background_image_path' => array('text', $certificateTemplate->getBackgroundImagePath()),
            'deleted' => array('integer', (integer) $certificateTemplate->isDeleted()),
            'thumbnail_image_path' => array('text', $certificateTemplate->getThumbnailImagePath())
        );
 
        $this->database->insert('il_cert_template', $columns);
 
        $this->logger->info('END - certificate template saved with columns: ', json_encode($columns));
    }

Here is the call graph for this function:

◆ updateActivity()

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

Definition at line 88 of file class.ilCertificateTemplateRepository.php.

    {
        $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);
    }

References ilCertificateTemplate\getId().

Here is the call graph for this function:

◆ updateDefaultBackgroundImagePaths()

ilCertificateTemplateRepository::updateDefaultBackgroundImagePaths	(	string	$oldRelativePath,
		string	$newRelativePath
	)

Definition at line 373 of file class.ilCertificateTemplateRepository.php.

                                                                                                        : void
    {
        $this->logger->debug(sprintf(
            'START - Update all default background image paths from "%s" to "%s"',
            $oldRelativePath,
            $newRelativePath
        ));
 
        $affectedRows = $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'
            ],
            [
                $newRelativePath,
                $oldRelativePath,
                '/certificates/default/background.jpg']
        );
 
        $this->logger->debug(sprintf(
            'END - Updated %s certificate templates using old path',
            $affectedRows
        ));
    }

Field Documentation

◆ $database

ilCertificateTemplateRepository::$database

private

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

Referenced by __construct().

◆ $logger

ilCertificateTemplateRepository::$logger

private

Definition at line 20 of file class.ilCertificateTemplateRepository.php.

Referenced by __construct().

◆ $objectDataCache

ilCertificateTemplateRepository::$objectDataCache

private

Definition at line 25 of file class.ilCertificateTemplateRepository.php.

Referenced by __construct().

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

Services/Certificate/classes/Template/class.ilCertificateTemplateRepository.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createCertificateTemplate()

◆ deactivatePreviousTemplates()

◆ deleteTemplate()

◆ fetchActiveTemplatesByType()

◆ fetchCertificateTemplatesByObjId()

◆ fetchCurrentlyActiveCertificate()

◆ fetchCurrentlyUsedCertificate()

◆ fetchFirstCreatedTemplate()

◆ fetchPreviousCertificate()

◆ fetchTemplate()

◆ isBackgroundImageUsed()

◆ save()

◆ updateActivity()

◆ updateDefaultBackgroundImagePaths()

Field Documentation

◆ $database

◆ $logger

◆ $objectDataCache