ilCertificateTemplatePreviewAction.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilCertificateTemplatePreviewAction
{
    private $templateRepository;

    private $placeholderValuesObject;

    private $logger;

    private $user;

    private $utilHelper;

    private $mathJaxHelper;

    private $userDefinedFieldsHelper;

    private $rpcClientFactoryHelper;

    private $rootDirectory;

    private $pdfFileNameFactory;

    public function __construct(
        ilCertificateTemplateRepository $templateRepository,
        ilCertificatePlaceholderValues $placeholderValuesObject,
        ilLogger $logger = null,
        ilObjUser $user = null,
        ilCertificateUtilHelper $utilHelper = null,
        ilCertificateMathJaxHelper $mathJaxHelper = null,
        ilCertificateUserDefinedFieldsHelper $userDefinedFieldsHelper = null,
        ilCertificateRpcClientFactoryHelper $rpcClientFactoryHelper = null,
        string $rootDirectory = CLIENT_WEB_DIR,
        ilCertificatePdfFileNameFactory $pdfFileNameFactory = null
    ) {
        global $DIC;

        $this->templateRepository = $templateRepository;
        $this->placeholderValuesObject = $placeholderValuesObject;

        if (null === $logger) {
            $logger = $DIC->logger()->cert();
        }
        $this->logger = $logger;

        if (null === $user) {
            $user = $DIC->user();
        }
        $this->user = $user;

        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;

        if (null === $mathJaxHelper) {
            $mathJaxHelper = new ilCertificateMathJaxHelper();
        }
        $this->mathJaxHelper = $mathJaxHelper;

        if (null === $userDefinedFieldsHelper) {
            $userDefinedFieldsHelper = new ilCertificateUserDefinedFieldsHelper();
        }
        $this->userDefinedFieldsHelper = $userDefinedFieldsHelper;

        if (null === $rpcClientFactoryHelper) {
            $rpcClientFactoryHelper = new ilCertificateRpcClientFactoryHelper();
        }
        $this->rpcClientFactoryHelper = $rpcClientFactoryHelper;

        if (null === $pdfFileNameFactory) {
            $pdfFileNameFactory = new ilCertificatePdfFileNameFactory($DIC->language());
        }
        $this->pdfFileNameFactory = $pdfFileNameFactory;

        $this->rootDirectory = $rootDirectory;
    }

    public function createPreviewPdf(int $objectId)
    {
        $template = $this->templateRepository->fetchCurrentlyUsedCertificate($objectId);

        $xslfo = $template->getCertificateContent();

        $xslfo = $this->exchangeCertificateVariables($xslfo, $template, $objectId);

        try {
            // render tex as fo graphics
            $xlsfo = $this->mathJaxHelper->fillXlsFoContent($xslfo);

            $pdf_base64 = $this->rpcClientFactoryHelper
                ->ilFO2PDF('RPCTransformationHandler', $xlsfo);

            $pdfPresentation = new ilUserCertificatePresentation(
                $template->getObjId(),
                $template->getObjType(),
                null,
                '',
                ''
            );

            $this->utilHelper->deliverData(
                $pdf_base64->scalar,
                $this->pdfFileNameFactory->create($pdfPresentation),
                'application/pdf'
            );
        } catch (Exception $e) {
            throw $e;
        }
    }

    private function exchangeCertificateVariables(
        string $certificate_text,
        ilCertificateTemplate $template,
        int $objectId
    ) {
        $insert_tags = $this->placeholderValuesObject->getPlaceholderValuesForPreview($this->user->getId(), $objectId);

        foreach ($this->getCustomCertificateFields() as $key => $value) {
            $insert_tags[$value['ph']] = $this->utilHelper->prepareFormOutput($value['name']);
        }

        foreach ($insert_tags as $placeholderVariable => $value) {
            $certificate_text = str_replace('[' . $placeholderVariable . ']', $value, $certificate_text);
        }

        $certificate_text = str_replace(
            '[CLIENT_WEB_DIR]',
            $this->rootDirectory,
            $certificate_text
        );

        $backgroundImagePath = $template->getBackgroundImagePath();

        $certificate_text = str_replace(
            '[BACKGROUND_IMAGE]',
            $this->rootDirectory . $backgroundImagePath,
            $certificate_text
        );

        return $certificate_text;
    }

    private function getCustomCertificateFields()
    {
        $user_field_definitions = $this->userDefinedFieldsHelper->createInstance();
        $fds = $user_field_definitions->getDefinitions();

        $fields = array();
        foreach ($fds as $f) {
            if ($f['certificate']) {
                $fields[$f['field_id']] = array(
                    'name' => $f['field_name'],
                    'ph' => '[#' . str_replace(' ', '_', strtoupper($f['field_name'])) . ']');
            }
        }

        return $fields;
    }
}