Collaboration diagram for ilPortfolioCertificateFileService:

Public Member Functions
	__construct (?Filesystem $filesystem=null, ?ilLogger $logger=null)

	createCertificateFile (int $userId, int $objectId)

	deliverCertificate (int $userId, int $objectId)

	deleteUserDirectory (int $userId)

	deleteCertificateFile (int $userId, int $objectId)

	createCertificateFilePath (int $userId, int $objectId)

Private Attributes
Filesystem	$filesystem

ilLogger	$logger

const	PERSISTENT_CERTIFICATES_DIRECTORY = 'PersistentCertificates/'

const	CERTIFICATE_FILENAME = 'certificate.pdf'

Detailed Description

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

Definition at line 29 of file class.ilPortfolioCertificateFileService.php.

Constructor & Destructor Documentation

◆ __construct()

ilPortfolioCertificateFileService::__construct	(	?Filesystem	$filesystem = `null`,
		?ilLogger	$logger = `null`
	)

Definition at line 36 of file class.ilPortfolioCertificateFileService.php.

    {
        global $DIC;
 
        if (null === $filesystem) {
            $filesystem = $DIC->filesystem()->storage();
        }
        $this->filesystem = $filesystem;
 
        if (null === $logger) {
            $logger = $DIC->logger()->root();
        }
        $this->logger = $logger;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ createCertificateFile()

ilPortfolioCertificateFileService::createCertificateFile	(	int	$userId,
		int	$objectId
	)

Parameters

int	$userId
int	$objectId

Exceptions

FileAlreadyExistsException
IOException
ilException

Definition at line 58 of file class.ilPortfolioCertificateFileService.php.

                                                                     : void
    {
        $userCertificateRepository = new ilUserCertificateRepository();
 
        $userCertificate = $userCertificateRepository->fetchActiveCertificate($userId, $objectId);
 
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId . '/' . $objectId;
        if (false === $this->filesystem->hasDir($dirPath)) {
            $this->filesystem->createDir($dirPath);
        }
 
        $pdfGenerator = new ilPdfGenerator($userCertificateRepository, $this->logger);
 
        $pdfScalar = $pdfGenerator->generate($userCertificate->getId());
 
        $completePath = $dirPath . '/' . $objectId . '_' . self::CERTIFICATE_FILENAME;
        if ($this->filesystem->has($completePath)) {
            $this->filesystem->delete($completePath);
        }
 
        $this->filesystem->write($completePath, $pdfScalar);
    }

References CERTIFICATE_FILENAME, ILIAS\Repository\filesystem(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ createCertificateFilePath()

ilPortfolioCertificateFileService::createCertificateFilePath	(	int	$userId,
		int	$objectId
	)

Parameters

int	$userId
int	$objectId

Returns: string

Exceptions

ilException

Definition at line 142 of file class.ilPortfolioCertificateFileService.php.

                                                                         : string
    {
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId . '/' . $objectId . '/';
        $fileName = $objectId . '_' . self::CERTIFICATE_FILENAME;
        $completePath = $dirPath . $fileName;
        if ($this->filesystem->has($completePath)) {
            return CLIENT_DATA_DIR . '/' . $completePath;
        }
 
        throw new ilException(sprintf('Certificate File does not exist in "%s"', $completePath));
    }

References CERTIFICATE_FILENAME, CLIENT_DATA_DIR, and ILIAS\Repository\filesystem().

Here is the call graph for this function:

◆ deleteCertificateFile()

ilPortfolioCertificateFileService::deleteCertificateFile	(	int	$userId,
		int	$objectId
	)

Parameters

int	$userId
int	$objectId

Exceptions

FileNotFoundException
IOException

Definition at line 125 of file class.ilPortfolioCertificateFileService.php.

                                                                     : void
    {
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId;
 
        $completePath = $dirPath . '/' . $objectId . '_' . self::CERTIFICATE_FILENAME;
 
        if ($this->filesystem->has($completePath)) {
            $this->filesystem->delete($completePath);
        }
    }

References CERTIFICATE_FILENAME, and ILIAS\Repository\filesystem().

Here is the call graph for this function:

◆ deleteUserDirectory()

ilPortfolioCertificateFileService::deleteUserDirectory ( int $userId )

Parameters

int $userId

Exceptions

IOException

Definition at line 110 of file class.ilPortfolioCertificateFileService.php.

                                                    : void
    {
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId;
 
        if (true === $this->filesystem->hasDir($dirPath)) {
            $this->filesystem->deleteDir($dirPath);
        }
    }

References ILIAS\Repository\filesystem().

Here is the call graph for this function:

◆ deliverCertificate()

ilPortfolioCertificateFileService::deliverCertificate	(	int	$userId,
		int	$objectId
	)

Parameters

int	$userId
int	$objectId

Exceptions

ilException
ilFileUtilsException

Definition at line 87 of file class.ilPortfolioCertificateFileService.php.

                                                                  : void
    {
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId . '/' . $objectId;
        $fileName = $objectId . '_' . self::CERTIFICATE_FILENAME;
 
        $completePath = $dirPath . '/' . $fileName;
        if ($this->filesystem->has($completePath)) {
            $userCertificateRepository = new ilUserCertificateRepository();
 
            $userCertificate = $userCertificateRepository->fetchActiveCertificateForPresentation($userId, $objectId);
 
            $downloadFilePath = CLIENT_DATA_DIR . '/' . $completePath;
            ilFileDelivery::deliverFileAttached(
                $downloadFilePath,
                ilFileUtils::getValidFilename($userCertificate->getObjectTitle() . '.pdf')
            );
        }
    }