class.ilTestCertificateAdapter.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "./Services/Certificate/classes/class.ilCertificateAdapter.php";

class ilTestCertificateAdapter extends ilCertificateAdapter
{
    protected $object;
    
    public function __construct($object)
    {
        $this->object = $object;
        parent::__construct();
    }

    public function getCertificatePath()
    {
        return CLIENT_WEB_DIR . "/assessment/certificates/" . $this->object->getId() . "/";
    }
    
    public function getCertificateVariablesForPreview()
    {
        $vars = $this->getBaseVariablesForPreview(false);
        $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_passed"));
        $vars["RESULT_POINTS"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_points"));
        $vars["RESULT_PERCENT"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_percent"));
        $vars["MAX_POINTS"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_max_points"));
        $vars["RESULT_MARK_SHORT"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_mark_short"));
        $vars["RESULT_MARK_LONG"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_mark_long"));
        $vars["TEST_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
        
        $insert_tags = array();
        foreach ($vars as $id => $caption) {
            $insert_tags["[" . $id . "]"] = $caption;
        }
        
        return $insert_tags;
    }

    public function getCertificateVariablesForPresentation($params = array())
    {
        $active_id = $params["active_id"];
        $pass = $params["pass"];
        $userfilter = array_key_exists("userfilter", $params) ? $params["userfilter"] : "";
        $passedonly = array_key_exists("passedonly", $params) ? $params["passedonly"] : false;
        if (strlen($pass)) {
            $result_array =&$this->object->getTestResult($active_id, $pass);
        } else {
            $result_array =&$this->object->getTestResult($active_id);
        }
        if (($passedonly) && ($result_array["test"]["passed"] == false)) {
            return "";
        }
        $passed = $result_array["test"]["passed"] ? $this->lng->txt("certificate_passed") : $this->lng->txt("certificate_failed");
        if (!$result_array["test"]["total_max_points"]) {
            $percentage = 0;
        } else {
            $percentage = ($result_array["test"]["total_reached_points"]/$result_array["test"]["total_max_points"])*100;
        }
        $mark_obj = $this->object->mark_schema->getMatchingMark($percentage);
        $user_id = $this->object->_getUserIdFromActiveId($active_id);
        include_once './Services/User/classes/class.ilObjUser.php';
        $user_data = ilObjUser::_lookupFields($user_id);
        
        if (strlen($userfilter)) {
            if (!@preg_match("/$userfilter/i", $user_data["lastname"] . ", " . $user_data["firstname"] . " " . $user_data["title"])) {
                return "";
            }
        }
        
        if (ilObjUserTracking::_enabledLearningProgress() && $user_data["usr_id"] > 0) {
            $completion_date = $this->getUserCompletionDate($user_data["usr_id"]);
        } else {
            $dt = new ilDateTime($result_array['test']['result_tstamp'], IL_CAL_UNIX);
            $completion_date = $dt->get(IL_CAL_DATETIME);
        }

        $vars = $this->getBaseVariablesForPresentation($user_data, null, $completion_date);
        $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($passed);
        $vars["RESULT_POINTS"] = ilUtil::prepareFormOutput($result_array["test"]["total_reached_points"]);
        $vars["RESULT_PERCENT"] = sprintf("%2.2f", $percentage) . "%";
        $vars["MAX_POINTS"] = ilUtil::prepareFormOutput($result_array["test"]["total_max_points"]);
        $vars["RESULT_MARK_SHORT"] = ilUtil::prepareFormOutput($mark_obj->getShortName());
        $vars["RESULT_MARK_LONG"] = ilUtil::prepareFormOutput($mark_obj->getOfficialName());
        $vars["TEST_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
        
        foreach ($vars as $id => $caption) {
            $insert_tags["[" . $id . "]"] = $caption;
        }

        return $insert_tags;
    }
    
    public function getCertificateVariablesDescription()
    {
        $vars = $this->getBaseVariablesDescription(false);
        $vars["RESULT_PASSED"] = $this->lng->txt("certificate_ph_passed");
        $vars["RESULT_POINTS"] = $this->lng->txt("certificate_ph_resultpoints");
        $vars["RESULT_PERCENT"] = $this->lng->txt("certificate_ph_resultpercent");
        $vars["MAX_POINTS"] = $this->lng->txt("certificate_ph_maxpoints");
        $vars["RESULT_MARK_SHORT"] = $this->lng->txt("certificate_ph_markshort");
        $vars["RESULT_MARK_LONG"] = $this->lng->txt("certificate_ph_marklong");
        $vars["TEST_TITLE"] = $this->lng->txt("certificate_ph_testtitle");
                
        $template = new ilTemplate("tpl.il_as_tst_certificate_edit.html", true, true, "Modules/Test");
        $template->setCurrentBlock("items");
        foreach ($vars as $id => $caption) {
            $template->setVariable("ID", $id);
            $template->setVariable("TXT", $caption);
            $template->parseCurrentBlock();
        }

        
        $template->setVariable("PH_INTRODUCTION", $this->lng->txt("certificate_ph_introduction"));

        return $template->get();
    }

    public function addAdditionalFormElements(&$form, $form_fields)
    {
        $visibility = new ilRadioGroupInputGUI($this->lng->txt("certificate_visibility"), "certificate_visibility");
        $visibility->addOption(new ilRadioOption($this->lng->txt("certificate_visibility_always"), 0));
        $visibility->addOption(new ilRadioOption($this->lng->txt("certificate_visibility_passed"), 1));
        $visibility->addOption(new ilRadioOption($this->lng->txt("certificate_visibility_never"), 2));
        $visibility->setInfo($this->lng->txt("certificate_visibility_introduction"));
        $visibility->setValue($form_fields["certificate_visibility"]);
        if (count($_POST)) {
            $visibility->checkInput();
        }
        $form->addItem($visibility);
    }
    
    public function addFormFieldsFromPOST(&$form_fields)
    {
        $form_fields["certificate_visibility"] = $_POST["certificate_visibility"];
    }

    public function addFormFieldsFromObject(&$form_fields)
    {
        $form_fields["certificate_visibility"] = $this->object->getCertificateVisibility();
    }
    
    public function saveFormFields(&$form_fields)
    {
        $this->object->saveCertificateVisibility($form_fields["certificate_visibility"]);
    }

    public function getAdapterType()
    {
        return "test";
    }

    public function getCertificateID()
    {
        return $this->object->getId();
    }
    
    public function getUserIdForParams($a_params)
    {
        return $this->object->_getUserIdFromActiveId($a_params["active_id"]);
    }
}