gradebooktable.class.php 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557
  1. <?php
  2. /* For licensing terms, see license.txt */
  3. /**
  4. * Script
  5. * @package chamilo.gradebook
  6. */
  7. /**
  8. * Init
  9. */
  10. require_once dirname(__FILE__).'/../../../inc/global.inc.php';
  11. require_once dirname(__FILE__).'/../be.inc.php';
  12. /**
  13. * Table to display categories, evaluations and links
  14. * @author Stijn Konings
  15. * @author Bert Steppé (refactored, optimised)
  16. * @package chamilo.gradebook
  17. */
  18. class GradebookTable extends SortableTable {
  19. private $currentcat;
  20. private $datagen;
  21. private $evals_links;
  22. /**
  23. * Constructor
  24. */
  25. function GradebookTable ($currentcat, $cats = array(), $evals = array(), $links = array(), $addparams = null) {
  26. //$status = CourseManager::get_user_in_course_status(api_get_user_id(), api_get_course_id());
  27. parent :: __construct ('gradebooklist', null, null, (api_is_allowed_to_edit()?1:0));
  28. $this->evals_links = array_merge($evals, $links);
  29. $this->currentcat = $currentcat;
  30. $this->datagen = new GradebookDataGenerator($cats, $evals, $links);
  31. if (isset($addparams)) {
  32. $this->set_additional_parameters($addparams);
  33. }
  34. $column= 0;
  35. if (api_is_allowed_to_edit(null, true)) {
  36. $this->set_header($column++,'','','width="25px"');
  37. }
  38. $this->set_header($column++, get_lang('Type'),'','width="35px"');
  39. $this->set_header($column++, get_lang('Name'), false);
  40. $this->set_header($column++, get_lang('Description'), false);
  41. if (api_is_allowed_to_edit(null, true)) {
  42. $this->set_header($column++, get_lang('Weight'),'','width="80px"');
  43. } else {
  44. $this->set_header($column++, get_lang('Weight'), false);
  45. $this->set_header($column++, get_lang('Result'), false);
  46. }
  47. /*if (api_is_allowed_to_edit(null, true)) {
  48. //$this->set_header($column++, get_lang('CreationDate'),true, 'width="100px"');
  49. } elseif (($status<>1) && !api_is_allowed_to_edit() && (!isset($_GET['selectcat']) || $_GET['selectcat']==0)) {
  50. //$this->set_header($column++, get_lang('Date'),true, 'width="100px"');
  51. }*/
  52. //admins get an edit column
  53. if (api_is_allowed_to_edit(null, true)) {
  54. $this->set_header($column++, get_lang('Modify'), false, 'width="120px"');
  55. //actions on multiple selected documents
  56. $this->set_form_actions(array (
  57. 'setvisible' => get_lang('SetVisible'),
  58. 'setinvisible' => get_lang('SetInvisible'),
  59. 'deleted' => get_lang('DeleteSelected')
  60. ));
  61. } else {
  62. if (empty($_GET['selectcat']) && !api_is_allowed_to_edit()) {
  63. $this->set_header($column++, get_lang('Certificates'),false);
  64. } else {
  65. //$evals_links = array_merge($evals, $links);
  66. //if (count($evals_links)>0) {
  67. //$this->set_header($column++, get_lang('Results'), false);
  68. //}
  69. }
  70. }
  71. }
  72. function get_data() {
  73. return $this->datagen;
  74. }
  75. /**
  76. * Function used by SortableTable to get total number of items in the table
  77. */
  78. function get_total_number_of_items() {
  79. return $this->datagen->get_total_items_count();
  80. }
  81. /**
  82. * Function used by SortableTable to generate the data to display
  83. */
  84. function get_table_data($from = 1) {
  85. //variables load in index.php
  86. global $my_score_in_gradebook, $certificate_min_score;
  87. $scoretotal = 0;
  88. // determine sorting type
  89. $col_adjust = (api_is_allowed_to_edit() ? 1 : 0);
  90. // By id
  91. $this->column = 5;
  92. switch ($this->column) {
  93. // Type
  94. case (0 + $col_adjust) :
  95. $sorting = GradebookDataGenerator :: GDG_SORT_TYPE;
  96. break;
  97. case (1 + $col_adjust) :
  98. $sorting = GradebookDataGenerator :: GDG_SORT_NAME;
  99. break;
  100. case (2 + $col_adjust) :
  101. $sorting = GradebookDataGenerator :: GDG_SORT_DESCRIPTION;
  102. break;
  103. case (3 + $col_adjust) :
  104. $sorting = GradebookDataGenerator :: GDG_SORT_WEIGHT;
  105. break;
  106. case (4 + $col_adjust) :
  107. $sorting = GradebookDataGenerator :: GDG_SORT_DATE;
  108. case (5 + $col_adjust) :
  109. $sorting = GradebookDataGenerator :: GDG_SORT_ID;
  110. break;
  111. }
  112. if ($this->direction == 'DESC') {
  113. $sorting |= GradebookDataGenerator :: GDG_SORT_DESC;
  114. } else {
  115. $sorting |= GradebookDataGenerator :: GDG_SORT_ASC;
  116. }
  117. //status of user in course
  118. $user_id = api_get_user_id();
  119. $course_code = api_get_course_id();
  120. $session_id = api_get_session_id();
  121. $status_user = api_get_status_of_user_in_course($user_id, $course_code);
  122. $data_array = $this->datagen->get_data($sorting, $from, $this->per_page);
  123. // generate the data to display
  124. $sortable_data = array();
  125. $weight_total_links = 0;
  126. $main_categories = array();
  127. $main_cat = Category :: load(null, null, $course_code, null, null, $session_id, false);
  128. $total_categories_weight = 0;
  129. //Looping categories
  130. foreach ($data_array as $data) {
  131. // list of items inside the gradebook (exercises, lps, forums, etc)
  132. $row = array();
  133. $item = $data[0];
  134. $id = $item->get_id();
  135. //if the item is invisible, wrap it in a span with class invisible
  136. $invisibility_span_open = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '<span class="invisible">' : '';
  137. $invisibility_span_close = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '</span>' : '';
  138. if (api_is_allowed_to_edit(null, true)) {
  139. //id
  140. $row[] = $this->build_id_column($item);
  141. }
  142. //Type
  143. $row[] = $this->build_type_column($item);
  144. //Name
  145. if (get_class($item) == 'Category') {
  146. $row[] = $invisibility_span_open.'<h3>'.$item->get_name().'</h3>'.$invisibility_span_close;
  147. $main_categories[$item->get_id()]['name'] = $item->get_name();
  148. } else {
  149. $row[] = $invisibility_span_open.$this->build_name_link($item) . $invisibility_span_close;
  150. $main_categories[$item->get_id()] = $this->build_name_link($item);
  151. }
  152. $main_categories[$item->get_id()]['weight'] = $item->get_weight();
  153. $total_categories_weight += $item->get_weight();
  154. //Description
  155. $row[] = $invisibility_span_open.$data[2].$invisibility_span_close;
  156. //Weight
  157. //$row[] = $invisibility_span_open .Display::tag('h4', $data['3'] .' / '.$this->currentcat->get_weight()).$invisibility_span_close;
  158. //$average = $data['3']/$this->currentcat->get_weight()*100;
  159. $scoredisplay = ScoreDisplay :: instance();
  160. $average = $scoredisplay->display_score(array($data['3'], $this->currentcat->get_weight()), SCORE_PERCENT, SCORE_BOTH, true);
  161. $row[] = $invisibility_span_open .Display::tag('h4', $average).$invisibility_span_close;
  162. $category_weight = $item->get_weight();
  163. if (api_is_allowed_to_edit(null, true)) {
  164. $weight_total_links += $data[3];
  165. } else {
  166. $cattotal = Category :: load($_GET['selectcat']);
  167. $scoretotal = $cattotal[0]->calc_score(api_get_user_id());
  168. $item_value = $scoretotal[0];
  169. $item_value = number_format($item_value, api_get_setting('gradebook_number_decimals'), '.', ' ');
  170. }
  171. //Date
  172. //$row[] = $invisibility_span_open.$data[4].$invisibility_span_close;
  173. //Edit (for admins)
  174. if (api_is_allowed_to_edit(null, true)) {
  175. $cat = new Category();
  176. $show_message = $cat->show_message_resource_delete($item->get_course_code());
  177. if ($show_message === false) {
  178. $row[] = $this->build_edit_column($item);
  179. }
  180. } else {
  181. //students get the results and certificates columns
  182. if (count($this->evals_links) > 0 && $status_user != 1) {
  183. $value_data = isset($data[4]) ? $data[4] : null;
  184. if (!is_null($value_data)) {
  185. $row[] = Display::tag('h4', $value_data);
  186. } else {
  187. $row[] = $this->build_edit_column($item);
  188. }
  189. } else {
  190. $row[] = $this->build_edit_column($item);
  191. }
  192. }
  193. //Category added
  194. $sortable_data[] = $row;
  195. // Loading childrens
  196. if (get_class($item) == 'Category') {
  197. $stud_id = api_get_user_id();
  198. $course_code = api_get_course_id();
  199. $session_id = api_get_session_id();
  200. $parent_id = $item->get_id();
  201. $cats = Category :: load ($parent_id, null, null, null, null, null, true);
  202. $allcat = $cats[0]->get_subcategories($stud_id, $course_code, $session_id);
  203. $alleval = $cats[0]->get_evaluations($stud_id);
  204. $alllink = $cats[0]->get_links($stud_id);
  205. $sub_cat_info = new GradebookDataGenerator($allcat, $alleval, $alllink);
  206. $data_array = $sub_cat_info->get_data($sorting, $from, $this->per_page);
  207. $total_weight = 0;
  208. foreach ($data_array as $data) {
  209. $row = array();
  210. $item = $data[0];
  211. $id = $item->get_id();
  212. //if the item is invisible, wrap it in a span with class invisible
  213. $invisibility_span_open = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '<span class="invisible">' : '';
  214. $invisibility_span_close = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '</span>' : '';
  215. $main_categories[$parent_id]['children'][$item->get_id()]['name'] = $item->get_name();
  216. $main_categories[$parent_id]['children'][$item->get_id()]['weight'] = $item->get_weight();
  217. if (api_is_allowed_to_edit(null, true)) {
  218. $row[] = $this->build_id_column($item);
  219. }
  220. $row[] = $this->build_type_column($item);
  221. //Name
  222. $row[] = $invisibility_span_open."&nbsp;&nbsp;&nbsp; ".$this->build_name_link($item) . $invisibility_span_close;
  223. //Description
  224. $row[] = $invisibility_span_open.$data[2] . $invisibility_span_close;
  225. //Weight
  226. //$row[] = $invisibility_span_open . $data[3] .' / '.$category_weight.$invisibility_span_close;
  227. $weight = $data[3]/$category_weight*$main_cat[0]->get_weight();
  228. $total_weight += $weight;
  229. $row[] = $invisibility_span_open.$weight.$invisibility_span_close;
  230. if (api_is_allowed_to_edit(null, true)) {
  231. //$weight_total_links += intval($data[3]);
  232. } else {
  233. $cattotal = Category :: load($_GET['selectcat']);
  234. $scoretotal = $cattotal[0]->calc_score(api_get_user_id());
  235. $item_value = $scoretotal[0];
  236. $item_value = number_format($item_value, 2, '.', ' ');
  237. }
  238. //Date
  239. //$row[] = $invisibility_span_open.$data[4].$invisibility_span_close;
  240. //Admins get an edit column
  241. if (api_is_allowed_to_edit(null, true)) {
  242. $cat = new Category();
  243. $show_message = $cat->show_message_resource_delete($item->get_course_code());
  244. if ($show_message===false) {
  245. $row[] = $this->build_edit_column($item);
  246. }
  247. } else {
  248. //students get the results and certificates columns
  249. $eval_n_links = array_merge($alleval, $alllink);
  250. if (count($eval_n_links)> 0 && $status_user!=1 ) {
  251. $value_data = isset($data[4]) ? $data[4] : null;
  252. if (!is_null($value_data)) {
  253. $row[] = $value_data;
  254. }
  255. }
  256. }
  257. $row['child_of'] = $parent_id;
  258. $sortable_data[] = $row;
  259. }
  260. //"Warning row"
  261. if (!empty($data_array)) {
  262. if (api_is_allowed_to_edit()) {
  263. $main_weight = intval($main_cat[0]->get_weight());
  264. if (intval($total_weight) == $main_weight) {
  265. //$label = Display::return_icon('accept.png', get_lang('Ok'));
  266. $label = null;
  267. $total = Display::badge($total_weight.' / '.$main_weight, 'success');
  268. } else {
  269. $label = Display::return_icon('warning.png', sprintf(get_lang('TotalWeightMustBeX'), $main_weight) );
  270. $total = Display::badge($total_weight.' / '.$main_weight, 'warning');
  271. }
  272. $row = array(null, null, "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<h5>".get_lang('SubTotal').'</h5>',null, $total.' '.$label, 'child_of' =>$parent_id);
  273. $sortable_data[] = $row;
  274. }
  275. }
  276. }
  277. } //end looping categories
  278. if (api_is_allowed_to_edit()) {
  279. if (count($main_cat) > 1) {
  280. $main_weight = intval($main_cat[0]->get_weight());
  281. if (intval($total_categories_weight) == $main_weight) {
  282. $total = Display::badge($total_categories_weight.' / '.$main_weight, 'success');
  283. } else {
  284. $total = Display::badge($total_categories_weight.' / '.$main_weight, 'warning');
  285. }
  286. $row = array(null, null, '<h3>'.get_lang('Total').'</h3>', null, $total);
  287. $sortable_data[] = $row;
  288. }
  289. }
  290. // warning messages
  291. $view = isset($_GET['view']) ? $_GET['view']: null;
  292. if (api_is_allowed_to_edit()) {
  293. if (isset($_GET['selectcat']) && $_GET['selectcat'] > 0 && $view <> 'presence') {
  294. $id_cat = intval($_GET['selectcat']);
  295. $category = Category :: load($id_cat);
  296. //$weight_category = intval($this->build_weight($category[0]));
  297. $weight_category = intval($this->build_weight($category[0]));
  298. $course_code = $this->build_course_code($category[0]);
  299. $weight_total_links = round($weight_total_links);
  300. if ($weight_total_links > $weight_category) {
  301. $warning_message = get_lang('TotalWeightMustNotBeMoreThan').'&nbsp;'.$weight_category;
  302. Display::display_warning_message($warning_message,false);
  303. }
  304. if ($weight_total_links < $weight_category ||$weight_total_links > $weight_category) {
  305. $warning_message = sprintf(get_lang('TotalWeightMustBeX'), $weight_category);
  306. Display::display_warning_message($warning_message,false);
  307. }
  308. $content_html = DocumentManager::replace_user_info_into_html(api_get_user_id(), $course_code);
  309. if (!empty($content_html)) {
  310. $new_content = explode('</head>',$content_html['content']);
  311. }
  312. if (empty($new_content[0])) {
  313. $warning_message = get_lang('ThereIsNotACertificateAvailableByDefault');
  314. Display::display_warning_message($warning_message);
  315. }
  316. }
  317. if (empty($_GET['selectcat'])) {
  318. $categories = Category :: load();
  319. $weight_categories = $certificate_min_scores = $course_codes = array();
  320. foreach ($categories as $category) {
  321. $course_code_category = $this->build_course_code($category);
  322. if (!empty($course_code)) {
  323. if ($course_code_category == $course_code) {
  324. $weight_categories[] = intval($this->build_weight($category));
  325. $certificate_min_scores[] = intval($this->build_certificate_min_score($category));
  326. $course_codes[] = $course_code;
  327. break;
  328. }
  329. } else {
  330. $weight_categories[] = intval($this->build_weight($category));
  331. $certificate_min_scores[] = intval($this->build_certificate_min_score($category));
  332. $course_codes[] = $course_code_category;
  333. }
  334. }
  335. if (is_array($weight_categories) && is_array($certificate_min_scores) && is_array($course_codes)) {
  336. $warning_message = '';
  337. for ($x = 0; $x<count($weight_categories);$x++) {
  338. $weight_category = intval($weight_categories[$x]);
  339. $certificate_min_score = intval($certificate_min_scores[$x]);
  340. $course_code = $course_codes[$x];
  341. if (empty($certificate_min_score) || ($certificate_min_score > $weight_category)) {
  342. $warning_message .= $course_code .'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
  343. }
  344. }
  345. if (!empty($warning_message)) {
  346. Display::display_warning_message($warning_message,false);
  347. }
  348. }
  349. }
  350. }
  351. return $sortable_data;
  352. }
  353. // Other functions
  354. private function build_certificate_min_score ($item) {
  355. return $item->get_certificate_min_score();
  356. }
  357. private function build_weight ($item) {
  358. return $item->get_weight();
  359. }
  360. private function build_course_code ($item) {
  361. return $item->get_course_code();
  362. }
  363. private function build_id_column ($item) {
  364. switch ($item->get_item_type()) {
  365. // category
  366. case 'C' :
  367. return 'CATE' . $item->get_id();
  368. // evaluation
  369. case 'E' :
  370. return 'EVAL' . $item->get_id();
  371. // link
  372. case 'L' :
  373. return 'LINK' . $item->get_id();
  374. }
  375. }
  376. private function build_type_column ($item) {
  377. return build_type_icon_tag($item->get_icon_name());
  378. }
  379. /**
  380. *
  381. * Generate name column
  382. * @param unknown_type $item
  383. * @return string
  384. */
  385. private function build_name_link ($item) {
  386. //$session_id = api_get_session_id();
  387. switch ($item->get_item_type()) {
  388. // category
  389. case 'C' :
  390. $prms_uri='?selectcat=' . $item->get_id() . '&amp;view='.Security::remove_XSS($_GET['view']);
  391. if (isset($_GET['isStudentView'])) {
  392. if ( isset($is_student) || ( isset($_SESSION['studentview']) && $_SESSION['studentview']=='studentview') ) {
  393. $prms_uri=$prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
  394. }
  395. }
  396. $cat = new Category();
  397. $show_message=$cat->show_message_resource_delete($item->get_course_code());
  398. return '&nbsp;<a href="'.Security::remove_XSS($_SESSION['gradebook_dest']).$prms_uri.'">'
  399. . $item->get_name()
  400. . '</a>'
  401. . ($item->is_course() ? ' &nbsp;[' . $item->get_course_code() . ']'.$show_message : '');
  402. // evaluation
  403. case 'E' :
  404. $cat = new Category();
  405. $course_id = Database::get_course_by_category($_GET['selectcat']);
  406. $show_message = $cat->show_message_resource_delete($course_id);
  407. // course/platform admin can go to the view_results page
  408. if (api_is_allowed_to_edit() && $show_message===false) {
  409. if ($item->get_type() == 'presence') {
  410. return '&nbsp;'
  411. . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
  412. . $item->get_name()
  413. . '</a>';
  414. } else {
  415. return '&nbsp;'
  416. . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
  417. . $item->get_name()
  418. . '</a>&nbsp;['.get_lang('Evaluation').']';
  419. }
  420. } elseif (ScoreDisplay :: instance()->is_custom() && $show_message===false) {
  421. // students can go to the statistics page (if custom display enabled)
  422. return '&nbsp;'
  423. . '<a href="gradebook_statistics.php?selecteval=' . $item->get_id() . '">'
  424. . $item->get_name()
  425. . '</a>';
  426. } elseif ($show_message===false && !api_is_allowed_to_edit() && !(ScoreDisplay :: instance()->is_custom())) {
  427. return '&nbsp;'
  428. . '<a href="gradebook_statistics.php?selecteval=' . $item->get_id() . '">'
  429. . $item->get_name()
  430. . '</a>';
  431. } else {
  432. return '['.get_lang('Evaluation').']&nbsp;&nbsp;'.$item->get_name().$show_message;
  433. }
  434. // link
  435. case 'L' :
  436. $cat = new Category();
  437. $course_id = Database::get_course_by_category($_GET['selectcat']);
  438. $show_message = $cat->show_message_resource_delete($course_id);
  439. $url = $item->get_link();
  440. if (isset($url) && $show_message===false) {
  441. $text = '&nbsp;<a href="' . $item->get_link() . '">'
  442. . $item->get_name()
  443. . '</a>';
  444. } else {
  445. $text = $item->get_name();
  446. }
  447. $text .= '&nbsp;[' . $item->get_type_name() . ']'.$show_message;
  448. $cc = $this->currentcat->get_course_code();
  449. if (empty($cc)) {
  450. $text .= '&nbsp;[<a href="'.api_get_path(REL_COURSE_PATH).$item->get_course_code().'/">'.$item->get_course_code().'</a>]';
  451. }
  452. return $text;
  453. }
  454. }
  455. private function build_edit_column($item) {
  456. switch ($item->get_item_type()) {
  457. // category
  458. case 'C' :
  459. return build_edit_icons_cat($item, $this->currentcat);
  460. // evaluation
  461. case 'E' :
  462. return build_edit_icons_eval($item, $this->currentcat->get_id());
  463. // link
  464. case 'L' :
  465. return build_edit_icons_link($item, $this->currentcat->get_id());
  466. }
  467. }
  468. }