ILIAS  Release_4_3_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
class.ilTestCertificateAdapter.php
Go to the documentation of this file.
1 <?php
2  /*
3  +----------------------------------------------------------------------------+
4  | ILIAS open source |
5  +----------------------------------------------------------------------------+
6  | Copyright (c) 1998-2001 ILIAS open source, University of Cologne |
7  | |
8  | This program is free software; you can redistribute it and/or |
9  | modify it under the terms of the GNU General Public License |
10  | as published by the Free Software Foundation; either version 2 |
11  | of the License, or (at your option) any later version. |
12  | |
13  | This program is distributed in the hope that it will be useful, |
14  | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16  | GNU General Public License for more details. |
17  | |
18  | You should have received a copy of the GNU General Public License |
19  | along with this program; if not, write to the Free Software |
20  | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21  +----------------------------------------------------------------------------+
22 */
23 
24 include_once "./Services/Certificate/classes/class.ilCertificateAdapter.php";
25 
33 class ilTestCertificateAdapter extends ilCertificateAdapter
34 {
35  protected $object;
36 
42  function __construct(&$object)
43  {
44  global $lng;
45  $this->object =& $object;
46  $lng->loadLanguageModule('certificate');
47  }
48 
54  public function getCertificatePath()
55  {
56  return CLIENT_WEB_DIR . "/assessment/certificates/" . $this->object->getId() . "/";
57  }
58 
65  public function getCertificateVariablesForPreview()
66  {
67  global $lng;
68 
69  $vars = $this->getBaseVariablesForPreview(false);
70  $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_passed"));
71  $vars["RESULT_POINTS"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_points"));
72  $vars["RESULT_PERCENT"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_percent"));
73  $vars["MAX_POINTS"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_max_points"));
74  $vars["RESULT_MARK_SHORT"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_mark_short"));
75  $vars["RESULT_MARK_LONG"] = ilUtil::prepareFormOutput($lng->txt("certificate_var_result_mark_long"));
76  $vars["TEST_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
77 
78  $insert_tags = array();
79  foreach($vars as $id => $caption)
80  {
81  $insert_tags["[".$id."]"] = $caption;
82  }
83 
84  return $insert_tags;
85  }
86 
95  public function getCertificateVariablesForPresentation($params = array())
96  {
97  global $lng;
98 
99  $active_id = $params["active_id"];
100  $pass = $params["pass"];
101  $userfilter = array_key_exists("userfilter", $params) ? $params["userfilter"] : "";
102  $passedonly = array_key_exists("passedonly", $params) ? $params["passedonly"] : FALSE;
103  if (strlen($pass))
104  {
105  $result_array =& $this->object->getTestResult($active_id, $pass);
106  }
107  else
108  {
109  $result_array =& $this->object->getTestResult($active_id);
110  }
111  if (($passedonly) && ($result_array["test"]["passed"] == FALSE)) return "";
112  $passed = $result_array["test"]["passed"] ? $lng->txt("certificate_passed") : $lng->txt("certificate_failed");
113  if (!$result_array["test"]["total_max_points"])
114  {
115  $percentage = 0;
116  }
117  else
118  {
119  $percentage = ($result_array["test"]["total_reached_points"]/$result_array["test"]["total_max_points"])*100;
120  }
121  $mark_obj = $this->object->mark_schema->getMatchingMark($percentage);
122  $user_id = $this->object->_getUserIdFromActiveId($active_id);
123  include_once './Services/User/classes/class.ilObjUser.php';
124  $user_data = ilObjUser::_lookupFields($user_id);
125 
126  if (strlen($userfilter))
127  {
128  if (!@preg_match("/$userfilter/i", $user_data["lastname"] . ", " . $user_data["firstname"] . " " . $user_data["title"]))
129  {
130  return "";
131  }
132  }
133 
134  if($user_data["usr_id"] > 0)
135  {
136  $completion_date = $this->getUserCompletionDate($user_data["usr_id"]);
137  }
138  else
139  {
140  $completion_date = false;
141  }
142 
143  $vars = $this->getBaseVariablesForPresentation($user_data, null, $completion_date);
144  $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($passed);
145  $vars["RESULT_POINTS"] = ilUtil::prepareFormOutput($result_array["test"]["total_reached_points"]);
146  $vars["RESULT_PERCENT"] = sprintf("%2.2f", $percentage) . "%";
147  $vars["MAX_POINTS"] = ilUtil::prepareFormOutput($result_array["test"]["total_max_points"]);
148  $vars["RESULT_MARK_SHORT"] = ilUtil::prepareFormOutput($mark_obj->getShortName());
149  $vars["RESULT_MARK_LONG"] = ilUtil::prepareFormOutput($mark_obj->getOfficialName());
150  $vars["TEST_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
151 
152  foreach($vars as $id => $caption)
153  {
154  $insert_tags["[".$id."]"] = $caption;
155  }
156 
157  return $insert_tags;
158  }
159 
166  public function getCertificateVariablesDescription()
167  {
168  global $lng;
169 
170  $vars = $this->getBaseVariablesDescription(false);
171  $vars["RESULT_PASSED"] = $lng->txt("certificate_ph_passed");
172  $vars["RESULT_POINTS"] = $lng->txt("certificate_ph_resultpoints");
173  $vars["RESULT_PERCENT"] = $lng->txt("certificate_ph_resultpercent");
174  $vars["MAX_POINTS"] = $lng->txt("certificate_ph_maxpoints");
175  $vars["RESULT_MARK_SHORT"] = $lng->txt("certificate_ph_markshort");
176  $vars["RESULT_MARK_LONG"] = $lng->txt("certificate_ph_marklong");
177  $vars["TEST_TITLE"] = $lng->txt("certificate_ph_testtitle");
178 
179  $template = new ilTemplate("tpl.il_as_tst_certificate_edit.html", TRUE, TRUE, "Modules/Test");
180  $template->setCurrentBlock("items");
181  foreach($vars as $id => $caption)
182  {
183  $template->setVariable("ID", $id);
184  $template->setVariable("TXT", $caption);
185  $template->parseCurrentBlock();
186  }
187 
188 
189  $template->setVariable("PH_INTRODUCTION", $lng->txt("certificate_ph_introduction"));
190 
191  return $template->get();
192  }
193 
203  public function addAdditionalFormElements(&$form, $form_fields)
204  {
205  global $lng;
206  $visibility = new ilRadioMatrixInputGUI($lng->txt("certificate_visibility"), "certificate_visibility");
207  $options = array(
208  0 => $lng->txt("certificate_visibility_always"),
209  1 => $lng->txt("certificate_visibility_passed"),
210  2 => $lng->txt("certificate_visibility_never")
211  );
212  $visibility->setOptions($options);
213  $visibility->setInfo($lng->txt("certificate_visibility_introduction"));
214  $visibility->setValue($form_fields["certificate_visibility"]);
215  if (count($_POST)) $visibility->checkInput();
216  $form->addItem($visibility);
217  }
218 
227  public function addFormFieldsFromPOST(&$form_fields)
228  {
229  $form_fields["certificate_visibility"] = $_POST["certificate_visibility"];
230  }
231 
240  public function addFormFieldsFromObject(&$form_fields)
241  {
242  $form_fields["certificate_visibility"] = $this->object->getCertificateVisibility();
243  }
244 
252  public function saveFormFields(&$form_fields)
253  {
254  $this->object->saveCertificateVisibility($form_fields["certificate_visibility"]);
255  }
256 
263  public function getAdapterType()
264  {
265  return "test";
266  }
267 
274  public function getCertificateID()
275  {
276  return $this->object->getId();
277  }
278 
285  function getUserIdForParams($a_params)
286  {
287  return $this->object->_getUserIdFromActiveId($a_params["active_id"]);
288  }
289 
290 }
291 
292 ?>