Collaboration diagram for ilCertificateTemplateImportAction:

Public Member Functions
	__construct (int $objectId, string $certificatePath, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilLogger $logger, Filesystem $filesystem, ilCertificateTemplateRepository $templateRepository=null, ilCertificateObjectHelper $objectHelper=null, ilCertificateUtilHelper $utilHelper=null, ilDBInterface $database=null)

	import (string $zipFile, string $filename, string $rootDir=CLIENT_WEB_DIR, string $iliasVerision=ILIAS_VERSION_NUMERIC, string $installationID=IL_INST_ID)

Private Member Functions
	createArchiveDirectory (string $installationID)
	Creates a directory for a zip archive containing multiple certificates. More...

	getBackgroundImageDirectory (string $rootDir)

	getBackgroundImageThumbnailPath ()

Private Attributes
	$objectId

	$certificatePath

	$templateRepository

	$placeholderDescriptionObject

	$logger

	$filesystem

	$objectHelper

	$utilHelper

	$installationID

Detailed Description

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 10 of file class.ilCertificateTemplateImportAction.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateTemplateImportAction::__construct	(	int	$objectId,
		string	$certificatePath,
		ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		ilLogger	$logger,
		Filesystem	$filesystem,
		ilCertificateTemplateRepository	$templateRepository = `null`,
		ilCertificateObjectHelper	$objectHelper = `null`,
		ilCertificateUtilHelper	$utilHelper = `null`,
		ilDBInterface	$database = `null`
	)

Parameters

integer	$objectId
string	$certificatePath
ilCertificatePlaceholderDescription	$placeholderDescriptionObject
ilLogger	$logger
Filesystem \| null	$filesystem
ilCertificateTemplateRepository \| null	$templateRepository
ilCertificateObjectHelper \| null	$objectHelper
ilCertificateUtilHelper \| null	$utilHelper
ilDBInterface \| null	$database
string	$installationID

Definition at line 69 of file class.ilCertificateTemplateImportAction.php.

      {
        $this->objectId = $objectId;
        $this->certificatePath = $certificatePath;
 
        $this->logger = $logger;
        if (null === $database) {
            global $DIC;
            $database = $DIC->database();
        }
 
        $this->filesystem = $filesystem;
 
        $this->placeholderDescriptionObject = $placeholderDescriptionObject;
 
        if (null === $templateRepository) {
            $templateRepository = new ilCertificateTemplateRepository($database, $logger);
        }
        $this->templateRepository = $templateRepository;
 
        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;
 
        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;
    }

References $certificatePath, $DIC, $filesystem, $logger, $objectHelper, $objectId, $placeholderDescriptionObject, $templateRepository, and $utilHelper.

Member Function Documentation

◆ createArchiveDirectory()

ilCertificateTemplateImportAction::createArchiveDirectory ( string $installationID )

private

Creates a directory for a zip archive containing multiple certificates.

Parameters

string $installationID

Returns: string The created archive directory

Exceptions

ILIAS\Filesystem\Exception\IOException

Definition at line 265 of file class.ilCertificateTemplateImportAction.php.

                                                                    : string
    {
        $type = $this->objectHelper->lookupType($this->objectId);
        $certificateId = $this->objectId;
 
        $dir = $this->certificatePath . time() . '__' . $installationID . '__' . $type . '__' . $certificateId . '__certificate/';
        $this->filesystem->createDir($dir);
 
        return $dir;
    }

References $installationID, $objectId, and $type.

Referenced by import().

Here is the caller graph for this function:

◆ getBackgroundImageDirectory()

ilCertificateTemplateImportAction::getBackgroundImageDirectory ( string $rootDir )

private

Parameters

string $rootDir

Returns: mixed|string

Definition at line 281 of file class.ilCertificateTemplateImportAction.php.

                                                                  : string
    {
        return str_replace(
            array($rootDir, '//'),
            array('[CLIENT_WEB_DIR]', '/'),
            ''
        );
    }

Referenced by import().

Here is the caller graph for this function:

◆ getBackgroundImageThumbnailPath()

ilCertificateTemplateImportAction::getBackgroundImageThumbnailPath ( )

private

Returns: string

Definition at line 293 of file class.ilCertificateTemplateImportAction.php.

                                                       : string
    {
        return $this->certificatePath . 'background.jpg.thumb.jpg';
    }

Referenced by import().

Here is the caller graph for this function:

◆ import()

ilCertificateTemplateImportAction::import	(	string	$zipFile,
		string	$filename,
		string	$rootDir = `CLIENT_WEB_DIR`,
		string	$iliasVerision = `ILIAS_VERSION_NUMERIC`,
		string	$installationID = `IL_INST_ID`
	)

Parameters

string	$zipFile
string	$filename
string	$rootDir
string	$iliasVerision
string	$installationID

Returns: bool

Exceptions

ILIAS\Filesystem\Exception\FileAlreadyExistsException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

Exceptions

ilDatabaseException
ilException

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

      {
        $importPath = $this->createArchiveDirectory($installationID);
 
        $result = $this->utilHelper->moveUploadedFile($zipFile, $filename, $rootDir . $importPath . $filename);
 
        if (!$result) {
            $this->filesystem->deleteDir($importPath);
            return false;
        }
 
        $this->utilHelper->unzip(
            $rootDir . $importPath . $filename,
            true
        );
 
        $subDirectoryName = str_replace('.zip', '', strtolower($filename)) . '/';
        $subDirectoryAbsolutePath = $rootDir . $importPath . $subDirectoryName;
 
        $copyDirectory = $importPath;
        if (is_dir($subDirectoryAbsolutePath)) {
            $copyDirectory = $subDirectoryAbsolutePath;
        }
 
        $directoryInformation = $this->utilHelper->getDir($copyDirectory);
 
        $xmlFiles = 0;
        foreach ($directoryInformation as $file) {
            if (strcmp($file['type'], 'file') == 0) {
                if (strpos($file['entry'], '.xml') !== false) {
                    $xmlFiles++;
                }
            }
        }
 
        if (0 === $xmlFiles) {
            $this->filesystem->deleteDir($importPath);
            return false;
        }
 
        $certificate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);
 
        $currentVersion = (int) $certificate->getVersion();
        $newVersion = $currentVersion + 1;
        $backgroundImagePath = $certificate->getBackgroundImagePath();
        $cardThumbnailImagePath = $certificate->getThumbnailImagePath();
 
        $xsl = $certificate->getCertificateContent();
 
        foreach ($directoryInformation as $file) {
            if (strcmp($file['type'], 'file') == 0) {
                $filePath = $importPath . $subDirectoryName . $file['entry'];
                if (strpos($file['entry'], '.xml') !== false) {
                    $xsl = $this->filesystem->read($filePath);
                    // as long as we cannot make RPC calls in a given directory, we have
                    // to add the complete path to every url
                    $xsl = preg_replace_callback("/url\‍([']{0,1}(.*?)[']{0,1}\‍)/", function (array $matches) use ($rootDir) {
                        $basePath = rtrim(dirname($this->getBackgroundImageDirectory($rootDir)), '/');
                        $fileName = basename($matches[1]);
 
                        if ('[BACKGROUND_IMAGE]' === $fileName) {
                            $basePath = '';
                        } elseif (strlen($basePath) > 0) {
                            $basePath .= '/';
                        }
 
                        return 'url(' . $basePath . $fileName . ')';
                    }, $xsl);
                } elseif (strpos($file['entry'], '.jpg') !== false) {
                    $newBackgroundImageName = 'background_' . $newVersion . '.jpg';
                    $newPath = $this->certificatePath . $newBackgroundImageName;
                    $this->filesystem->copy($filePath, $newPath);
 
                    $backgroundImagePath = $this->certificatePath . $newBackgroundImageName;
                    // upload of the background image, create a thumbnail
 
                    $backgroundImageThumbPath = $this->getBackgroundImageThumbnailPath();
 
                    $thumbnailImagePath = $rootDir . $backgroundImageThumbPath;
 
                    $originalImagePath = $rootDir . $newPath;
                    $this->utilHelper->convertImage(
                        $originalImagePath,
                        $thumbnailImagePath,
                        'JPEG',
                        100
                    );
                } elseif (strpos($file['entry'], '.svg') !== false) {
                    $newCardThumbnailName = 'thumbnail_' . $newVersion . '.svg';
                    $newPath = $this->certificatePath . $newCardThumbnailName;
 
                    $this->filesystem->copy($filePath, $newPath);
 
                    $cardThumbnailImagePath = $this->certificatePath . $newCardThumbnailName;
                }
            }
        }
 
        $jsonEncodedTemplateValues = json_encode($this->placeholderDescriptionObject->getPlaceholderDescriptions());
 
        $newHashValue = hash(
            'sha256',
            implode('', array(
                $xsl,
                $backgroundImagePath,
                $jsonEncodedTemplateValues,
                $cardThumbnailImagePath
            ))
        );
 
        $template = new ilCertificateTemplate(
            $this->objectId,
            $this->objectHelper->lookupType($this->objectId),
            $xsl,
            $newHashValue,
            $jsonEncodedTemplateValues,
            $newVersion,
            $iliasVerision,
            time(),
            true,
            $backgroundImagePath,
            $cardThumbnailImagePath
        );
 
        $this->templateRepository->save($template);
 
        $this->utilHelper->delDir($importPath);
 
        return true;
    }