ilPdfGenerator Class Reference

Collaboration diagram for ilPdfGenerator:

Public Member Functions
	__construct (ilUserCertificateRepository $userCertificateRepository, ilLogger $logger, ilCertificateRpcClientFactoryHelper $rpcHelper=null, ilCertificatePdfFileNameFactory $pdfFileNameFactory=null)
	generate (int $userCertificateId)
	generateCurrentActiveCertificate (int $userId, int $objId)
	generateFileName (int $userId, int $objId)

Private Member Functions
	createPDFScalar (ilUserCertificate $certificate)

Private Attributes
	$certificateRepository
	$logger
	$rpcHelper
	$scormPdfFilename
	$pdfFilenameFactory

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilPdfGenerator::__construct	(	ilUserCertificateRepository	$userCertificateRepository,
		ilLogger	$logger,
		ilCertificateRpcClientFactoryHelper	$rpcHelper = null,
		ilCertificatePdfFileNameFactory	$pdfFileNameFactory = null
	)

Parameters

ilUserCertificateRepository	$userCertificateRepository
ilLogger	$logger
ilCertificateRpcClientFactoryHelper | null	$rpcHelper
ilCertificatePdfFileNameFactory | null	$pdfFileNameFactory

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

      {
        $this->certificateRepository = $userCertificateRepository;
        $this->logger = $logger;
 
        if (null === $rpcHelper) {
            $rpcHelper = new ilCertificateRpcClientFactoryHelper();
        }
        $this->rpcHelper = $rpcHelper;
 
        if (null === $pdfFileNameFactory) {
            $pdfFileNameFactory = new ilCertificatePdfFileNameFactory();
        }
        $this->pdfFilenameFactory = $pdfFileNameFactory;
    }

References $logger, and $rpcHelper.

Member Function Documentation

createPDFScalar()

ilPdfGenerator::createPDFScalar ( ilUserCertificate  $certificate )

private

Parameters

$certificate

Returns

mixed

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

                                                                     : string
    {
        $certificateContent = $certificate->getCertificateContent();
 
        $certificateContent = str_replace(
            '[BACKGROUND_IMAGE]',
            '[CLIENT_WEB_DIR]' . $certificate->getBackgroundImagePath(),
            $certificateContent
        );
        $certificateContent = str_replace(
            '[CLIENT_WEB_DIR]',
            CLIENT_WEB_DIR,
            $certificateContent
        );
 
        $pdf_base64 = $this->rpcHelper->ilFO2PDF('RPCTransformationHandler', $certificateContent);
 
        return $pdf_base64->scalar;
    }

References $certificate.

Referenced by generate(), and generateCurrentActiveCertificate().

Here is the caller graph for this function:

generate()

ilPdfGenerator::generate

(

int

$userCertificateId

)

Parameters

$userCertificateId

Returns

mixed

Exceptions

ilException

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

    {
        $certificate = $this->certificateRepository->fetchCertificate($userCertificateId);
 
        return $this->createPDFScalar($certificate);
    }

References $certificate, and createPDFScalar().

Here is the call graph for this function:

generateCurrentActiveCertificate()

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

Parameters

$userId
$objId

Returns

mixed

Exceptions

ilException

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

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

References $certificate, and createPDFScalar().

Here is the call graph for this function:

generateFileName()

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

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

                                                              : string
    {
        $certificate = $this->certificateRepository->fetchActiveCertificateForPresentation($userId, $objId);
 
        $user = ilObjectFactory::getInstanceByObjId($userId);
        if (!$user instanceof ilObjUser) {
            throw new ilException(sprintf('The user_id "%s" does NOT reference a user', $userId));
        }
 
        $pdfFileName = $this->pdfFilenameFactory->create($certificate);
 
        return $pdfFileName;
    }

References $certificate, $user, and ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

Field Documentation

$certificateRepository

ilPdfGenerator::$certificateRepository

private

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

$logger

ilPdfGenerator::$logger

private

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

Referenced by __construct().

$pdfFilenameFactory

ilPdfGenerator::$pdfFilenameFactory

private

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

$rpcHelper

ilPdfGenerator::$rpcHelper

private

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

Referenced by __construct().

$scormPdfFilename

ilPdfGenerator::$scormPdfFilename

private

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

---

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

• Services/Certificate/classes/File/Certificate/class.ilPdfGenerator.php