ilCertificatePdfAction Class Reference

Collaboration diagram for ilCertificatePdfAction:

Public Member Functions
	__construct (private readonly ilPdfGenerator $pdf_generator, ?ilCertificateUtilHelper $helper=null, private readonly string $error_txt='', ?ilErrorHandling $error_handler=null)
	withLogger (ilLogger $logger)
	createPDF (int $userId, int $objectId)
	downloadPdf (int $userId, int $objectId)

Private Attributes
readonly ilCertificateUtilHelper	$helper
readonly ilErrorHandling	$error_handler
ilLogger	$logger = null

Detailed Description

Definition at line 21 of file class.ilCertificatePdfAction.php.

Constructor & Destructor Documentation

__construct()

ilCertificatePdfAction::__construct	(	private readonly ilPdfGenerator	$pdf_generator,
		?ilCertificateUtilHelper	$helper = null,
		private readonly string	$error_txt = '',
		?ilErrorHandling	$error_handler = null
	)

Definition at line 27 of file class.ilCertificatePdfAction.php.

      {
        global $DIC;
 
        $this->helper = $helper ?? new ilCertificateUtilHelper();
        $this->error_handler = $error_handler ?? $DIC['ilErr'];
    }

References $DIC, $error_handler, and $helper.

Member Function Documentation

createPDF()

ilCertificatePdfAction::createPDF	(	int	$userId,
		int	$objectId
	)

Definition at line 47 of file class.ilCertificatePdfAction.php.

                                                         : string
    {
        return $this->pdf_generator->generateCurrentActiveCertificate($userId, $objectId);
    }

Referenced by downloadPdf().

Here is the caller graph for this function:

downloadPdf()

ilCertificatePdfAction::downloadPdf	(	int	$userId,
		int	$objectId
	)

Definition at line 52 of file class.ilCertificatePdfAction.php.

                                                           : string
    {
        try {
            $pdf_scalar = $this->createPDF($userId, $objectId);
 
            $filename = $this->pdf_generator->generateFileName($userId, $objectId);
 
            $this->helper->deliverData(
                $pdf_scalar,
                $filename,
                'application/pdf'
            );
        } catch (Throwable $e) {
            $this->logger?->error(
                'Error while generating or downloading certificate PDF for user {user_id} and object {object_id}: {error}',
                [
                    'user_id' => $userId,
                    'object_id' => $objectId,
                    'error' => $e->getMessage(),
                    'exception' => $e
                ]
            );
 
            $this->error_handler->raiseError($this->error_txt, $this->error_handler->MESSAGE);
            return '';
        }
 
        return $pdf_scalar;
    }

References Vendor\Package\$e, $filename, createPDF(), and ILIAS\Repository\logger().

Here is the call graph for this function:

withLogger()

ilCertificatePdfAction::withLogger

(

ilLogger

$logger

)

Definition at line 39 of file class.ilCertificatePdfAction.php.

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

References $logger.

Field Documentation

$error_handler

readonly ilErrorHandling ilCertificatePdfAction::$error_handler

private

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

Referenced by __construct().

$helper

readonly ilCertificateUtilHelper ilCertificatePdfAction::$helper

private

Definition at line 23 of file class.ilCertificatePdfAction.php.

Referenced by __construct().

$logger

ilLogger ilCertificatePdfAction::$logger = null

private

Definition at line 25 of file class.ilCertificatePdfAction.php.

Referenced by withLogger().

---

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

• components/ILIAS/Certificate/classes/User/Action/Pdf/class.ilCertificatePdfAction.php