ilPdfGenerator Class Reference

Collaboration diagram for ilPdfGenerator:

Public Member Functions
	__construct (private readonly ilUserCertificateRepository $certificateRepository, private ?IRSS $irss=null, private ?Filesystem $filesystem=null, ?ilCertificateRpcClientFactoryHelper $rpcHelper=null, ?ilCertificatePdfFileNameFactory $pdfFileNameFactory=null, ?ilLanguage $lng=null,)
	generate (int $userCertificateId)
	generateCurrentActiveCertificate (int $userId, int $objId)
	generateFileName (int $userId, int $objId)

Private Member Functions
	createPDFScalar (ilUserCertificate $certificate)

Private Attributes
readonly ilCertificateRpcClientFactoryHelper	$rpcHelper
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 class.ilPdfGenerator.php.

Constructor & Destructor Documentation

__construct()

ilPdfGenerator::__construct	(	private readonly ilUserCertificateRepository	$certificateRepository,
		private ?IRSS	$irss = null,
		private ?Filesystem	$filesystem = null,
		?ilCertificateRpcClientFactoryHelper	$rpcHelper = null,
		?ilCertificatePdfFileNameFactory	$pdfFileNameFactory = null,
		?ilLanguage	$lng = null
	)

Definition at line 33 of file class.ilPdfGenerator.php.

References $DIC, $lng, $rpcHelper, and ILIAS\Repository\filesystem().

      {
        global $DIC;

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

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

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

        if (null === $lng) {
            $lng = $DIC->language();
        }

        if (null === $pdfFileNameFactory) {
            $pdfFileNameFactory = new ilCertificatePdfFileNameFactory($lng);
        }
        $this->pdfFilenameFactory = $pdfFileNameFactory;
    }

Here is the call graph for this function:

Member Function Documentation

createPDFScalar()

ilPdfGenerator::createPDFScalar ( ilUserCertificate  $certificate )

private

Definition at line 105 of file class.ilPdfGenerator.php.

References CLIENT_WEB_DIR, ILIAS\Repository\filesystem(), ilUserCertificate\getCertificateContent(), and ilUserCertificate\getCurrentBackgroundImageUsed().

Referenced by generate(), and generateCurrentActiveCertificate().

                                                                    : string
    {
        $certificateContent = $certificate->getCertificateContent();

        $background_rid = $this->irss->manage()->find($certificate->getCurrentBackgroundImageUsed());
        $background_src = '';
        if ($background_rid instanceof ResourceIdentification) {
            $background_src = $this->irss->consume()->src($background_rid)->getSrc(true);

            $certificateContent = str_replace(
                ['[BACKGROUND_IMAGE]'],
                [$background_src],
                $certificateContent
            );
        } elseif ($this->filesystem->has($certificate->getCurrentBackgroundImageUsed())) {
            $certificateContent = str_replace(
                ['[BACKGROUND_IMAGE]', '[CLIENT_WEB_DIR]'],
                ['[CLIENT_WEB_DIR]' . $certificate->getCurrentBackgroundImageUsed(), 'file://' . CLIENT_WEB_DIR],
                $certificateContent
            );
        }

        $pdf_base64 = $this->rpcHelper->ilFO2PDF('RPCTransformationHandler', $certificateContent);

        return $pdf_base64->scalar;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generate()

ilPdfGenerator::generate

(

int

$userCertificateId

)

Exceptions

ilException

Definition at line 71 of file class.ilPdfGenerator.php.

References createPDFScalar().

                                                    : string
    {
        $certificate = $this->certificateRepository->fetchCertificate($userCertificateId);

        return $this->createPDFScalar($certificate);
    }

Here is the call graph for this function:

generateCurrentActiveCertificate()

ilPdfGenerator::generateCurrentActiveCertificate	(	int	$userId,
		int	$objId
	)

Exceptions

ilException

Definition at line 81 of file class.ilPdfGenerator.php.

References createPDFScalar().

                                                                             : string
    {
        $certificate = $this->certificateRepository->fetchActiveCertificate($userId, $objId);

        return $this->createPDFScalar($certificate);
    }

Here is the call graph for this function:

generateFileName()

ilPdfGenerator::generateFileName	(	int	$userId,
		int	$objId
	)

Exceptions

ilDatabaseException
ilException
ilObjectNotFoundException

Definition at line 93 of file class.ilPdfGenerator.php.

References ilObjectFactory\getInstanceByObjId().

                                                             : string
    {
        $certificate = $this->certificateRepository->fetchActiveCertificateForPresentation($userId, $objId);

        $user = ilObjectFactory::getInstanceByObjId($userId);
        if (!$user instanceof ilObjUser) {
            throw new ilException(sprintf('The usr_id "%s" does NOT reference a user', $userId));
        }

        return $this->pdfFilenameFactory->create($certificate);
    }

Here is the call graph for this function:

Field Documentation

$pdfFilenameFactory

readonly ilCertificatePdfFileNameFactory ilPdfGenerator::$pdfFilenameFactory

private

Definition at line 31 of file class.ilPdfGenerator.php.

$rpcHelper

readonly ilCertificateRpcClientFactoryHelper ilPdfGenerator::$rpcHelper

private

Definition at line 30 of file class.ilPdfGenerator.php.

Referenced by __construct().

---

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

• components/ILIAS/Certificate/classes/File/Certificate/class.ilPdfGenerator.php