ilCertificateTemplatePreviewAction Class Reference

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, ?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 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 27 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,
		?ilCertificateUtilHelper	$utilHelper = null,
		?ilCertificateUserDefinedFieldsHelper	$userDefinedFieldsHelper = null,
		?ilCertificateRpcClientFactoryHelper	$rpcClientFactoryHelper = null,
		?ilCertificatePdfFileNameFactory	$pdfFileNameFactory = null
	)

Definition at line 35 of file ilCertificateTemplatePreviewAction.php.

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

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

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

Here is the call graph for this function:

Member Function Documentation

createPreviewPdf()

ilCertificateTemplatePreviewAction::createPreviewPdf

(

int

$objectId

)

Exceptions

Exception

Definition at line 76 of file ilCertificateTemplatePreviewAction.php.

References exchangeCertificateVariables(), and null.

                                                   : 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'
        );
    }

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 108 of file ilCertificateTemplatePreviewAction.php.

References ilCertificateTemplate\getBackgroundImageIdentification(), getCustomCertificateFields(), and ILIAS\Repository\user().

Referenced by createPreviewPdf().

     : 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
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCustomCertificateFields()

ilCertificateTemplatePreviewAction::getCustomCertificateFields ( )

private

Returns

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

Definition at line 144 of file ilCertificateTemplatePreviewAction.php.

References Vendor\Package\$f.

Referenced by exchangeCertificateVariables().

                                                 : array
    {
        $user_field_definitions = $this->userDefinedFieldsHelper->createInstance();
        $fds = $user_field_definitions->getDefinitions();

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

        return $fields;
    }

Here is the caller graph for this function:

Field Documentation

$pdfFileNameFactory

readonly ilCertificatePdfFileNameFactory ilCertificateTemplatePreviewAction::$pdfFileNameFactory

private

Definition at line 33 of file ilCertificateTemplatePreviewAction.php.

Referenced by __construct().

$rpcClientFactoryHelper

readonly ilCertificateRpcClientFactoryHelper ilCertificateTemplatePreviewAction::$rpcClientFactoryHelper

private

Definition at line 32 of file ilCertificateTemplatePreviewAction.php.

Referenced by __construct().

$user

readonly ilObjUser ilCertificateTemplatePreviewAction::$user

private

Definition at line 29 of file ilCertificateTemplatePreviewAction.php.

Referenced by __construct().

$userDefinedFieldsHelper

readonly ilCertificateUserDefinedFieldsHelper ilCertificateTemplatePreviewAction::$userDefinedFieldsHelper

private

Definition at line 31 of file ilCertificateTemplatePreviewAction.php.

Referenced by __construct().

$utilHelper

readonly ilCertificateUtilHelper ilCertificateTemplatePreviewAction::$utilHelper

private

Definition at line 30 of file ilCertificateTemplatePreviewAction.php.

Referenced by __construct().

---

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

• components/ILIAS/Certificate/classes/Template/Action/Preview/ilCertificateTemplatePreviewAction.php