gradebooktable.class.php 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506
  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. 'deleted' => get_lang('DeleteSelected'),
  58. 'setvisible' => get_lang('SetVisible'),
  59. 'setinvisible' => get_lang('SetInvisible')));
  60. } else {
  61. if (empty($_GET['selectcat']) && !api_is_allowed_to_edit()) {
  62. $this->set_header($column++, get_lang('Certificates'),false);
  63. } else {
  64. //$evals_links = array_merge($evals, $links);
  65. //if (count($evals_links)>0) {
  66. //$this->set_header($column++, get_lang('Results'), false);
  67. //}
  68. }
  69. }
  70. }
  71. function get_data() {
  72. return $this->datagen;
  73. }
  74. /**
  75. * Function used by SortableTable to get total number of items in the table
  76. */
  77. function get_total_number_of_items() {
  78. return $this->datagen->get_total_items_count();
  79. }
  80. /**
  81. * Function used by SortableTable to generate the data to display
  82. */
  83. function get_table_data($from = 1) {
  84. //variables load in index.php
  85. global $my_score_in_gradebook, $certificate_min_score;
  86. $scoretotal = 0;
  87. // determine sorting type
  88. $col_adjust = (api_is_allowed_to_edit() ? 1 : 0);
  89. // By id
  90. $this->column = 5;
  91. switch ($this->column) {
  92. // Type
  93. case (0 + $col_adjust) :
  94. $sorting = GradebookDataGenerator :: GDG_SORT_TYPE;
  95. break;
  96. case (1 + $col_adjust) :
  97. $sorting = GradebookDataGenerator :: GDG_SORT_NAME;
  98. break;
  99. case (2 + $col_adjust) :
  100. $sorting = GradebookDataGenerator :: GDG_SORT_DESCRIPTION;
  101. break;
  102. case (3 + $col_adjust) :
  103. $sorting = GradebookDataGenerator :: GDG_SORT_WEIGHT;
  104. break;
  105. case (4 + $col_adjust) :
  106. $sorting = GradebookDataGenerator :: GDG_SORT_DATE;
  107. case (5 + $col_adjust) :
  108. $sorting = GradebookDataGenerator :: GDG_SORT_ID;
  109. break;
  110. }
  111. if ($this->direction == 'DESC') {
  112. $sorting |= GradebookDataGenerator :: GDG_SORT_DESC;
  113. } else {
  114. $sorting |= GradebookDataGenerator :: GDG_SORT_ASC;
  115. }
  116. //status of user in course
  117. $user_id = api_get_user_id();
  118. $course_code = api_get_course_id();
  119. $status_user = api_get_status_of_user_in_course($user_id, $course_code);
  120. $data_array = $this->datagen->get_data($sorting, $from, $this->per_page);
  121. // generate the data to display
  122. $sortable_data = array();
  123. $weight_total_links = 0;
  124. $main_categories = array();
  125. foreach ($data_array as $data) {
  126. // list of items inside the gradebook (exercises, lps, forums, etc)
  127. $row = array();
  128. $item = $data[0];
  129. $id = $item->get_id();
  130. //if the item is invisible, wrap it in a span with class invisible
  131. $invisibility_span_open = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '<span class="invisible">' : '';
  132. $invisibility_span_close = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '</span>' : '';
  133. if (api_is_allowed_to_edit(null, true)) {
  134. $row[] = $this->build_id_column($item);
  135. }
  136. $row[] = $this->build_type_column($item);
  137. //Name
  138. if (get_class($item) == 'Category') {
  139. $row[] = $invisibility_span_open.'<h3>'.$item->get_name().'</h3>'.$invisibility_span_close;
  140. $main_categories[$item->get_id()]['name'] = $item->get_name();
  141. } else {
  142. $row[] = $invisibility_span_open.$this->build_name_link($item) . $invisibility_span_close;
  143. $main_categories[$item->get_id()] = $this->build_name_link($item);
  144. }
  145. $main_categories[$item->get_id()]['weight'] = $item->get_weight();
  146. //Description
  147. $row[] = $invisibility_span_open.$data[2] . $invisibility_span_close;
  148. //Weight
  149. $row[] = $invisibility_span_open .Display::tag('h4', $data[3] .' / '.$this->currentcat->get_weight()).$invisibility_span_close;
  150. $category_weight = $item->get_weight();
  151. if (api_is_allowed_to_edit(null, true)) {
  152. $weight_total_links += $data[3];
  153. } else {
  154. $cattotal = Category :: load($_GET['selectcat']);
  155. $scoretotal = $cattotal[0]->calc_score(api_get_user_id());
  156. $item_value = $scoretotal[0];
  157. $item_value = number_format($item_value, 2, '.', ' ');
  158. }
  159. //Date
  160. //$row[] = $invisibility_span_open.$data[4].$invisibility_span_close;
  161. //Admins get an edit column
  162. if (api_is_allowed_to_edit(null, true)) {
  163. $cat = new Category();
  164. $show_message = $cat->show_message_resource_delete($item->get_course_code());
  165. if ($show_message===false) {
  166. $row[] = $this->build_edit_column($item);
  167. }
  168. } else {
  169. //students get the results and certificates columns
  170. if (count($this->evals_links)>0 && $status_user!=1 ) {
  171. $value_data = isset($data[4]) ? $data[4] : null;
  172. if (!is_null($value_data)) {
  173. $row[] = Display::tag('h4', $value_data);
  174. }
  175. }
  176. }
  177. //Category added
  178. $sortable_data[] = $row;
  179. // Loading childrens
  180. if (get_class($item) == 'Category') {
  181. $stud_id = api_get_user_id();
  182. $course_code = api_get_course_id();
  183. $session_id = api_get_session_id();
  184. $parent_id = $item->get_id();
  185. $cats = Category :: load ($parent_id, null, null, null, null, null, true);
  186. $allcat = $cats[0]->get_subcategories($stud_id, $course_code, $session_id);
  187. $alleval = $cats[0]->get_evaluations($stud_id);
  188. $alllink = $cats[0]->get_links($stud_id);
  189. $sub_cat_info = new GradebookDataGenerator($allcat, $alleval, $alllink);
  190. $data_array = $sub_cat_info->get_data($sorting, $from, $this->per_page);
  191. foreach ($data_array as $data) {
  192. $row = array();
  193. $item = $data[0];
  194. $id = $item->get_id();
  195. //if the item is invisible, wrap it in a span with class invisible
  196. $invisibility_span_open = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '<span class="invisible">' : '';
  197. $invisibility_span_close = (api_is_allowed_to_edit() && $item->is_visible() == '0') ? '</span>' : '';
  198. $main_categories[$parent_id]['children'][$item->get_id()]['name'] = $item->get_name();
  199. $main_categories[$parent_id]['children'][$item->get_id()]['weight'] = $item->get_weight();
  200. if (api_is_allowed_to_edit(null, true)) {
  201. $row[] = $this->build_id_column($item);
  202. }
  203. $row[] = $this->build_type_column($item);
  204. //Name
  205. $row[] = $invisibility_span_open."&nbsp;&nbsp;&nbsp; ".$this->build_name_link($item) . $invisibility_span_close;
  206. //Description
  207. //$row[] = $invisibility_span_open.$data[2] . $invisibility_span_close;
  208. //Weight
  209. $row[] = $invisibility_span_open . $data[3] .' / '.$category_weight.$invisibility_span_close;
  210. if (api_is_allowed_to_edit(null, true)) {
  211. //$weight_total_links += intval($data[3]);
  212. } else {
  213. $cattotal = Category :: load($_GET['selectcat']);
  214. $scoretotal = $cattotal[0]->calc_score(api_get_user_id());
  215. $item_value = $scoretotal[0];
  216. $item_value = number_format($item_value, 2, '.', ' ');
  217. }
  218. //Date
  219. //$row[] = $invisibility_span_open.$data[4].$invisibility_span_close;
  220. //Admins get an edit column
  221. if (api_is_allowed_to_edit(null, true)) {
  222. $cat = new Category();
  223. $show_message = $cat->show_message_resource_delete($item->get_course_code());
  224. if ($show_message===false) {
  225. $row[] = $this->build_edit_column($item);
  226. }
  227. } else {
  228. //students get the results and certificates columns
  229. $eval_n_links = array_merge($alleval, $alllink);
  230. if (count($eval_n_links)> 0 && $status_user!=1 ) {
  231. $value_data = isset($data[4]) ? $data[4] : null;
  232. if (!is_null($value_data)) {
  233. $row[] = $value_data;
  234. }
  235. }
  236. }
  237. $sortable_data[] = $row;
  238. }
  239. //add elements
  240. }
  241. }
  242. // warning messages
  243. $view = isset($_GET['view']) ? $_GET['view']: null;
  244. if (api_is_allowed_to_edit()) {
  245. if (isset($_GET['selectcat']) && $_GET['selectcat'] > 0 && $view <> 'presence') {
  246. $id_cat = intval($_GET['selectcat']);
  247. $category = Category :: load($id_cat);
  248. //$weight_category = intval($this->build_weight($category[0]));
  249. $weight_category = intval($this->build_weight($category[0]));
  250. $course_code = $this->build_course_code($category[0]);
  251. $weight_total_links = round($weight_total_links);
  252. //var_dump($weight_total_links);;
  253. if ($weight_total_links > $weight_category) {
  254. $warning_message = get_lang('TotalWeightMustNotBeMoreThan').'&nbsp;'.$weight_category;
  255. Display::display_warning_message($warning_message,false);
  256. }
  257. if ($weight_total_links < $weight_category ||$weight_total_links > $weight_category) {
  258. $warning_message = sprintf(get_lang('TotalWeightMustBeX'), $weight_category);
  259. Display::display_warning_message($warning_message,false);
  260. }
  261. $content_html = DocumentManager::replace_user_info_into_html(api_get_user_id(), $course_code);
  262. if (!empty($content_html)) {
  263. $new_content = explode('</head>',$content_html['content']);
  264. }
  265. if (empty($new_content[0])) {
  266. $warning_message = get_lang('ThereIsNotACertificateAvailableByDefault');
  267. Display::display_warning_message($warning_message);
  268. }
  269. }
  270. if (empty($_GET['selectcat'])) {
  271. $categories = Category :: load();
  272. $weight_categories = $certificate_min_scores = $course_codes = array();
  273. foreach ($categories as $category) {
  274. $course_code_category = $this->build_course_code($category);
  275. if (!empty($course_code)) {
  276. if ($course_code_category == $course_code) {
  277. $weight_categories[] = intval($this->build_weight($category));
  278. $certificate_min_scores[] = intval($this->build_certificate_min_score($category));
  279. $course_codes[] = $course_code;
  280. break;
  281. }
  282. } else {
  283. $weight_categories[] = intval($this->build_weight($category));
  284. $certificate_min_scores[] = intval($this->build_certificate_min_score($category));
  285. $course_codes[] = $course_code_category;
  286. }
  287. }
  288. if (is_array($weight_categories) && is_array($certificate_min_scores) && is_array($course_codes)) {
  289. $warning_message = '';
  290. for ($x = 0; $x<count($weight_categories);$x++) {
  291. $weight_category = intval($weight_categories[$x]);
  292. $certificate_min_score = intval($certificate_min_scores[$x]);
  293. $course_code = $course_codes[$x];
  294. if (empty($certificate_min_score) || ($certificate_min_score > $weight_category)) {
  295. $warning_message .= $course_code .'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
  296. }
  297. }
  298. if (!empty($warning_message)) {
  299. Display::display_warning_message($warning_message,false);
  300. }
  301. }
  302. }
  303. }
  304. //var_dump($main_categories);
  305. return $sortable_data;
  306. }
  307. // Other functions
  308. private function build_certificate_min_score ($item) {
  309. return $item->get_certificate_min_score();
  310. }
  311. private function build_weight ($item) {
  312. return $item->get_weight();
  313. }
  314. private function build_course_code ($item) {
  315. return $item->get_course_code();
  316. }
  317. private function build_id_column ($item) {
  318. switch ($item->get_item_type()) {
  319. // category
  320. case 'C' :
  321. return 'CATE' . $item->get_id();
  322. // evaluation
  323. case 'E' :
  324. return 'EVAL' . $item->get_id();
  325. // link
  326. case 'L' :
  327. return 'LINK' . $item->get_id();
  328. }
  329. }
  330. private function build_type_column ($item) {
  331. return build_type_icon_tag($item->get_icon_name());
  332. }
  333. /**
  334. *
  335. * Generate name column
  336. * @param unknown_type $item
  337. * @return string
  338. */
  339. private function build_name_link ($item) {
  340. //$session_id = api_get_session_id();
  341. switch ($item->get_item_type()) {
  342. // category
  343. case 'C' :
  344. $prms_uri='?selectcat=' . $item->get_id() . '&amp;view='.Security::remove_XSS($_GET['view']);
  345. if (isset($_GET['isStudentView'])) {
  346. if ( isset($is_student) || ( isset($_SESSION['studentview']) && $_SESSION['studentview']=='studentview') ) {
  347. $prms_uri=$prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
  348. }
  349. }
  350. $cat = new Category();
  351. $show_message=$cat->show_message_resource_delete($item->get_course_code());
  352. return '&nbsp;<a href="'.Security::remove_XSS($_SESSION['gradebook_dest']).$prms_uri.'">'
  353. . $item->get_name()
  354. . '</a>'
  355. . ($item->is_course() ? ' &nbsp;[' . $item->get_course_code() . ']'.$show_message : '');
  356. // evaluation
  357. case 'E' :
  358. $cat = new Category();
  359. $course_id = Database::get_course_by_category($_GET['selectcat']);
  360. $show_message = $cat->show_message_resource_delete($course_id);
  361. // course/platform admin can go to the view_results page
  362. if (api_is_allowed_to_edit() && $show_message===false) {
  363. if ($item->get_type() == 'presence') {
  364. return '&nbsp;'
  365. . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
  366. . $item->get_name()
  367. . '</a>';
  368. } else {
  369. return '&nbsp;'
  370. . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
  371. . $item->get_name()
  372. . '</a>&nbsp;['.get_lang('Evaluation').']';
  373. }
  374. } elseif (ScoreDisplay :: instance()->is_custom() && $show_message===false) {
  375. // students can go to the statistics page (if custom display enabled)
  376. return '&nbsp;'
  377. . '<a href="gradebook_statistics.php?selecteval=' . $item->get_id() . '">'
  378. . $item->get_name()
  379. . '</a>';
  380. } elseif ($show_message===false && !api_is_allowed_to_edit() && !(ScoreDisplay :: instance()->is_custom())) {
  381. return '&nbsp;'
  382. . '<a href="gradebook_statistics.php?selecteval=' . $item->get_id() . '">'
  383. . $item->get_name()
  384. . '</a>';
  385. } else {
  386. return '['.get_lang('Evaluation').']&nbsp;&nbsp;'.$item->get_name().$show_message;
  387. }
  388. // link
  389. case 'L' :
  390. $cat = new Category();
  391. $course_id = Database::get_course_by_category($_GET['selectcat']);
  392. $show_message = $cat->show_message_resource_delete($course_id);
  393. $url = $item->get_link();
  394. if (isset($url) && $show_message===false) {
  395. $text = '&nbsp;<a href="' . $item->get_link() . '">'
  396. . $item->get_name()
  397. . '</a>';
  398. } else {
  399. $text = $item->get_name();
  400. }
  401. $text .= '&nbsp;[' . $item->get_type_name() . ']'.$show_message;
  402. $cc = $this->currentcat->get_course_code();
  403. if (empty($cc)) {
  404. $text .= '&nbsp;[<a href="'.api_get_path(REL_COURSE_PATH).$item->get_course_code().'/">'.$item->get_course_code().'</a>]';
  405. }
  406. return $text;
  407. }
  408. }
  409. private function build_edit_column($item) {
  410. switch ($item->get_item_type()) {
  411. // category
  412. case 'C' :
  413. return build_edit_icons_cat($item, $this->currentcat->get_id());
  414. // evaluation
  415. case 'E' :
  416. return build_edit_icons_eval($item, $this->currentcat->get_id());
  417. // link
  418. case 'L' :
  419. return build_edit_icons_link($item, $this->currentcat->get_id());
  420. }
  421. }
  422. }