ilCertificate Class Reference

Create PDF certificates. More...

Collaboration diagram for ilCertificate:

Public Member Functions
	__construct (ilCertificateAdapter $adapter)
	ilCertificate constructor More...
	formatNumberString ($a_number)
	getBackgroundImagePath ($asRelative=false)
	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 ()
	Deletes the background image of a certificate. More...
	cloneCertificate ($newObject)
	Clone the certificate for another test object. More...
	deleteCertificate ()
	Deletes the certificate and all it's data. More...
	getFormFieldsFromFO ()
	Convert the XSL-FO to the certificate text and the form settings using XSL transformation. More...
	processXHTML2FO ($form_data, $for_export=false)
	Convert the certificate text to XSL-FO using XSL transformation. More...
	outCertificate ($params, $deliver=true)
	Creates a PDF certificate. More...
	createPreview ()
	Creates a PDF preview of the XSL-FO certificate. More...
	saveCertificate ($xslfo, $filename="")
	Saves the XSL-FO code to a file. More...
	uploadBackgroundImage ($image_tempfilename)
	Uploads a background image for the certificate. More...
	hasBackgroundImage ()
	Checks for the background image of the certificate. More...
	isComplete ()
	Checks the status of the certificate. More...
	getPageFormats ()
	Retrieves predefined page formats. More...
	deliverExportFileXML ()
	Builds an export file in ZIP format and delivers it. More...
	importCertificate ($zipfile, $filename)
	Reads an import ZIP file and creates a certificate of it. 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 ()
	writeActive ($a_value)
	getExchangeContent ()
	outCertificateWithGivenContentAndVariables ($content, array $insert_tags)

Static Public Member Functions
static	_getXSLName ()
	Returns the filename of the XSL-FO file. More...
static	_isComplete ($adapter)
	Checks the status of the certificate. More...
static	isActive ()
static	isObjectActive ($a_obj_id)
static	getCustomCertificateFields ()
	Get custom certificate fields. More...

Protected Attributes
	$ctrl
	$tree
	$ilias
	$lng
	$adapter
	$settings
	$log
	$db

Static Protected Attributes
static	$is_active

Private Member Functions
	exchangeCertificateVariables ($certificate_text, $insert_tags=array())
	Exchanges the variables in the certificate text with given values. More...

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

)

ilCertificate constructor

Parameters

ilCertificateAdapter

$adapter

The certificate adapter needed to construct the certificate

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

References $adapter, $DIC, 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;
    }

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

Referenced by _isComplete().

    {
        return "certificate.xml";
    }

Here is the caller graph for this function:

_isComplete()

static ilCertificate::_isComplete (   $adapter )

static

Checks the status of the certificate.

Parameters

object

$adapter

The certificate adapter

Returns

boolean Returns TRUE if the certificate is complete, FALSE otherwise

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

References $adapter, and _getXSLName().

Referenced by ilCourseVerificationTableGUI\getItems(), ilSCORMVerificationTableGUI\getItems(), ilExerciseVerificationTableGUI\getItems(), ilTestEvaluationGUI\resetfilterEvaluation(), and ilObjExerciseGUI\showOverviewObject().

    {
        if (is_object($adapter) && method_exists($adapter, "getCertificatePath")) {
            if (self::isActive()) {
                $obj_id = $adapter->getCertificateID();
                if ($obj_id && !self::isObjectActive($obj_id)) {
                    return false;
                }
            
                $certificatepath = $adapter->getCertificatePath();
                if (file_exists($certificatepath)) {
                    $xslpath = $adapter->getCertificatePath() . ilCertificate::_getXSLName();
                    if (file_exists($xslpath) && (filesize($xslpath) > 0)) {
                        return true;
                    }
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

cloneCertificate()

ilCertificate::cloneCertificate

(

$newObject

)

Clone the certificate for another test object.

Parameters

$newObject

The new certificate object

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

References getAdapter(), getBackgroundImagePath(), getBackgroundImageThumbPath(), getXSLPath(), ilUtil\makeDirParents(), and readActive().

    {
        $xsl = $this->getXSLPath();
        $bgimage = $this->getBackgroundImagePath();
        $bgimagethumb = $this->getBackgroundImageThumbPath();
        $certificatepath = $this->getAdapter()->getCertificatePath();
        
        $new_xsl = $newObject->getXSLPath();
        $new_bgimage = $newObject->getBackgroundImagePath();
        $new_bgimagethumb = $newObject->getBackgroundImageThumbPath();
        $new_certificatepath = $newObject->getAdapter()->getCertificatePath();
        
        if (@file_exists($xsl)) {
            ilUtil::makeDirParents($new_certificatepath);
            @copy($xsl, $new_xsl);
            if (@file_exists($bgimage)) {
                @copy($bgimage, $new_bgimage);
            }
            if (@file_exists($bgimagethumb)) {
                @copy($bgimagethumb, $new_bgimagethumb);
            }
        }
        
        // #10271
        if ($this->readActive()) {
            $newObject->writeActive(true);
        }
    }

Here is the call graph for this function:

createArchiveDirectory()

ilCertificate::createArchiveDirectory

(

)

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

Referenced by deliverExportFileXML(), and importCertificate().

    {
        $dir = $this->getAdapter()->getCertificatePath() . time() . "__" . IL_INST_ID . "__" . $this->getAdapter()->getAdapterType() . "__" . $this->getAdapter()->getCertificateId() . "__certificate/";
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        ilUtil::makeDirParents($dir);
        return $dir;
    }

Here is the caller graph for this function:

createPreview()

ilCertificate::createPreview

(

)

Creates a PDF preview of the XSL-FO certificate.

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

References ilUtil\deliverData(), exchangeCertificateVariables(), ilRpcClientFactory\factory(), ilMathJax\getInstance(), getXSLPath(), ilMathJax\PURPOSE_PDF, ilMathJax\RENDER_PNG_AS_FO_FILE, and ilDatePresentation\setUseRelativeDates().

    {
        ilDatePresentation::setUseRelativeDates(false);

        $xslfo = file_get_contents($this->getXSLPath());

        // render tex as fo graphics
        require_once('Services/MathJax/classes/class.ilMathJax.php');
        $xslfo = ilMathJax::getInstance()
            ->init(ilMathJax::PURPOSE_PDF)
            ->setRendering(ilMathJax::RENDER_PNG_AS_FO_FILE)
            ->insertLatexImages($xslfo);

        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
        try {
            $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF(
                $this->exchangeCertificateVariables($xslfo)
            );
            ilUtil::deliverData($pdf_base64->scalar, $this->getAdapter()->getCertificateFilename(), "application/pdf");
        } catch (Exception $e) {
            $this->log->write(__METHOD__ . ': ' . $e->getMessage());
            return false;
        }

        ilDatePresentation::setUseRelativeDates(true);
    }

Here is the call graph for this function:

deleteBackgroundImage()

ilCertificate::deleteBackgroundImage

(

)

Deletes the background image of a certificate.

Returns

boolean TRUE if the process succeeds

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

References $result, getBackgroundImagePath(), getBackgroundImageTempfilePath(), and getBackgroundImageThumbPath().

    {
        $result = true;
        if (file_exists($this->getBackgroundImageThumbPath())) {
            $result = $result & unlink($this->getBackgroundImageThumbPath());
        }
        if (file_exists($this->getBackgroundImagePath())) {
            $result = $result & unlink($this->getBackgroundImagePath());
        }
        if (file_exists($this->getBackgroundImageTempfilePath())) {
            $result = $result & unlink($this->getBackgroundImageTempfilePath());
        }
        return $result;
    }

Here is the call graph for this function:

deleteCertificate()

ilCertificate::deleteCertificate

(

)

Deletes the certificate and all it's data.

public

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

References ilUtil\delDir(), getAdapter(), and writeActive().

    {
        if (@file_exists($this->getAdapter()->getCertificatePath())) {
            include_once "./Services/Utilities/classes/class.ilUtil.php";
            ilUtil::delDir($this->getAdapter()->getCertificatePath());
            $this->getAdapter()->deleteCertificate();
        }
        $this->writeActive(false);
    }

Here is the call graph for this function:

deliverExportFileXML()

ilCertificate::deliverExportFileXML

(

)

Builds an export file in ZIP format and delivers it.

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

References createArchiveDirectory(), ilUtil\delDir(), ilUtil\deliverFile(), getAdapter(), ilObjCertificateSettingsAccess\getBackgroundImageName(), getBackgroundImageName(), ilObjCertificateSettingsAccess\getBackgroundImagePath(), getBackgroundImagePath(), getXSLName(), getXSLPath(), ilObjCertificateSettingsAccess\hasBackgroundImage(), hasBackgroundImage(), ilUtil\makeDir(), saveCertificate(), time, and ilUtil\zip().

    {
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        $exportpath = $this->createArchiveDirectory();
        ilUtil::makeDir($exportpath);
        $xsl = file_get_contents($this->getXSLPath());
        $xslexport = str_replace($this->getAdapter()->getCertificatePath(), "", $xsl);
        // save export xsl file
        $this->saveCertificate($xslexport, $exportpath . $this->getXSLName());
        // save background image
        if ($this->hasBackgroundImage()) {
            copy($this->getBackgroundImagePath(), $exportpath . $this->getBackgroundImageName());
        } else {
            include_once "./Services/Certificate/classes/class.ilObjCertificateSettingsAccess.php";
            if (ilObjCertificateSettingsAccess::hasBackgroundImage()) {
                copy(ilObjCertificateSettingsAccess::getBackgroundImagePath(), $exportpath . ilObjCertificateSettingsAccess::getBackgroundImageName());
            }
        }
        $zipfile = time() . "__" . IL_INST_ID . "__" . $this->getAdapter()->getAdapterType() . "__" . $this->getAdapter()->getCertificateId() . "__certificate.zip";
        ilUtil::zip($exportpath, $this->getAdapter()->getCertificatePath() . $zipfile);
        ilUtil::delDir($exportpath);
        ilUtil::deliverFile($this->getAdapter()->getCertificatePath() . $zipfile, $zipfile, "application/zip");
    }

Here is the call graph for this function:

exchangeCertificateVariables()

ilCertificate::exchangeCertificateVariables (   $certificate_text,   $insert_tags = array()  )

private

Exchanges the variables in the certificate text with given values.

Parameters

string	$certificate_text	The XSL-FO certificate text
array	$insert_tags	An associative array containing the variables and the values to replace

Returns

string XSL-FO code

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

References getAdapter(), and ilUtil\prepareFormOutput().

Referenced by createPreview(), and outCertificate().

    {
        if (count($insert_tags) == 0) {
            $insert_tags = $this->getAdapter()->getCertificateVariablesForPreview();
            foreach (self::getCustomCertificateFields() as $k => $f) {
                $insert_tags[$f["ph"]] = ilUtil::prepareFormOutput($f["name"]);
            }
        }
        foreach ($insert_tags as $var => $value) {
            $certificate_text = str_replace($var, $value, $certificate_text);
        }

        $certificate_text = str_replace('[CLIENT_WEB_DIR]', CLIENT_WEB_DIR, $certificate_text);

        return $certificate_text;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

formatNumberString()

ilCertificate::formatNumberString

(

$a_number

)

Parameters

string

$a_number

Returns

float

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

    {
        return str_replace(',', '.', $a_number);
    }

getAdapter()

ilCertificate::getAdapter

(

)

Gets the adapter.

Returns

object Adapter

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

References $adapter.

Referenced by cloneCertificate(), deleteCertificate(), deliverExportFileXML(), exchangeCertificateVariables(), getBackgroundImagePath(), getBackgroundImagePathWeb(), getBackgroundImageTempfilePath(), getBackgroundImageThumbPath(), getFormFieldsFromFO(), getXSLPath(), importCertificate(), isComplete(), outCertificate(), saveCertificate(), and uploadBackgroundImage().

    {
        return $this->adapter;
    }

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

Referenced by deliverExportFileXML(), getBackgroundImagePath(), getBackgroundImagePathWeb(), getBackgroundImageThumbPath(), and uploadBackgroundImage().

    {
        return "background.jpg";
    }

Here is the caller graph for this function:

getBackgroundImagePath()

ilCertificate::getBackgroundImagePath

(

$asRelative = false

)

Returns the filesystem path of the background image.

Parameters

bool

$asRelative

Returns

string The filesystem path of the background image

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

References array, getAdapter(), and getBackgroundImageName().

Referenced by cloneCertificate(), deleteBackgroundImage(), deliverExportFileXML(), hasBackgroundImage(), importCertificate(), processXHTML2FO(), and uploadBackgroundImage().

    {
        if ($asRelative) {
            return str_replace(
                array(CLIENT_WEB_DIR, '//'),
                array('[CLIENT_WEB_DIR]', '/'),
                $this->getAdapter()->getCertificatePath() . $this->getBackgroundImageName()
            );
        }

        return $this->getAdapter()->getCertificatePath() . $this->getBackgroundImageName();
    }

Here is the call graph for this function:

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

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

    {
        // TODO: this is generic now -> provide better solution
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        $webdir = $this->getAdapter()->getCertificatePath() . $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 143 of file class.ilCertificate.php.

References getAdapter().

Referenced by deleteBackgroundImage(), and uploadBackgroundImage().

    {
        return $this->getAdapter()->getCertificatePath() . "background_upload.tmp";
    }

Here is the call graph for this function:

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

References getAdapter(), and getBackgroundImageName().

Referenced by cloneCertificate(), deleteBackgroundImage(), getBackgroundImageThumbPathWeb(), importCertificate(), and uploadBackgroundImage().

    {
        return $this->getAdapter()->getCertificatePath() . $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 196 of file class.ilCertificate.php.

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

    {
        // TODO: this is generic now -> provide better solution
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $this->getBackgroundImageThumbPath());
    }

Here is the call graph for this function:

getCustomCertificateFields()

static ilCertificate::getCustomCertificateFields ( )

static

Get custom certificate fields.

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

Referenced by ilCertificateGUI\certificateEditor().

    {
        include_once("./Services/User/classes/class.ilUserDefinedFields.php");
        $user_field_definitions = ilUserDefinedFields::_getInstance();
        $fds = $user_field_definitions->getDefinitions();
        $fields = array();
        foreach ($fds as $f) {
            if ($f["certificate"]) {
                $fields[$f["field_id"]] = array("name" => $f["field_name"],
                    "ph" => "[#" . str_replace(" ", "_", strtoupper($f["field_name"])) . "]");
            }
        }
        
        return $fields;
    }

Here is the caller graph for this function:

getExchangeContent()

ilCertificate::getExchangeContent

(

)

Returns

string

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

    {
        if (!file_exists($this->getXSLPath())) {
            return '';
        }

        $output           = '';
        $xsl_file_content = file_get_contents($this->getXSLPath());
        $xsl              = file_get_contents("./Services/Certificate/xml/fo2xhtml.xsl");

        if ((strlen($xsl_file_content)) && (strlen($xsl))) {
            $args   = array('/_xml' => $xsl_file_content, '/_xsl' => $xsl);
            $xh     = xslt_create();
            $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, null);
            xslt_error($xh);
            xslt_free($xh);
        }

        $output = preg_replace("/<\?xml[^>]+?>/", "", $output);
        // dirty hack: the php xslt processing seems not to recognize the following
        // replacements, so we do it in the code as well
        $output = str_replace("&#xA0;", "<br />", $output);
        $output = str_replace("&#160;", "<br />", $output);

        return $output;
    }

getFormFieldsFromFO()

ilCertificate::getFormFieldsFromFO

(

)

Convert the XSL-FO to the certificate text and the form settings using XSL transformation.

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

References $output, array, getAdapter(), getXSLPath(), xslt_create(), xslt_error(), and xslt_free().

    {
        if (@file_exists($this->getXSLPath())) {
            $xslfo = file_get_contents($this->getXSLPath());
        }
        // retrieve form information (using a dirty way with regular expressions)
        $pagewidth = "21cm";
        if (preg_match("/page-width\=\"([^\"]+)\"/", $xslfo, $matches)) {
            $pagewidth = $matches[1];
        }
        $pageheight = "29.7cm";
        if (preg_match("/page-height\=\"([^\"]+)\"/", $xslfo, $matches)) {
            $pageheight = $matches[1];
        }
        $certificatesettings = new ilSetting("certificate");
        $pagesize = $certificatesettings->get("pageformat");
        ;
        if (((strcmp($pageheight, "29.7cm") == 0) || (strcmp($pageheight, "297mm") == 0)) && ((strcmp($pagewidth, "21cm") == 0) || (strcmp($pagewidth, "210mm") == 0))) {
            $pagesize = "a4";
        } elseif (((strcmp($pagewidth, "29.7cm") == 0) || (strcmp($pagewidth, "297mm") == 0)) && ((strcmp($pageheight, "21cm") == 0) || (strcmp($pageheight, "210mm") == 0))) {
            $pagesize = "a4landscape";
        } elseif (((strcmp($pageheight, "21cm") == 0) || (strcmp($pageheight, "210mm") == 0)) && ((strcmp($pagewidth, "14.8cm") == 0) || (strcmp($pagewidth, "148mm") == 0))) {
            $pagesize = "a5";
        } elseif (((strcmp($pagewidth, "21cm") == 0) || (strcmp($pagewidth, "210mm") == 0)) && ((strcmp($pageheight, "14.8cm") == 0) || (strcmp($pageheight, "148mm") == 0))) {
            $pagesize = "a5landscape";
        } elseif (((strcmp($pageheight, "11in") == 0)) && ((strcmp($pagewidth, "8.5in") == 0))) {
            $pagesize = "letter";
        } elseif (((strcmp($pagewidth, "11in") == 0)) && ((strcmp($pageheight, "8.5in") == 0))) {
            $pagesize = "letterlandscape";
        } else {
            $pagesize = "custom";
        }
        if (!strlen($xslfo)) {
            $pagesize = $certificatesettings->get("pageformat");
        };
        
        $marginbody_top = "0cm";
        $marginbody_right = "2cm";
        $marginbody_bottom = "0cm";
        $marginbody_left = "2cm";
        if (preg_match("/fo:flow[^>]*margin\=\"([^\"]+)\"/", $xslfo, $matches)) {
            // Backwards compatibility
            $marginbody = $matches[1];
            if (preg_match_all("/([^\s]+)/", $marginbody, $matches)) {
                $marginbody_top = $matches[1][0];
                $marginbody_right = $matches[1][1];
                $marginbody_bottom = $matches[1][2];
                $marginbody_left = $matches[1][3];
            }
        } elseif (preg_match("/fo:region-body[^>]*margin\=\"([^\"]+)\"/", $xslfo, $matches)) {
            $marginbody = $matches[1];
            if (preg_match_all("/([^\s]+)/", $marginbody, $matches)) {
                $marginbody_top = $matches[1][0];
                $marginbody_right = $matches[1][1];
                $marginbody_bottom = $matches[1][2];
                $marginbody_left = $matches[1][3];
            }
        }

        $xsl = file_get_contents("./Services/Certificate/xml/fo2xhtml.xsl");
        if ((strlen($xslfo)) && (strlen($xsl))) {
            $args = array( '/_xml' => $xslfo, '/_xsl' => $xsl );
            $xh = xslt_create();
            $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, null);
            xslt_error($xh);
            xslt_free($xh);
        }

        $output = preg_replace("/<\?xml[^>]+?>/", "", $output);
        // dirty hack: the php xslt processing seems not to recognize the following
        // replacements, so we do it in the code as well
        $output = str_replace("&#xA0;", "<br />", $output);
        $output = str_replace("&#160;", "<br />", $output);
        $form_fields = array(
            "pageformat" => $pagesize,
            "pagewidth" => $pagewidth,
            "pageheight" => $pageheight,
            "margin_body_top" => $marginbody_top,
            "margin_body_right" => $marginbody_right,
            "margin_body_bottom" => $marginbody_bottom,
            "margin_body_left" => $marginbody_left,
            "certificate_text" => $output
        );
        $this->getAdapter()->addFormFieldsFromObject($form_fields);
        return $form_fields;
    }

Here is the call graph for this function:

getPageFormats()

ilCertificate::getPageFormats

(

)

Retrieves predefined page formats.

Returns

array Associative array containing available page formats

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

References array.

Referenced by processXHTML2FO().

    {
        return array(
            "a4" => array(
                "name" => $this->lng->txt("certificate_a4"), // (297 mm x 210 mm)
                "value" => "a4",
                "width" => "210mm",
                "height" => "297mm"
            ),
            "a4landscape" => array(
                "name" => $this->lng->txt("certificate_a4_landscape"), // (210 mm x 297 mm)",
                "value" => "a4landscape",
                "width" => "297mm",
                "height" => "210mm"
            ),
            "a5" => array(
                "name" => $this->lng->txt("certificate_a5"), // (210 mm x 148.5 mm)
                "value" => "a5",
                "width" => "148mm",
                "height" => "210mm"
            ),
            "a5landscape" => array(
                "name" => $this->lng->txt("certificate_a5_landscape"), // (148.5 mm x 210 mm)
                "value" => "a5landscape",
                "width" => "210mm",
                "height" => "148mm"
            ),
            "letter" => array(
                "name" => $this->lng->txt("certificate_letter"), // (11 inch x 8.5 inch)
                "value" => "letter",
                "width" => "8.5in",
                "height" => "11in"
            ),
            "letterlandscape" => array(
                "name" => $this->lng->txt("certificate_letter_landscape"), // (8.5 inch x 11 inch)
                "value" => "letterlandscape",
                "width" => "11in",
                "height" => "8.5in"
            ),
            "custom" => array(
                "name" => $this->lng->txt("certificate_custom"),
                "value" => "custom",
                "width" => "",
                "height" => ""
            )
        );
    }

Here is the caller 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 163 of file class.ilCertificate.php.

Referenced by deliverExportFileXML(), and 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 153 of file class.ilCertificate.php.

References getAdapter(), and getXSLName().

Referenced by cloneCertificate(), createPreview(), deliverExportFileXML(), getFormFieldsFromFO(), isComplete(), outCertificate(), and saveCertificate().

    {
        return $this->getAdapter()->getCertificatePath() . $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

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

References getBackgroundImagePath().

Referenced by deliverExportFileXML(), and processXHTML2FO().

    {
        if (file_exists($this->getBackgroundImagePath()) && (filesize($this->getBackgroundImagePath()) > 0)) {
            return true;
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importCertificate()

ilCertificate::importCertificate	(		$zipfile,
			$filename
	)

Reads an import ZIP file and creates a certificate of it.

Returns

boolean TRUE if the import succeeds, FALSE otherwise

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

References $file, $filename, array, ilUtil\convertImage(), createArchiveDirectory(), ilUtil\delDir(), getAdapter(), getBackgroundImagePath(), getBackgroundImageThumbPath(), ilUtil\getDir(), saveCertificate(), and ilUtil\unzip().

    {
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        $importpath = $this->createArchiveDirectory();
        if (!ilUtil::moveUploadedFile($zipfile, $filename, $importpath . $filename)) {
            ilUtil::delDir($importpath);
            return false;
        }
        ilUtil::unzip($importpath . $filename, true);
        $subdir = str_replace(".zip", "", strtolower($filename)) . "/";
        $copydir = "";
        if (is_dir($importpath . $subdir)) {
            $dirinfo = ilUtil::getDir($importpath . $subdir);
            $copydir = $importpath . $subdir;
        } else {
            $dirinfo = ilUtil::getDir($importpath);
            $copydir = $importpath;
        }
        $xmlfiles = 0;
        $otherfiles = 0;
        foreach ($dirinfo as $file) {
            if (strcmp($file["type"], "file") == 0) {
                if (strpos($file["entry"], ".xml") !== false) {
                    $xmlfiles++;
                } elseif (strpos($file["entry"], ".zip") !== false) {
                } else {
                    $otherfiles++;
                }
            }
        }
        // if one XML file is in the archive, we try to import it
        if ($xmlfiles == 1) {
            foreach ($dirinfo as $file) {
                if (strcmp($file["type"], "file") == 0) {
                    if (strpos($file["entry"], ".xml") !== false) {
                        $xsl = file_get_contents($copydir . $file["entry"]);
                        // as long as we cannot make RPC calls in a given directory, we have
                        // to add the complete path to every url
                        $xsl = preg_replace_callback("/url\([']{0,1}(.*?)[']{0,1}\)/", function (array $matches) {
                            $basePath = rtrim(dirname($this->getBackgroundImagePath(true)), '/');
                            $fileName = basename($matches[1]);
                            
                            return 'url(' . $basePath . '/' . $fileName . ')';
                        }, $xsl);
                        $this->saveCertificate($xsl);
                    } elseif (strpos($file["entry"], ".zip") !== false) {
                    } else {
                        @copy($copydir . $file["entry"], $this->getAdapter()->getCertificatePath() . $file["entry"]);
                        if (strcmp($this->getBackgroundImagePath(), $this->getAdapter()->getCertificatePath() . $file["entry"]) == 0) {
                            // upload of the background image, create a preview
                            ilUtil::convertImage($this->getBackgroundImagePath(), $this->getBackgroundImageThumbPath(), "JPEG", 100);
                        }
                    }
                }
            }
        } else {
            ilUtil::delDir($importpath);
            return false;
        }
        ilUtil::delDir($importpath);
        return true;
    }

Here is the call graph for this function:

isActive()

static ilCertificate::isActive ( )

static

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

Referenced by ilCourseParticipantsTableGUI\__construct(), ilObjSAHSLearningModuleAccess\_lookupUserCertificate(), ilCourseCertificateAdapter\_preloadListData(), ilObjCourseGUI\deliverCertificateObject(), ilPCPlaceHolderGUI\getAvailableTypes(), ilSCORMVerificationTableGUI\getItems(), ilObjTestGUI\getStatisticsSubTabs(), ilObjExercise\hasUserCertificate(), ilObjCourseGUI\initHeaderAction(), 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 602 of file class.ilCertificate.php.

References getAdapter(), and getXSLPath().

    {
        if (self::isActive()) {
            $obj_id = $this->getAdapter()->getCertificateID();
            if ($obj_id && !self::isObjectActive($obj_id)) {
                return false;
            }
            if (file_exists($this->getAdapter()->getCertificatePath())) {
                if (file_exists($this->getXSLPath()) && (filesize($this->getXSLPath()) > 0)) {
                    return true;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

isObjectActive()

static ilCertificate::isObjectActive (   $a_obj_id )

static

Parameters

int

$a_obj_id

Returns

bool

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

Referenced by ilCourseParticipantsTableGUI\__construct(), ilObjSAHSLearningModuleAccess\_lookupUserCertificate(), ilObjCourseGUI\deliverCertificateObject(), ilObjExercise\hasUserCertificate(), and ilObjCourseGUI\initHeaderAction().

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

Here is the caller graph for this function:

outCertificate()

ilCertificate::outCertificate	(		$params,
			$deliver = true
	)

Creates a PDF certificate.

Parameters

array	$params	An array of parameters which is needed to create the certificate
bool	$deliver

Returns

void|string

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

References $params, ilUtil\deliverData(), exchangeCertificateVariables(), ilRpcClientFactory\factory(), getAdapter(), ilMathJax\getInstance(), getXSLPath(), ilUtil\prepareFormOutput(), ilMathJax\PURPOSE_PDF, ilMathJax\RENDER_PNG_AS_FO_FILE, and ilDatePresentation\setUseRelativeDates().

    {
        ilDatePresentation::setUseRelativeDates(false);
        $insert_tags = $this->getAdapter()->getCertificateVariablesForPresentation($params);
        
        include_once("./Services/User/classes/class.ilUserDefinedData.php");
        $cust_data = new ilUserDefinedData($this->getAdapter()->getUserIdForParams($params));
        $cust_data = $cust_data->getAll();
        foreach (self::getCustomCertificateFields() as $k => $f) {
            $insert_tags[$f["ph"]] = ilUtil::prepareFormOutput($cust_data["f_" . $k]);
        }

        $xslfo = file_get_contents($this->getXSLPath());

        // render tex as fo graphics
        require_once('Services/MathJax/classes/class.ilMathJax.php');
        $xslfo = ilMathJax::getInstance()
            ->init(ilMathJax::PURPOSE_PDF)
            ->setRendering(ilMathJax::RENDER_PNG_AS_FO_FILE)
            ->insertLatexImages($xslfo);

        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
        try {
            $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF(
                $this->exchangeCertificateVariables($xslfo, $insert_tags)
            );
            if ($deliver) {
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                ilUtil::deliverData($pdf_base64->scalar, $this->getAdapter()->getCertificateFilename($params), "application/pdf");
            } else {
                return $pdf_base64->scalar;
            }
        } catch (Exception $e) {
            $this->log->write(__METHOD__ . ': ' . $e->getMessage());
            return false;
        }

        ilDatePresentation::setUseRelativeDates(true);
    }

Here is the call graph for this function:

outCertificateWithGivenContentAndVariables()

ilCertificate::outCertificateWithGivenContentAndVariables	(		$content,
		array	$insert_tags
	)

Parameters

string	$content
array	$insert_tags

Returns

bool

Exceptions

Exception

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

    {
        ilDatePresentation::setUseRelativeDates(false);

        $form_fields = $this->getFormFieldsFromFO();
        $form_fields['certificate_text'] = $content;
        $xslfo = $this->processXHTML2FO($form_fields);

        $content = $this->exchangeCertificateVariables($xslfo, $insert_tags);
        $content = str_replace('[BR]', "<fo:block/>", $content);

        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
        try {
            $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF($content);
            include_once "./Services/Utilities/classes/class.ilUtil.php";
            ilUtil::deliverData($pdf_base64->scalar, $this->getAdapter()->getCertificateFilename(array()), "application/pdf");
        } catch (Exception $e) {
            $this->log->write(__METHOD__ . ': ' . $e->getMessage());
            return false;
        }

        ilDatePresentation::setUseRelativeDates(true);
    }

processXHTML2FO()

ilCertificate::processXHTML2FO	(		$form_data,
			$for_export = false
	)

Convert the certificate text to XSL-FO using XSL transformation.

Parameters

array

$form_data

The form data

Returns

string XSL-FO code

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

References $output, $params, array, ilObjCertificateSettingsAccess\getBackgroundImagePath(), getBackgroundImagePath(), getPageFormats(), ilObjCertificateSettingsAccess\hasBackgroundImage(), hasBackgroundImage(), settings(), xslt_create(), xslt_error(), and xslt_free().

    {
        $content = "<html><body>" . $form_data["certificate_text"] . "</body></html>";
        $content = preg_replace("/<p>(&nbsp;){1,}<\\/p>/", "<p></p>", $content);
        $content = preg_replace("/<p>(\\s)*?<\\/p>/", "<p></p>", $content);
        //              $content = str_replace("<p>&nbsp;</p>", "<p><br /></p>", $content);
        //              $content = str_replace("<p> </p>", "<p><br /></p>", $content);
        $content = str_replace("<p></p>", "<p class=\"emptyrow\"></p>", $content);
        $content = str_replace("&nbsp;", "&#160;", $content);
        $content = preg_replace("//", "", $content);

        include_once "./Services/Certificate/classes/class.ilXmlChecker.php";
        $check = new ilXMLChecker();
        $check->setXMLContent($content);
        $check->startParsing();
        if ($check->hasError()) {
            throw new Exception($this->lng->txt("certificate_not_well_formed"));
        }

        $xsl = file_get_contents("./Services/Certificate/xml/xhtml2fo.xsl");
        
        // additional font support
        $xsl = str_replace(
            'font-family="Helvetica, unifont"',
            'font-family="' . $this->settings->get('rpc_pdf_font', 'Helvetica, unifont') . '"',
            $xsl
        );
        
        $args = array( '/_xml' => $content, '/_xsl' => $xsl );
        $xh = xslt_create();
        if (strcmp($form_data["pageformat"], "custom") == 0) {
            $pageheight = $form_data["pageheight"];
            $pagewidth = $form_data["pagewidth"];
        } else {
            $pageformats = $this->getPageFormats();
            $pageheight = $pageformats[$form_data["pageformat"]]["height"];
            $pagewidth = $pageformats[$form_data["pageformat"]]["width"];
        }
        include_once "./Services/Certificate/classes/class.ilObjCertificateSettingsAccess.php";
        $backgroundimage = $this->hasBackgroundImage() ? $this->getBackgroundImagePath(true) : ((ilObjCertificateSettingsAccess::hasBackgroundImage()) ? ilObjCertificateSettingsAccess::getBackgroundImagePath(true) : "");
        $params = array(
            "pageheight"      => $pageheight,
            "pagewidth"       => $pagewidth,
            "backgroundimage" => $backgroundimage,
            "marginbody"      => implode(' ', array(
                $form_data["margin_body_top"],
                $form_data["margin_body_right"],
                $form_data["margin_body_bottom"],
                $form_data["margin_body_left"]
            ))
        );
        $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", null, $args, $params);
        xslt_error($xh);
        xslt_free($xh);
        return $output;
    }

Here is the call graph for this function:

readActive()

ilCertificate::readActive

(

)

Returns

int

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

Referenced by cloneCertificate().

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

Here is the caller graph for this function:

saveCertificate()

ilCertificate::saveCertificate	(		$xslfo,
			$filename = ""
	)

Saves the XSL-FO code to a file.

Parameters

string

$xslfo

XSL-FO code

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

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

Referenced by deliverExportFileXML(), and importCertificate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setAdapter()

ilCertificate::setAdapter

(

$adapter

)

Sets the adapter.

Parameters

object

$adapter

Adapter

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

References $adapter.

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

uploadBackgroundImage()

ilCertificate::uploadBackgroundImage

(

$image_tempfilename

)

Uploads a background image for the certificate.

Creates a new directory for the certificate if needed. Removes an existing certificate image if necessary

Parameters

string

$image_tempfilename

Name of the temporary uploaded image file

Returns

integer An errorcode if the image upload fails, 0 otherwise

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

References ilUtil\convertImage(), getAdapter(), getBackgroundImageName(), getBackgroundImagePath(), getBackgroundImageTempfilePath(), getBackgroundImageThumbPath(), and ilUtil\makeDirParents().

    {
        if (!empty($image_tempfilename)) {
            $convert_filename = $this->getBackgroundImageName();
            $imagepath = $this->getAdapter()->getCertificatePath();
            if (!file_exists($imagepath)) {
                ilUtil::makeDirParents($imagepath);
            }
            // upload the file
            if (!ilUtil::moveUploadedFile(
                $image_tempfilename,
                basename($this->getBackgroundImageTempfilePath()),
                $this->getBackgroundImageTempfilePath()
            )) {
                return false;
            }
            // convert the uploaded file to JPEG
            ilUtil::convertImage($this->getBackgroundImageTempfilePath(), $this->getBackgroundImagePath(), "JPEG");
            ilUtil::convertImage($this->getBackgroundImageTempfilePath(), $this->getBackgroundImageThumbPath(), "JPEG", 100);
            if (!file_exists($this->getBackgroundImagePath())) {
                // something went wrong converting the file. use the original file and hope, that PDF can work with it
                if (!ilUtil::moveUploadedFile($this->getBackgroundImageTempfilePath(), $convert_filename, $this->getBackgroundImagePath())) {
                    return false;
                }
            }
            unlink($this->getBackgroundImageTempfilePath());
            if (file_exists($this->getBackgroundImagePath()) && (filesize($this->getBackgroundImagePath()) > 0)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

writeActive()

ilCertificate::writeActive

(

$a_value

)

Parameters

$a_value

bool

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

Referenced by deleteCertificate().

    {
        $obj_id = $this->adapter->getCertificateID();

        if ((bool) $a_value) {
            $this->db->replace("il_certificate", array("obj_id" => array("integer", $obj_id)), array());
        } else {
            $this->db->manipulate("DELETE FROM il_certificate WHERE obj_id = " . $this->db->quote($obj_id, "integer"));
        }
    }

Here is the caller graph for this function:

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

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

Field Documentation

$adapter

ilCertificate::$adapter

protected

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

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

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

$settings

ilCertificate::$settings

protected

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

$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