ilUserCertificateZip Class Reference

Collaboration diagram for ilUserCertificateZip:

Public Member Functions
	__construct (private readonly int $objectId, private readonly string $certificatePath, private readonly string $webDirectory=CLIENT_WEB_DIR, private readonly string $installationId=IL_INST_ID)
	createArchiveDirectory ()
	addPDFtoArchiveDirectory (string $pdfdata, string $dir, string $filename)
	Adds PDF data as a file to a given directory. More...
	zipCertificatesInArchiveDirectory (string $dir, bool $deliver=true)

Private Attributes
readonly string	$typeInFileName
bool	$files_added_to_archive = false

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilUserCertificateZip::__construct	(	private readonly int	$objectId,
		private readonly string	$certificatePath,
		private readonly string	$webDirectory = CLIENT_WEB_DIR,
		private readonly string	$installationId = IL_INST_ID
	)

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

References $typeInFileName, and ilObject\_lookupType().

      {
        // The mapping to types is made to reflect the old behaviour of
        // the adapters
        $iliasType = ilObject::_lookupType($this->objectId);

        $typeInFileName = 'not_defined';
        if ('crs' === $iliasType) {
            $typeInFileName = 'course';
        } elseif ('tst' === $iliasType) {
            $typeInFileName = 'test';
        } elseif ('exc' === $iliasType) {
            $typeInFileName = 'exc';
        } elseif ('sahs' === $iliasType) {
            $typeInFileName = 'scorm';
        }

        $this->typeInFileName = $typeInFileName;
    }

Here is the call graph for this function:

Member Function Documentation

addPDFtoArchiveDirectory()

ilUserCertificateZip::addPDFtoArchiveDirectory	(	string	$pdfdata,
		string	$dir,
		string	$filename
	)

Adds PDF data as a file to a given directory.

Parameters

string	$pdfdata	Binary PDF data
string	$dir	Directory to contain the PDF data
string	$filename	The filename to save the PDF data

Definition at line 73 of file class.ilUserCertificateZip.php.

                                                                                            : void
    {
        $fh = fopen($dir . $filename, 'wb');
        fwrite($fh, $pdfdata);
        fclose($fh);
        $this->files_added_to_archive = true;
    }

createArchiveDirectory()

ilUserCertificateZip::createArchiveDirectory

(

)

Definition at line 55 of file class.ilUserCertificateZip.php.

References ilObject\_lookupType(), and ilFileUtils\makeDirParents().

                                            : string
    {
        $type = ilObject::_lookupType($this->objectId);
        $certificateId = $this->objectId;

        $directory = $this->webDirectory . $this->certificatePath . time() .
            '__' . $this->installationId . '__' . $type . '__' . $certificateId . '__certificate/';
        ilFileUtils::makeDirParents($directory);

        return $directory;
    }

Here is the call graph for this function:

zipCertificatesInArchiveDirectory()

ilUserCertificateZip::zipCertificatesInArchiveDirectory	(	string	$dir,
		bool	$deliver = true
	)

Exceptions

IOException

Definition at line 84 of file class.ilUserCertificateZip.php.

References ilFileUtils\delDir(), ilFileDelivery\deliverFileLegacy(), and ilFileUtils\zip().

                                                                                        : string
    {
        if (!$this->files_added_to_archive) {
            throw new IOException('No files added to archive directory');
        }

        $zipFile = time(
        ) . '__' . $this->installationId . '__' . $this->typeInFileName . '__' . $this->objectId . '__certificates.zip';
        $zipFilePath = $this->webDirectory . $this->certificatePath . $zipFile;

        ilFileUtils::zip($dir, $zipFilePath);
        ilFileUtils::delDir($dir);

        if ($deliver) {
            ilFileDelivery::deliverFileLegacy($zipFilePath, $zipFile, 'application/zip', false, true);
        }

        return $zipFilePath;
    }

Here is the call graph for this function:

Field Documentation

$files_added_to_archive

bool ilUserCertificateZip::$files_added_to_archive = false

private

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

$typeInFileName

readonly string ilUserCertificateZip::$typeInFileName

private

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

Referenced by __construct().

---

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

• components/ILIAS/Certificate/classes/User/Action/Zip/class.ilUserCertificateZip.php