ilPortfolioCertificateFileService Class Reference

Collaboration diagram for ilPortfolioCertificateFileService:

Public Member Functions
	__construct (?Filesystem $filesystem=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
readonly Filesystem	$filesystem
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

)

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

createCertificateFile()

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

Exceptions

FileAlreadyExistsException
IOException
ilException

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

References ILIAS\Repository\filesystem().

                                                                     : void
    {
        $userCertificateRepository = new ilUserCertificateRepository();

        $userCertificate = $userCertificateRepository->fetchActiveCertificate($userId, $objectId);

        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId . '/' . $objectId;
        if (!$this->filesystem->hasDir($dirPath)) {
            $this->filesystem->createDir($dirPath);
        }

        $pdfGenerator = new ilPdfGenerator($userCertificateRepository);

        $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);
    }

Here is the call graph for this function:

createCertificateFilePath()

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

Exceptions

ilException

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

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

                                                                         : 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));
    }

Here is the call graph for this function:

deleteCertificateFile()

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

Exceptions

FileNotFoundException
IOException

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

References ILIAS\Repository\filesystem().

                                                                     : void
    {
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId;

        $completePath = $dirPath . '/' . $objectId . '_' . self::CERTIFICATE_FILENAME;

        if ($this->filesystem->has($completePath)) {
            $this->filesystem->delete($completePath);
        }
    }

Here is the call graph for this function:

deleteUserDirectory()

ilPortfolioCertificateFileService::deleteUserDirectory

(

int

$userId

)

Exceptions

IOException

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

References ILIAS\Repository\filesystem().

                                                    : void
    {
        $dirPath = self::PERSISTENT_CERTIFICATES_DIRECTORY . $userId;

        if ($this->filesystem->hasDir($dirPath)) {
            $this->filesystem->deleteDir($dirPath);
        }
    }

Here is the call graph for this function:

deliverCertificate()

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

Exceptions

ilException
ilFileUtilsException

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

References CLIENT_DATA_DIR, ilFileDelivery\deliverFileAttached(), ILIAS\Repository\filesystem(), and ilFileUtils\getValidFilename().

                                                                  : 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')
            );
        }
    }

Here is the call graph for this function:

Field Documentation

$filesystem

readonly Filesystem ilPortfolioCertificateFileService::$filesystem

private

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

Referenced by __construct().

CERTIFICATE_FILENAME

const ilPortfolioCertificateFileService::CERTIFICATE_FILENAME = 'certificate.pdf'

private

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

PERSISTENT_CERTIFICATES_DIRECTORY

const ilPortfolioCertificateFileService::PERSISTENT_CERTIFICATES_DIRECTORY = 'PersistentCertificates/'

private

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

---

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

• components/ILIAS/Certificate/classes/Portfolio/class.ilPortfolioCertificateFileService.php