ilPdfGenerator Class Reference

Collaboration diagram for ilPdfGenerator:

Public Member Functions
	__construct (private readonly ilUserCertificateRepository $repository, private ?IRSS $irss=null, private ?ilCertificateRpcClientFactoryHelper $rpc=null, private ?ilCertificatePdfFileNameFactory $filename_factory=null, ?ilLanguage $lng=null)
	withLogger (ilLogger $logger)
	generate (int $userCertificateId)
	generateCurrentActiveCertificate (int $userId, int $objId)
	generateFileName (int $userId, int $objId)

Private Member Functions
	createPDFScalar (ilUserCertificate $certificate)

Private Attributes
ilLogger	$logger = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilPdfGenerator::__construct	(	private readonly ilUserCertificateRepository	$repository,
		private ?IRSS	$irss = null,
		private ?ilCertificateRpcClientFactoryHelper	$rpc = null,
		private ?ilCertificatePdfFileNameFactory	$filename_factory = null,
		?ilLanguage	$lng = null
	)

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

      {
        global $DIC;
 
        $this->irss = $irss ?? $DIC->resourceStorage();
        $this->rpc = $rpc ?? new ilCertificateRpcClientFactoryHelper();
        $this->filename_factory = $filename_factory ?? new ilCertificatePdfFileNameFactory(
            $lng ?? $DIC->language()
        );
    }

References $DIC, and $lng.

Member Function Documentation

createPDFScalar()

ilPdfGenerator::createPDFScalar ( ilUserCertificate  $certificate )

private

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

                                                                    : string
    {
        $content = $certificate->getCertificateContent();
 
        $this->logger?->debug(
            'Delegating certificate PDF generation for certificate id {certificate_id} (user {user_id} and object {object_id}) to ilServer',
            [
                'certificate_id' => $certificate->getCertificateId()->asString(),
                'user_id' => $certificate->getUserId(),
                'object_id' => $certificate->getObjId()
            ]
        );
 
        $background_rid = $this->irss->manage()->find($certificate->getBackgroundImageIdentification());
        if ($background_rid instanceof ResourceIdentification) {
            $background_src = $this->irss->consume()->src($background_rid)->getSrc(true);
 
            $content = str_replace(
                ['[BACKGROUND_IMAGE]'],
                [$background_src],
                $content
            );
        }
 
        $pdf_base64 = $this->rpc->ilFO2PDF('RPCTransformationHandler', $content);
        if (!is_string($pdf_base64->scalar)) {
            $this->logger?->error(
                'ilServer returned invalid PDF content for certificate id {certificate_id} ' .
                '(user {user_id} and object {object_id})',
                [
                    'certificate_id' => $certificate->getCertificateId()->asString(),
                    'user_id' => $certificate->getUserId(),
                    'object_id' => $certificate->getObjId()
                ]
            );
 
            throw new ilException('ilServer returned invalid PDF content');
        }
 
        $this->logger?->debug(
            'Received generated PDF with size {size} bytes for certificate id {certificate_id} (user {user_id} ' .
            'and object {object_id}) from ilServer',
            [
                'size' => strlen($pdf_base64->scalar),
                'certificate_id' => $certificate->getCertificateId()->asString(),
                'user_id' => $certificate->getUserId(),
                'object_id' => $certificate->getObjId()
            ]
        );
 
        return $pdf_base64->scalar;
    }

References ilUserCertificate\getBackgroundImageIdentification(), ilUserCertificate\getCertificateContent(), ilUserCertificate\getCertificateId(), ilUserCertificate\getObjId(), ilUserCertificate\getUserId(), and ILIAS\Repository\logger().

Referenced by generate(), and generateCurrentActiveCertificate().

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 55 of file class.ilPdfGenerator.php.

                                                    : string
    {
        $certificate = $this->repository->fetchCertificate($userCertificateId);
 
        return $this->createPDFScalar($certificate);
    }

References createPDFScalar(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

generateCurrentActiveCertificate()

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

Exceptions

ilException

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

                                                                             : string
    {
        $certificate = $this->repository->fetchActiveCertificate($userId, $objId);
 
        return $this->createPDFScalar($certificate);
    }

References $objId, createPDFScalar(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

generateFileName()

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

Exceptions

ilDatabaseException
ilException
ilObjectNotFoundException

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

                                                             : string
    {
        $certificate = $this->repository->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->filename_factory->create($certificate);
    }

References $objId, ilObjectFactory\getInstanceByObjId(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

withLogger()

ilPdfGenerator::withLogger

(

ilLogger

$logger

)

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

                                                : self
    {
        $clone = clone $this;
        $clone->logger = $logger;
 
        return $clone;
    }

References $logger.

Field Documentation

$logger

ilLogger ilPdfGenerator::$logger = null

private

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

Referenced by withLogger().

---

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

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