Collaboration diagram for ilCertificateTemplatePreviewAction:

Public Member Functions
	__construct (private readonly ilCertificateTemplateRepository $templateRepository, private readonly ilCertificatePlaceholderValues $placeholderValuesObject, private readonly IRSS $irss, private readonly string $rootDirectory=CLIENT_WEB_DIR, ?ilObjUser $user=null, ?Language $lng=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilCertificateUserDefinedFieldsHelper $userDefinedFieldsHelper=null, ?ilCertificateRpcClientFactoryHelper $rpcClientFactoryHelper=null, ?ilCertificatePdfFileNameFactory $pdfFileNameFactory=null)

	createPreviewPdf (int $objectId)

Private Member Functions
	exchangeCertificateVariables (string $certificate_text, ilCertificateTemplate $template, int $objectId)
	Exchanges the variables in the certificate text with given values. More...

	getCustomCertificateFields ()

Private Attributes
readonly ilObjUser	$user

readonly Language	$lng

readonly ilCertificateUtilHelper	$utilHelper

readonly ilCertificateUserDefinedFieldsHelper	$userDefinedFieldsHelper

readonly ilCertificateRpcClientFactoryHelper	$rpcClientFactoryHelper

readonly ilCertificatePdfFileNameFactory	$pdfFileNameFactory

Detailed Description

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

Definition at line 28 of file ilCertificateTemplatePreviewAction.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateTemplatePreviewAction::__construct	(	private readonly ilCertificateTemplateRepository	$templateRepository,
		private readonly ilCertificatePlaceholderValues	$placeholderValuesObject,
		private readonly IRSS	$irss,
		private readonly string	$rootDirectory = `CLIENT_WEB_DIR`,
		?ilObjUser	$user = `null`,
		?Language	$lng = `null`,
		?ilCertificateUtilHelper	$utilHelper = `null`,
		?ilCertificateUserDefinedFieldsHelper	$userDefinedFieldsHelper = `null`,
		?ilCertificateRpcClientFactoryHelper	$rpcClientFactoryHelper = `null`,
		?ilCertificatePdfFileNameFactory	$pdfFileNameFactory = `null`
	)

Definition at line 37 of file ilCertificateTemplatePreviewAction.php.

      {
        global $DIC;
        if (null === $user) {
            $user = $DIC->user();
        }
        $this->user = $user;
 
        if (null === $lng) {
            $lng = $DIC->language();
        }
        $this->lng = $lng;
 
        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;
 
        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;
    }

References $DIC, $lng, $pdfFileNameFactory, $rpcClientFactoryHelper, $user, $userDefinedFieldsHelper, $utilHelper, ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ createPreviewPdf()

ilCertificateTemplatePreviewAction::createPreviewPdf ( int $objectId )

Exceptions

Exception

Definition at line 84 of file ilCertificateTemplatePreviewAction.php.

                                                   : void
    {
        $template = $this->templateRepository->fetchCurrentlyUsedCertificate($objectId);
 
        $xslfo = $template->getCertificateContent();
 
        $xslfo = $this->exchangeCertificateVariables($xslfo, $template, $objectId);
 
        $pdf_base64 = $this->rpcClientFactoryHelper
            ->ilFO2PDF('RPCTransformationHandler', $xslfo)
        ;
 
        $pdfPresentation = new ilUserCertificatePresentation(
            $template->getObjId(),
            $template->getObjType(),
            null,
            '',
            ''
        );
 
        $this->utilHelper->deliverData(
            $pdf_base64->scalar,
            $this->pdfFileNameFactory->create($pdfPresentation),
            'application/pdf'
        );
    }

References exchangeCertificateVariables().

Here is the call graph for this function:

◆ exchangeCertificateVariables()

ilCertificateTemplatePreviewAction::exchangeCertificateVariables	(	string	$certificate_text,
		ilCertificateTemplate	$template,
		int	$objectId
	)

private

Exchanges the variables in the certificate text with given values.

Parameters

string $certificate_text The XSL-FO certificate text

Returns: string XSL-FO code

Definition at line 116 of file ilCertificateTemplatePreviewAction.php.

     : string {
        $insert_tags = $this->placeholderValuesObject->getPlaceholderValuesForPreview($this->user->getId(), $objectId);
 
        foreach ($this->getCustomCertificateFields() as $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]',
            'file://' . $this->rootDirectory,
            $certificate_text
        );
 
        $identification = $this->irss->manage()->find($template->getBackgroundImageIdentification());
        if ($identification instanceof ResourceIdentification) {
            $backgroundImagePath = $this->irss->consume()->src($identification)->getSrc(true);
        }
 
        return str_replace(
            '[BACKGROUND_IMAGE]',
            $backgroundImagePath ?? '',
            $certificate_text
        );
    }

Referenced by createPreviewPdf().

Here is the caller graph for this function:

◆ getCustomCertificateFields()

ilCertificateTemplatePreviewAction::getCustomCertificateFields ( )

private

Returns: array<int, array{name: string, ph: string}>

Definition at line 152 of file ilCertificateTemplatePreviewAction.php.

                                                 : array
    {
        $fds = $this->userDefinedFieldsHelper->getFields();
 
        $fields = [];
        foreach ($fds as $f) {
            $fields[$f->getIdentifier()] = [
                'name' => $f->getLabel($this->lng),
                'ph' => '[#' . str_replace(' ', '_', strtoupper($f->getLabel($this->lng))) . ']'
            ];
        }
 
        return $fields;
    }