Create PDF certificates. More...

Collaboration diagram for ilCertificate:

Public Member Functions
	__construct (ilCertificateAdapter $adapter, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilCertificatePlaceholderValues $placeholderValuesObject, $objectId, $certificatePath, ilCertificateTemplateRepository $templateRepository=null, ilUserCertificateRepository $certificateRepository=null)
	ilCertificate constructor More...

	getBackgroundImageDirectory ($asRelative=false, $backgroundImagePath='')
	Returns the filesystem path of the background image. More...

	getBackgroundImageName ()
	Returns the filename of the background image. More...

	getBackgroundImageThumbPath ()
	Returns the filesystem path of the background image thumbnail. More...

	getBackgroundImageTempfilePath ()
	Returns the filesystem path of the background image temp file during upload. More...

	getXSLPath ()
	Returns the filesystem path of the XSL-FO file. More...

	getXSLName ()
	Returns the filename of the XSL-FO file. More...

	getBackgroundImagePathWeb ()
	Returns the web path of the background image. More...

	getBackgroundImageThumbPathWeb ()
	Returns the web path of the background image thumbnail. More...

	deleteBackgroundImage ($version)
	Deletes the background image of a certificate. More...

	createCertificateFile ($xslfo, $filename='')
	Saves the XSL-FO code to a file. More...

	hasBackgroundImage ()
	Checks for the background image of the certificate. More...

	isComplete ()
	Checks the status of the certificate. More...

	getAdapter ()
	Gets the adapter. More...

	setAdapter ($adapter)
	Sets the adapter. More...

	createArchiveDirectory ()

	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...

	readActive ()

Static Public Member Functions
static	_getXSLName ()
	Returns the filename of the XSL-FO file. More...

static	isActive ()

static	isObjectActive ($a_obj_id)

Protected Attributes
	$ctrl

	$tree

	$ilias

	$lng

	$adapter

	$settings

	$log

	$db

Static Protected Attributes
static	$is_active

Private Attributes
	$templateRepository

	$placeholderDescriptionObject

	$objectId

	$certificateRepository

	$certificatePath

	$placeholderValuesObject

Detailed Description

Create PDF certificates.

Base class to create PDF certificates using XML-FO XML transformations

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version: $Id$

Definition at line 15 of file class.ilCertificate.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificate::__construct	(	ilCertificateAdapter	$adapter,
		ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		ilCertificatePlaceholderValues	$placeholderValuesObject,
			$objectId,
			$certificatePath,
		ilCertificateTemplateRepository	$templateRepository = `null`,
		ilUserCertificateRepository	$certificateRepository = `null`
	)

ilCertificate constructor

Parameters

ilCertificateAdapter	$adapter	The certificate adapter needed to construct the certificate
ilCertificatePlaceholderDescription	$placeholderDescriptionObject
ilCertificatePlaceholderValues	$placeholderValuesObject
	$objectId	- Object ID of the current component (e.g. course, test, exercise)
	$certificatePath	- Path to certificate data like background images etc.
ilCertificateTemplateRepository \| null	$templateRepository
ilUserCertificateRepository \| null	$certificateRepository

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

References $adapter, $certificatePath, $certificateRepository, $DIC, $objectId, $placeholderDescriptionObject, $placeholderValuesObject, $templateRepository, and settings().

       {
         global $DIC;
 
         $this->lng = $DIC['lng'];
         $this->ctrl = $DIC['ilCtrl'];
         $this->ilias = $DIC['ilias'];
         $this->tree = $DIC['tree'];
         $this->settings = $DIC['ilSetting'];
         $this->log = $DIC['ilLog'];
         $this->db = $DIC['ilDB'];
 
         $this->adapter = $adapter;
 
         $this->placeholderDescriptionObject = $placeholderDescriptionObject;
 
         $this->placeholderValuesObject = $placeholderValuesObject;
 
         $this->objectId = $objectId;
 
         $this->certificatePath = $certificatePath;
 
         $logger = $DIC->logger()->cert();
 
         if ($templateRepository === null) {
             $templateRepository = new ilCertificateTemplateRepository($DIC->database(), $logger);
         }
         $this->templateRepository = $templateRepository;
 
         if ($certificateRepository === null) {
             $certificateRepository = new ilUserCertificateRepository($DIC->database(), $logger);
         }
         $this->certificateRepository = $certificateRepository;
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getXSLName()

static ilCertificate::_getXSLName ( )

static

Returns the filename of the XSL-FO file.

Returns: string The filename of the XSL-FO file

Definition at line 227 of file class.ilCertificate.php.

     {
         return "certificate.xml";
     }

◆ addPDFtoArchiveDirectory()

ilCertificate::addPDFtoArchiveDirectory	(	$pdfdata,
		$dir,
		$filename
	)

Adds PDF data as a file to a given directory.

Parameters

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

Definition at line 397 of file class.ilCertificate.php.

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

◆ createArchiveDirectory()

ilCertificate::createArchiveDirectory ( )

Definition at line 380 of file class.ilCertificate.php.

     {
         $type = ilObject::_lookupType($this->objectId);
         $certificateId = $this->objectId;
 
         $dir = CLIENT_WEB_DIR . $this->certificatePath . time() . "__" . IL_INST_ID . "__" . $type . "__" . $certificateId . "__certificate/";
         ilUtil::makeDirParents($dir);
         return $dir;
     }

◆ createCertificateFile()

ilCertificate::createCertificateFile	(	$xslfo,
		$filename = `''`
	)

Saves the XSL-FO code to a file.

Parameters

string $xslfo XSL-FO code

Definition at line 293 of file class.ilCertificate.php.

References $filename, getXSLPath(), and ilUtil\makeDirParents().

     {
         if (!file_exists($this->certificatePath)) {
             ilUtil::makeDirParents($this->certificatePath);
         }
 
         if (strlen($filename) == 0) {
             $filename = $this->getXSLPath();
         }
 
         $fileHandle = fopen($filename, "w");
         fwrite($fileHandle, $xslfo);
         fclose($fileHandle);
     }

Here is the call graph for this function:

◆ deleteBackgroundImage()

ilCertificate::deleteBackgroundImage ( $version )

Deletes the background image of a certificate.

Returns: boolean TRUE if the process succeeds

Definition at line 269 of file class.ilCertificate.php.

References $filename, $result, $version, getBackgroundImageDirectory(), getBackgroundImageTempfilePath(), and getBackgroundImageThumbPath().

     {
         $result = true;
         if (file_exists($this->getBackgroundImageThumbPath())) {
             $result = $result & unlink($this->getBackgroundImageThumbPath());
         }
 
         $filename = $this->getBackgroundImageDirectory() . 'background_' . $version . '.jpg';
         if (file_exists($filename)) {
             $result = $result & unlink($filename);
         }
 
         if (file_exists($this->getBackgroundImageTempfilePath())) {
             $result = $result & unlink($this->getBackgroundImageTempfilePath());
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ getAdapter()

ilCertificate::getAdapter ( )

Gets the adapter.

Returns: ilCertificateAdapter Adapter

Definition at line 356 of file class.ilCertificate.php.

References $adapter.

Referenced by ilCertificateSettingsFormRepository\createForm().

     {
         return $this->adapter;
     }

Here is the caller graph for this function:

◆ getBackgroundImageDirectory()

ilCertificate::getBackgroundImageDirectory	(	$asRelative = `false`,
		$backgroundImagePath = `''`
	)

Returns the filesystem path of the background image.

Parameters

bool $asRelative

Returns: string The filesystem path of the background image

Definition at line 159 of file class.ilCertificate.php.

References $certificatePath.

Referenced by deleteBackgroundImage().

     {
         if ($asRelative) {
             return str_replace(
                 array(CLIENT_WEB_DIR, '//'),
                 array('[CLIENT_WEB_DIR]', '/'),
                 $backgroundImagePath
             );
         }
 
         return $this->certificatePath;
     }

Here is the caller graph for this function:

◆ getBackgroundImageName()

ilCertificate::getBackgroundImageName ( )

Returns the filename of the background image.

Returns: string The filename of the background image

Definition at line 177 of file class.ilCertificate.php.

Referenced by getBackgroundImagePathWeb(), and getBackgroundImageThumbPath().

     {
         return "background.jpg";
     }

Here is the caller graph for this function:

◆ getBackgroundImagePathWeb()

ilCertificate::getBackgroundImagePathWeb ( )

Returns the web path of the background image.

Returns: string The web path of the background image

Definition at line 237 of file class.ilCertificate.php.

References getBackgroundImageName(), and ilUtil\removeTrailingPathSeparators().

     {
         // TODO: this is generic now -> provide better solution
         $webdir = $this->certificatePath . $this->getBackgroundImageName();
 
         return str_replace(
             ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
             ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
             $webdir
         );
     }

Here is the call graph for this function:

◆ getBackgroundImageTempfilePath()

ilCertificate::getBackgroundImageTempfilePath ( )

Returns the filesystem path of the background image temp file during upload.

Returns: string The filesystem path of the background image temp file

Definition at line 197 of file class.ilCertificate.php.

Referenced by deleteBackgroundImage().

     {
         return CLIENT_WEB_DIR . $this->certificatePath . "background_upload.tmp";
     }

Here is the caller graph for this function:

◆ getBackgroundImageThumbPath()

ilCertificate::getBackgroundImageThumbPath ( )

Returns the filesystem path of the background image thumbnail.

Returns: string The filesystem path of the background image thumbnail

Definition at line 187 of file class.ilCertificate.php.

References getBackgroundImageName().

Referenced by ilCertificateSettingsFormRepository\createForm(), deleteBackgroundImage(), and getBackgroundImageThumbPathWeb().

     {
         return CLIENT_WEB_DIR . $this->certificatePath . $this->getBackgroundImageName() . ".thumb.jpg";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBackgroundImageThumbPathWeb()

ilCertificate::getBackgroundImageThumbPathWeb ( )

Returns the web path of the background image thumbnail.

Returns: string The web path of the background image thumbnail

Definition at line 254 of file class.ilCertificate.php.

References getBackgroundImageThumbPath(), and ilUtil\removeTrailingPathSeparators().

     {
         // TODO: this is generic now -> provide better solution
         return str_replace(
             ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
             ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
             $this->getBackgroundImageThumbPath()
         );
     }

Here is the call graph for this function:

◆ getXSLName()

ilCertificate::getXSLName ( )

Returns the filename of the XSL-FO file.

Returns: string The filename of the XSL-FO file

Definition at line 217 of file class.ilCertificate.php.

Referenced by getXSLPath().

     {
         return "certificate.xml";
     }

Here is the caller graph for this function:

◆ getXSLPath()

ilCertificate::getXSLPath ( )

Returns the filesystem path of the XSL-FO file.

Returns: string The filesystem path of the XSL-FO file

Definition at line 207 of file class.ilCertificate.php.

References getXSLName().

Referenced by createCertificateFile().

     {
         return CLIENT_WEB_DIR . $this->certificatePath . $this->getXSLName();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasBackgroundImage()

ilCertificate::hasBackgroundImage ( )

Checks for the background image of the certificate.

Returns: boolean Returns TRUE if the certificate has a background image, FALSE otherwise

Exceptions

ilException

Definition at line 314 of file class.ilCertificate.php.

References $template.

Referenced by ilCertificateSettingsFormRepository\createForm().

     {
         $template = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);
 
         $backgroundImagePath = $template->getBackgroundImagePath();
         if ($backgroundImagePath === '') {
             return false;
         }
 
         $absolutePath = CLIENT_WEB_DIR . $backgroundImagePath;
         
         if (file_exists($absolutePath)
             && (filesize($absolutePath) > 0)
         ) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isActive()

static ilCertificate::isActive ( )

static

Definition at line 423 of file class.ilCertificate.php.

Referenced by ilCourseCertificateAdapter\_preloadListData(), ilPCPlaceHolderGUI\getAvailableTypes(), ilCertificateMigrationJob\getScormCertificates(), ilTestTabsManager\getSettingsSubTabs(), ilExerciseCertificateAdapter\hasUserCertificate(), ilAchievements\isActive(), ilObjExerciseGUI\setSettingsSubTabs(), ilObjSAHSLearningModuleGUI\setSettingsSubTabs(), and ilObjCourseGUI\setSubTabs().

     {
         if (self::$is_active === null) {
             // basic admin setting active?
             $certificate_active = new ilSetting("certificate");
             $certificate_active = (bool) $certificate_active->get("active");
 
             // java/rtpc-server active?
             if ($certificate_active) {
                 include_once './Services/WebServices/RPC/classes/class.ilRPCServerSettings.php';
                 $certificate_active = ilRPCServerSettings::getInstance()->isEnabled();
             }
 
             self::$is_active = (bool) $certificate_active;
         }
 
         return self::$is_active;
     }

Here is the caller graph for this function:

◆ isComplete()

ilCertificate::isComplete ( )

Checks the status of the certificate.

Returns: boolean Returns TRUE if the certificate is complete, FALSE otherwise

Definition at line 338 of file class.ilCertificate.php.

     {
         if (self::isActive()) {
             if ($this->objectId && !self::isObjectActive($this->objectId)) {
                 return false;
             }
 
             return true;
         }
 
         return false;
     }

◆ isObjectActive()

static ilCertificate::isObjectActive ( $a_obj_id )

static

Parameters

int $a_obj_id

Returns: bool

Definition at line 446 of file class.ilCertificate.php.

Referenced by ilExerciseCertificateAdapter\hasUserCertificate(), and ilCertificateMigrationJob\run().

     {
         $chk = self::areObjectsActive(array($a_obj_id));
         return $chk[$a_obj_id];
     }

Here is the caller graph for this function:

◆ readActive()

ilCertificate::readActive ( )

Returns: int

Definition at line 481 of file class.ilCertificate.php.

     {
         $set = $this->db->query("SELECT obj_id FROM il_certificate WHERE obj_id = " . $this->db->quote($this->objectId, "integer"));
         return $this->db->numRows($set);
     }

◆ setAdapter()

ilCertificate::setAdapter ( $adapter )

Sets the adapter.

Parameters

object $adapter Adapter

Definition at line 366 of file class.ilCertificate.php.

References $adapter.

     {
         $this->adapter = &$adapter;
     }

◆ zipCertificatesInArchiveDirectory()

ilCertificate::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 411 of file class.ilCertificate.php.

     {
         $zipfile = time() . "__" . IL_INST_ID . "__" . $this->getAdapter()->getAdapterType() . "__" . $this->getAdapter()->getCertificateId() . "__certificates.zip";
         $zipfilePath = CLIENT_WEB_DIR . $this->certificatePath . $zipfile;
         ilUtil::zip($dir, $zipfilePath);
         ilUtil::delDir($dir);
         if ($deliver) {
             ilUtil::deliverFile($zipfilePath, $zipfile, "application/zip", false, true);
         }
         return $zipfilePath;
     }

Field Documentation

◆ $adapter

ilCertificate::$adapter

protected

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

Referenced by __construct(), getAdapter(), and setAdapter().

◆ $certificatePath

ilCertificate::$certificatePath

private

Definition at line 95 of file class.ilCertificate.php.

Referenced by __construct(), and getBackgroundImageDirectory().

◆ $certificateRepository

ilCertificate::$certificateRepository

private

Definition at line 90 of file class.ilCertificate.php.

Referenced by __construct().

◆ $ctrl

ilCertificate::$ctrl

protected

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

◆ $db

ilCertificate::$db

protected

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

◆ $ilias

ilCertificate::$ilias

protected

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

◆ $is_active

ilCertificate::$is_active

staticprotected

Definition at line 70 of file class.ilCertificate.php.

◆ $lng

ilCertificate::$lng

protected

Definition at line 43 of file class.ilCertificate.php.

◆ $log

ilCertificate::$log

protected

Definition at line 60 of file class.ilCertificate.php.

◆ $objectId

ilCertificate::$objectId

private

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

Referenced by __construct().

◆ $placeholderDescriptionObject

ilCertificate::$placeholderDescriptionObject

private

Definition at line 80 of file class.ilCertificate.php.

Referenced by __construct().

◆ $placeholderValuesObject

ilCertificate::$placeholderValuesObject

private

Definition at line 100 of file class.ilCertificate.php.

Referenced by __construct().

◆ $settings

ilCertificate::$settings

protected

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

◆ $templateRepository

ilCertificate::$templateRepository

private

Definition at line 75 of file class.ilCertificate.php.

Referenced by __construct().

◆ $tree

ilCertificate::$tree

protected

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

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

Services/Certificate/classes/class.ilCertificate.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getXSLName()

◆ addPDFtoArchiveDirectory()

◆ createArchiveDirectory()

◆ createCertificateFile()

◆ deleteBackgroundImage()

◆ getAdapter()

◆ getBackgroundImageDirectory()

◆ getBackgroundImageName()

◆ getBackgroundImagePathWeb()

◆ getBackgroundImageTempfilePath()

◆ getBackgroundImageThumbPath()

◆ getBackgroundImageThumbPathWeb()

◆ getXSLName()

◆ getXSLPath()

◆ hasBackgroundImage()

◆ isActive()

◆ isComplete()

◆ isObjectActive()

◆ readActive()

◆ setAdapter()

◆ zipCertificatesInArchiveDirectory()

Field Documentation

◆ $adapter

◆ $certificatePath

◆ $certificateRepository

◆ $ctrl

◆ $db

◆ $ilias

◆ $is_active

◆ $lng

◆ $log

◆ $objectId

◆ $placeholderDescriptionObject

◆ $placeholderValuesObject

◆ $settings

◆ $templateRepository

◆ $tree