class.ilTestCertificateAdapter.php

Go to the documentation of this file.

<?php
 /*
   +----------------------------------------------------------------------------+
   | ILIAS open source                                                          |
   +----------------------------------------------------------------------------+
   | Copyright (c) 1998-2001 ILIAS open source, University of Cologne           |
   |                                                                            |
   | This program is free software; you can redistribute it and/or              |
   | modify it under the terms of the GNU General Public License                |
   | as published by the Free Software Foundation; either version 2             |
   | of the License, or (at your option) any later version.                     |
   |                                                                            |
   | This program is distributed in the hope that it will be useful,            |
   | but WITHOUT ANY WARRANTY; without even the implied warranty of             |
   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              |
   | GNU General Public License for more details.                               |
   |                                                                            |
   | You should have received a copy of the GNU General Public License          |
   | along with this program; if not, write to the Free Software                |
   | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
   +----------------------------------------------------------------------------+
*/

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

class ilTestCertificateAdapter extends ilCertificateAdapter
{
        protected $object;
        
        function __construct(&$object)
        {
                global $lng;
                $this->object =& $object;
                $lng->loadLanguageModule('certificate');
        }

        public function getCertificatePath()
        {
                return CLIENT_WEB_DIR . "/assessment/certificates/" . $this->object->getId() . "/";
        }
        
        public function getCertificateVariablesForPreview()
        {
                global $lng;
                
                $vars = $this->getBaseVariablesForPreview(false);
                $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_passed"));
                $vars["RESULT_POINTS"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_points"));
                $vars["RESULT_PERCENT"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_percent"));
                $vars["MAX_POINTS"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_max_points"));
                $vars["RESULT_MARK_SHORT"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_mark_short"));
                $vars["RESULT_MARK_LONG"] = ilUtil::prepareFormOutput($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())
        {
                global $lng;
                
                $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"] ? $lng->txt("certificate_passed") : $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 "";
                        }
                }
                
                $completion_date = $this->getUserCompletionDate($user_data["usr_id"]);          
                
                $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()
        {
                global $lng;
                
                $vars = $this->getBaseVariablesDescription(false);
                $vars["RESULT_PASSED"] = $lng->txt("certificate_ph_passed");
                $vars["RESULT_POINTS"] = $lng->txt("certificate_ph_resultpoints");
                $vars["RESULT_PERCENT"] = $lng->txt("certificate_ph_resultpercent");            
                $vars["MAX_POINTS"] = $lng->txt("certificate_ph_maxpoints");
                $vars["RESULT_MARK_SHORT"] = $lng->txt("certificate_ph_markshort");
                $vars["RESULT_MARK_LONG"] = $lng->txt("certificate_ph_marklong");
                $vars["TEST_TITLE"] = $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", $lng->txt("certificate_ph_introduction"));

                return $template->get();
        }

        public function addAdditionalFormElements(&$form, $form_fields)
        {
                global $lng;
                $visibility = new ilRadioMatrixInputGUI($lng->txt("certificate_visibility"), "certificate_visibility");
                $options = array(
                        0 => $lng->txt("certificate_visibility_always"),
                        1 => $lng->txt("certificate_visibility_passed"),
                        2 => $lng->txt("certificate_visibility_never")
                );
                $visibility->setOptions($options);
                $visibility->setInfo($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();
        }
}

?>