ilCertificateGUI Class Reference

GUI class to create PDF certificates. More...

Collaboration diagram for ilCertificateGUI:

Public Member Functions
	__construct (ilCertificateAdapter $adapter)
	ilCertificateGUI constructor More...
	executeCommand ()
	execute command More...
	getCommand ($cmd)
	Retrieves the ilCtrl command. More...
	certificateImport ()
	Import a certificate from a ZIP archive. More...
	certificatePreview ()
	Creates a certificate preview. More...
	certificateExportFO ()
	Exports the certificate. More...
	certificateRemoveBackground ()
	Removes the background image of a certificate. More...
	certificateDelete ()
	Deletes the certificate and all its data. More...
	certificateDeleteConfirm ()
	Deletes the certificate and all its data. More...
	certificateSave ()
	Saves the certificate. More...
	certificateUpload ()
	Uploads the certificate. More...
	certificateEditor ()
	Shows the certificate editor for ILIAS tests. More...

Protected Member Functions
	getFormFieldsFromPOST ()
	Get the form values from an HTTP POST. More...
	getFormFieldsFromFO ()
	Get the form values from the certificate xsl-fo. More...

Protected Attributes
	$object
	$ctrl
	$tree
	$ilias
	$tpl
	$lng
	$ref_id
	$acccess
	$toolbar

Detailed Description

GUI class to create PDF certificates.

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 33 of file class.ilCertificateGUI.php.

Constructor & Destructor Documentation

__construct()

ilCertificateGUI::__construct

(

ilCertificateAdapter

$adapter

)

ilCertificateGUI constructor

Parameters

ilCertificateAdapter

$adapter

A reference to the test container object @access public

Definition at line 98 of file class.ilCertificateGUI.php.

    {
        global $DIC;
 
        include_once "./Services/Certificate/classes/class.ilCertificate.php";
        $this->object = new ilCertificate($adapter);
 
        $this->lng     = $DIC['lng'];
        $this->tpl     = $DIC['tpl'];
        $this->ctrl    = $DIC['ilCtrl'];
        $this->ilias   = $DIC['ilias'];
        $this->tree    = $DIC['tree'];
        $this->tree    = $DIC['tree'];
        $this->acccess = $DIC['ilAccess'];
        $this->toolbar = $DIC['ilToolbar'];
 
        $this->ref_id = (int) $_GET['ref_id'];
 
        $this->lng->loadLanguageModule('certificate');
    }

References $_GET, $adapter, and $DIC.

Member Function Documentation

certificateDelete()

ilCertificateGUI::certificateDelete

(

)

Deletes the certificate and all its data.

Definition at line 180 of file class.ilCertificateGUI.php.

    {
        // display confirmation message
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this, "certificateEditor"));
        $cgui->setHeaderText($this->lng->txt("certificate_confirm_deletion_text"));
        $cgui->setCancel($this->lng->txt("no"), "certificateEditor");
        $cgui->setConfirm($this->lng->txt("yes"), "certificateDeleteConfirm");
        
        $this->tpl->setContent($cgui->getHTML());
    }

certificateDeleteConfirm()

ilCertificateGUI::certificateDeleteConfirm

(

)

Deletes the certificate and all its data.

Definition at line 196 of file class.ilCertificateGUI.php.

    {
        $this->object->deleteCertificate();
        $this->ctrl->redirect($this, "certificateEditor");
    }

certificateEditor()

ilCertificateGUI::certificateEditor

(

)

Shows the certificate editor for ILIAS tests.

Definition at line 252 of file class.ilCertificateGUI.php.

    {
        if (strcmp($this->ctrl->getCmd(), "certificateSave") == 0) {
            $form_fields = $this->getFormFieldsFromPOST();
        } else {
            $form_fields = $this->getFormFieldsFromFO();
        }
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("certificate_edit"));
        $form->setMultipart(true);
        $form->setTableWidth("100%");
        $form->setId("certificate");
        
        $active = new ilCheckboxInputGUI($this->lng->txt("active"), "active");
        $active->setChecked($form_fields["active"]);
        $form->addItem($active);
 
        $import = new ilFileInputGUI($this->lng->txt("import"), "certificate_import");
        $import->setRequired(false);
        $import->setSuffixes(array("zip"));
        // handle the certificate import
        if (strlen($_FILES["certificate_import"]["name"])) {
            if ($import->checkInput()) {
                $result = $this->object->importCertificate($_FILES["certificate_import"]["tmp_name"], $_FILES["certificate_import"]["name"]);
                if ($result == false) {
                    $import->setAlert($this->lng->txt("certificate_error_import"));
                } else {
                    $this->ctrl->redirect($this, "certificateEditor");
                }
            }
        }
        $form->addItem($import);
 
        $pageformat  = new ilRadioGroupInputGUI($this->lng->txt("certificate_page_format"), "pageformat");
        $pageformats = $this->object->getPageFormats();
        $pageformat->setValue($form_fields["pageformat"]);
        foreach ($pageformats as $format) {
            $option = new ilRadioOption($format["name"], $format["value"]);
            if (strcmp($format["value"], "custom") == 0) {
                $pageheight = new ilTextInputGUI($this->lng->txt("certificate_pageheight"), "pageheight");
                $pageheight->setValue($form_fields["pageheight"]);
                $pageheight->setSize(6);
                $pageheight->setValidationRegexp('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*)))(cm|mm|in|pt|pc|px|em)$/is');
                $pageheight->setInfo($this->lng->txt("certificate_unit_description"));
                $pageheight->setRequired(true);
                $option->addSubitem($pageheight);
 
                $pagewidth = new ilTextInputGUI($this->lng->txt("certificate_pagewidth"), "pagewidth");
                $pagewidth->setValue($form_fields["pagewidth"]);
                $pagewidth->setSize(6);
                $pagewidth->setValidationRegexp('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*)))(cm|mm|in|pt|pc|px|em)$/is');
                $pagewidth->setInfo($this->lng->txt("certificate_unit_description"));
                $pagewidth->setRequired(true);
                $option->addSubitem($pagewidth);
            }
            $pageformat->addOption($option);
        }
        $pageformat->setRequired(true);
        if (strcmp($this->ctrl->getCmd(), "certificateSave") == 0) {
            $pageformat->checkInput();
        }
        
        $form->addItem($pageformat);
 
        $bgimage = new ilImageFileInputGUI($this->lng->txt("certificate_background_image"), "background");
        $bgimage->setRequired(false);
        $bgimage->setUseCache(false);
        if (count($_POST)) {
            // handle the background upload
            if (strlen($_FILES["background"]["tmp_name"])) {
                if ($bgimage->checkInput()) {
                    $result = $this->object->uploadBackgroundImage($_FILES["background"]["tmp_name"]);
                    if ($result == false) {
                        $bgimage->setAlert($this->lng->txt("certificate_error_upload_bgimage"));
                    }
                }
            }
        }
        if (!$this->object->hasBackgroundImage()) {
            include_once "./Services/Certificate/classes/class.ilObjCertificateSettingsAccess.php";
            if (ilObjCertificateSettingsAccess::hasBackgroundImage()) {
                require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
                ilWACSignedPath::setTokenMaxLifetimeInSeconds(15);
                $bgimage->setImage(ilWACSignedPath::signFile(ilObjCertificateSettingsAccess::getBackgroundImageThumbPathWeb()));
            }
        } else {
            require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
            ilWACSignedPath::setTokenMaxLifetimeInSeconds(15);
            $bgimage->setImage(ilWACSignedPath::signFile($this->object->getBackgroundImageThumbPathWeb()));
        }
        $form->addItem($bgimage);
 
        $rect = new ilCSSRectInputGUI($this->lng->txt("certificate_margin_body"), "margin_body");
        $rect->setRequired(true);
        $rect->setUseUnits(true);
        $rect->setTop($form_fields["margin_body_top"]);
        $rect->setBottom($form_fields["margin_body_bottom"]);
        $rect->setLeft($form_fields["margin_body_left"]);
        $rect->setRight($form_fields["margin_body_right"]);
        $rect->setInfo($this->lng->txt("certificate_unit_description"));
        if (strcmp($this->ctrl->getCmd(), "certificateSave") == 0) {
            $rect->checkInput();
        }
        $form->addItem($rect);
        
        $certificate = new ilTextAreaInputGUI($this->lng->txt("certificate_text"), "certificate_text");
        $certificate->removePlugin('ilimgupload');
        $certificate->setValue($form_fields["certificate_text"]);
        $certificate->setRequired(true);
        $certificate->setRows(20);
        $certificate->setCols(80);
        
        // fraunhpatch start
        $common_desc_tpl = new ilTemplate("tpl.common_desc.html", true, true, "Services/Certificate");
        foreach (ilCertificate::getCustomCertificateFields() as $f) {
            $common_desc_tpl->setCurrentBlock("cert_field");
            $common_desc_tpl->setVariable("PH", $f["ph"]);
            $common_desc_tpl->setVariable("PH_TXT", $f["name"]);
            $common_desc_tpl->parseCurrentBlock();
        }
        $common_desc = $common_desc_tpl->get();
        // fraunhpatch start
        
        $certificate->setInfo($this->object->getAdapter()->getCertificateVariablesDescription() . $common_desc);
        $certificate->setUseRte(true, '3.4.7');
        $tags = array(
        "br",
        "em",
        "font",
        "li",
        "ol",
        "p",
        "span",
        "strong",
        "u",
        "ul"
        );
        $certificate->setRteTags($tags);
        if (strcmp($this->ctrl->getCmd(), "certificateSave") == 0) {
            $certificate->checkInput();
        }
        $form->addItem($certificate);
 
        $this->object->getAdapter()->addAdditionalFormElements($form, $form_fields);
 
        if ($this->acccess->checkAccess("write", "", $_GET["ref_id"])) {
            if ($this->object->isComplete() || $this->object->hasBackgroundImage()) {
                $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
 
                require_once 'Services/UIComponent/Button/classes/class.ilSubmitButton.php';
                $preview = ilSubmitButton::getInstance();
                $preview->setCaption('certificate_preview');
                $preview->setCommand('certificatePreview');
                $this->toolbar->addStickyItem($preview);
 
                $export = ilSubmitButton::getInstance();
                $export->setCaption('certificate_export');
                $export->setCommand('certificateExportFO');
                $this->toolbar->addButtonInstance($export);
 
                $delete = ilSubmitButton::getInstance();
                $delete->setCaption('delete');
                $delete->setCommand('certificateDelete');
                $this->toolbar->addButtonInstance($delete);
            }
            $form->addCommandButton("certificateSave", $this->lng->txt("save"));
        }
 
        $this->tpl->setVariable("ADM_CONTENT", $form->getHTML());
 
        if (strcmp($this->ctrl->getCmd(), "certificateSave") == 0) {
            if ($_POST["background_delete"]) {
                $this->object->deleteBackgroundImage();
            }
            if ($form->checkInput()) {
                try {
                    $xslfo = $this->object->processXHTML2FO($form_fields);
                    $this->object->getAdapter()->saveFormFields($form_fields);
                    $this->object->saveCertificate($xslfo);
                    $this->object->writeActive($form_fields["active"]);
                    ilUtil::sendSuccess($this->lng->txt("saved_successfully"), true);
                    $this->ctrl->redirect($this, "certificateEditor");
                } catch (Exception $e) {
                    ilUtil::sendFailure($e->getMessage());
                }
            }
        }
    }

References $_GET, $_POST, $certificate, $form, $format, $preview, $result, $tags, ilObjCertificateSettingsAccess\getBackgroundImageThumbPathWeb(), ilCertificate\getCustomCertificateFields(), getFormFieldsFromFO(), getFormFieldsFromPOST(), ilSubmitButton\getInstance(), ilObjCertificateSettingsAccess\hasBackgroundImage(), ilUtil\sendFailure(), ilUtil\sendSuccess(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

Referenced by certificateImport(), certificateRemoveBackground(), certificateSave(), and certificateUpload().

Here is the call graph for this function:

Here is the caller graph for this function:

certificateExportFO()

ilCertificateGUI::certificateExportFO

(

)

Exports the certificate.

Definition at line 163 of file class.ilCertificateGUI.php.

    {
        $this->object->deliverExportFileXML();
    }

certificateImport()

ilCertificateGUI::certificateImport

(

)

Import a certificate from a ZIP archive.

Definition at line 147 of file class.ilCertificateGUI.php.

    {
        $this->certificateEditor();
    }

References certificateEditor().

Here is the call graph for this function:

certificatePreview()

ilCertificateGUI::certificatePreview

(

)

Creates a certificate preview.

Definition at line 155 of file class.ilCertificateGUI.php.

    {
        $this->object->createPreview();
    }

certificateRemoveBackground()

ilCertificateGUI::certificateRemoveBackground

(

)

Removes the background image of a certificate.

Definition at line 171 of file class.ilCertificateGUI.php.

    {
        $this->object->deleteBackgroundImage();
        $this->certificateEditor();
    }

References certificateEditor().

Here is the call graph for this function:

certificateSave()

ilCertificateGUI::certificateSave

(

)

Saves the certificate.

Definition at line 205 of file class.ilCertificateGUI.php.

    {
        $this->certificateEditor();
    }

References certificateEditor().

Here is the call graph for this function:

certificateUpload()

ilCertificateGUI::certificateUpload

(

)

Uploads the certificate.

Definition at line 213 of file class.ilCertificateGUI.php.

    {
        $this->certificateEditor();
    }

References certificateEditor().

Here is the call graph for this function:

executeCommand()

ilCertificateGUI::executeCommand

(

)

execute command

Definition at line 122 of file class.ilCertificateGUI.php.

    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);
 
        $cmd = $this->getCommand($cmd);
        switch ($next_class) {
            default:
                $ret = $this->$cmd();
                break;
        }
        return $ret;
    }

References $ret, and getCommand().

Here is the call graph for this function:

getCommand()

ilCertificateGUI::getCommand

(

$cmd

)

Retrieves the ilCtrl command.

Definition at line 139 of file class.ilCertificateGUI.php.

    {
        return $cmd;
    }

Referenced by executeCommand().

Here is the caller graph for this function:

getFormFieldsFromFO()

ilCertificateGUI::getFormFieldsFromFO ( )

protected

Get the form values from the certificate xsl-fo.

Definition at line 241 of file class.ilCertificateGUI.php.

    {
        $form_fields = $this->object->getFormFieldsFromFO();
        $form_fields["active"] = $this->object->readActive();
        $this->object->getAdapter()->addFormFieldsFromObject($form_fields);
        return $form_fields;
    }

Referenced by certificateEditor().

Here is the caller graph for this function:

getFormFieldsFromPOST()

ilCertificateGUI::getFormFieldsFromPOST ( )

protected

Get the form values from an HTTP POST.

Definition at line 221 of file class.ilCertificateGUI.php.

    {
        $form_fields = array(
            "pageformat" => ilUtil::stripSlashes($_POST["pageformat"]),
            "margin_body_top" => $this->object->formatNumberString(ilUtil::stripSlashes($_POST["margin_body"]["top"])),
            "margin_body_right" => $this->object->formatNumberString(ilUtil::stripSlashes($_POST["margin_body"]["right"])),
            "margin_body_bottom" => $this->object->formatNumberString(ilUtil::stripSlashes($_POST["margin_body"]["bottom"])),
            "margin_body_left" => $this->object->formatNumberString(ilUtil::stripSlashes($_POST["margin_body"]["left"])),
            "certificate_text" => ilUtil::stripSlashes($_POST["certificate_text"], false),
            "pageheight" => $this->object->formatNumberString(ilUtil::stripSlashes($_POST["pageheight"])),
            "pagewidth" => $this->object->formatNumberString(ilUtil::stripSlashes($_POST["pagewidth"])),
            "active" => ilUtil::stripSlashes($_POST["active"])
        );
        $this->object->getAdapter()->addFormFieldsFromPOST($form_fields);
        return $form_fields;
    }

References $_POST, and ilUtil\stripSlashes().

Referenced by certificateEditor().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$acccess

ilCertificateGUI::$acccess

protected

Definition at line 86 of file class.ilCertificateGUI.php.

$ctrl

ilCertificateGUI::$ctrl

protected

Definition at line 46 of file class.ilCertificateGUI.php.

$ilias

ilCertificateGUI::$ilias

protected

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

$lng

ilCertificateGUI::$lng

protected

Definition at line 74 of file class.ilCertificateGUI.php.

$object

ilCertificateGUI::$object

protected

Definition at line 39 of file class.ilCertificateGUI.php.

$ref_id

ilCertificateGUI::$ref_id

protected

Definition at line 81 of file class.ilCertificateGUI.php.

$toolbar

ilCertificateGUI::$toolbar

protected

Definition at line 91 of file class.ilCertificateGUI.php.

$tpl

ilCertificateGUI::$tpl

protected

Definition at line 67 of file class.ilCertificateGUI.php.

$tree

ilCertificateGUI::$tree

protected

Definition at line 53 of file class.ilCertificateGUI.php.

---

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

• Services/Certificate/classes/class.ilCertificateGUI.php