Collaboration diagram for ilUserCertificateZip:

Public Member Functions
	__construct (int $objectId, string $certificatePath, string $webDirectory=CLIENT_WEB_DIR, string $installationId=IL_INST_ID)

	createArchiveDirectory ()
	Creates a directory for a zip archive containing multiple certificates. More...

	addPDFtoArchiveDirectory ($pdfdata, $dir, $filename)
	Adds PDF data as a file to a given directory. More...

	zipCertificatesInArchiveDirectory ($dir, $deliver=true)
	Create a ZIP file from a directory with certificates. More...

Private Attributes
	$objectId

	$webDirectory

	$certificatePath

	$typeInFileName

	$installionId

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $certificatePath, $objectId, $typeInFileName, $webDirectory, and ilObject\_lookupType().

       {
         $this->objectId = $objectId;
         $this->certificatePath = $certificatePath;
         $this->webDirectory = $webDirectory;
         $this->installionId = $installationId;
 
         // 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	(	$pdfdata,
		$dir,
		$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 87 of file class.ilUserCertificateZip.php.

References $filename.

     {
         $fh = fopen($dir . $filename, 'wb');
         fwrite($fh, $pdfdata);
         fclose($fh);
     }

◆ createArchiveDirectory()

ilUserCertificateZip::createArchiveDirectory ( )

Creates a directory for a zip archive containing multiple certificates.

Returns: string The created archive directory

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

References $objectId, $type, ilObject\_lookupType(), and ilUtil\makeDirParents().

Referenced by ilTestEvaluationGUI\exportCertificate().

     {
         $type = ilObject::_lookupType($this->objectId);
         $certificateId = $this->objectId;
 
         $directory = $this->webDirectory . $this->certificatePath . time() . '__' . $this->installionId . '__' . $type . '__' . $certificateId . '__certificate/';
         ilUtil::makeDirParents($directory);
 
         return $directory;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zipCertificatesInArchiveDirectory()

ilUserCertificateZip::zipCertificatesInArchiveDirectory	(	$dir,
		$deliver = `true`
	)

Create a ZIP file from a directory with certificates.

Parameters

string	$dir	Directory containing the certificates
boolean	$deliver	TRUE to deliver the ZIP file, FALSE to return the filename only

Returns: string The created ZIP archive path

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

References ilUtil\delDir(), ilUtil\deliverFile(), and ilUtil\zip().

     {
         $zipFile = time() . '__' . $this->installionId . '__' . $this->typeInFileName . '__' . $this->objectId . '__certificates.zip';
         $zipFilePath = $this->webDirectory . $this->certificatePath . $zipFile;
 
         ilUtil::zip($dir, $zipFilePath);
         ilUtil::delDir($dir);
 
         if ($deliver) {
             ilUtil::deliverFile($zipFilePath, $zipFile, 'application/zip', false, true);
         }
 
         return $zipFilePath;
     }