/**
* Function used by SortableTable to generate the data to display
* @param int $from
* @param int $per_page
* @param int $column
* @param string $direction
* @param int $sort
* @return array|mixed
*/
public function get_table_data($from = 1, $per_page = null, $column = null, $direction = null, $sort = null)
{
//variables load in index.php
global $certificate_min_score;
// determine sorting type
$col_adjust = api_is_allowed_to_edit() ? 1 : 0;
// By id
$this->column = 5;
switch ($this->column) {
// Type
case 0 + $col_adjust:
$sorting = GradebookDataGenerator::GDG_SORT_TYPE;
break;
case 1 + $col_adjust:
$sorting = GradebookDataGenerator::GDG_SORT_NAME;
break;
case 2 + $col_adjust:
$sorting = GradebookDataGenerator::GDG_SORT_DESCRIPTION;
break;
case 3 + $col_adjust:
$sorting = GradebookDataGenerator::GDG_SORT_WEIGHT;
break;
case 4 + $col_adjust:
$sorting = GradebookDataGenerator::GDG_SORT_DATE;
case 5 + $col_adjust:
$sorting = GradebookDataGenerator::GDG_SORT_ID;
break;
}
if ($this->direction == 'DESC') {
$sorting |= GradebookDataGenerator::GDG_SORT_DESC;
} else {
$sorting |= GradebookDataGenerator::GDG_SORT_ASC;
}
// Status of user in course.
$user_id = $this->userId;
$course_code = api_get_course_id();
$session_id = api_get_session_id();
$status_user = api_get_status_of_user_in_course(api_get_user_id(), api_get_course_int_id());
if (empty($session_id)) {
$statusToFilter = STUDENT;
} else {
$statusToFilter = 0;
}
if (empty($this->studentList)) {
$studentList = CourseManager::get_user_list_from_course_code($course_code, $session_id, null, null, $statusToFilter);
$this->studentList = $studentList;
}
$this->datagen->userId = $this->userId;
$data_array = $this->datagen->get_data($sorting, $from, $this->per_page, false, $this->studentList);
// generate the data to display
$sortable_data = array();
$weight_total_links = 0;
$main_categories = array();
$main_cat = Category::load(null, null, $course_code, null, null, $session_id, 'ORDER BY id');
$total_categories_weight = 0;
$scoredisplay = ScoreDisplay::instance();
$totalResult = [0, 0];
$totalBest = [0, 0];
$totalAverage = [0, 0];
$type = 'detail';
if ($this->exportToPdf) {
$type = 'simple';
}
// Categories.
if (!empty($data_array)) {
foreach ($data_array as $data) {
// list of items inside the gradebook (exercises, lps, forums, etc)
$row = array();
/** @var AbstractLink $item */
$item = $mainCategory = $data[0];
//if the item is invisible, wrap it in a span with class invisible
$invisibility_span_open = api_is_allowed_to_edit() && $item->is_visible() == '0' ? '<span class="invisible">' : '';
$invisibility_span_close = api_is_allowed_to_edit() && $item->is_visible() == '0' ? '</span>' : '';
// Id
if ($this->teacherView) {
if ($this->exportToPdf == false) {
$row[] = $this->build_id_column($item);
}
}
// Type.
$row[] = $this->build_type_column($item);
// Name.
if (get_class($item) == 'Category') {
$row[] = $invisibility_span_open . '<strong>' . $item->get_name() . '</strong>' . $invisibility_span_close;
$main_categories[$item->get_id()]['name'] = $item->get_name();
} else {
$name = $this->build_name_link($item, $type);
$row[] = $invisibility_span_open . $name . $invisibility_span_close;
$main_categories[$item->get_id()]['name'] = $name;
}
$this->dataForGraph['categories'][] = $item->get_name();
$main_categories[$item->get_id()]['weight'] = $item->get_weight();
$total_categories_weight += $item->get_weight();
// Description.
if ($this->exportToPdf == false) {
$row[] = $invisibility_span_open . $data[2] . $invisibility_span_close;
}
// Weight.
$weight = $scoredisplay->display_score(array($data['3'], $this->currentcat->get_weight()), SCORE_SIMPLE, SCORE_BOTH, true);
if ($this->teacherView) {
$row[] = $invisibility_span_open . Display::tag('p', $weight, array('class' => 'score')) . $invisibility_span_close;
} else {
$row[] = $invisibility_span_open . $weight . $invisibility_span_close;
}
$category_weight = $item->get_weight();
$mainCategoryWeight = $main_cat[0]->get_weight();
if ($this->teacherView) {
$weight_total_links += $data[3];
} else {
$cattotal = Category::load($_GET['selectcat']);
$scoretotal = $cattotal[0]->calc_score($this->userId);
$item_value = $scoredisplay->display_score($scoretotal, SCORE_SIMPLE);
}
// Edit (for admins).
if ($this->teacherView) {
$cat = new Category();
$show_message = $cat->show_message_resource_delete($item->get_course_code());
if ($show_message === false) {
$row[] = $this->build_edit_column($item);
}
} else {
$score = $item->calc_score($this->userId);
if (!empty($score[1])) {
$completeScore = $scoredisplay->display_score($score, SCORE_DIV_PERCENT);
$score = $score[0] / $score[1] * $item->get_weight();
$score = $scoredisplay->display_score(array($score, null), SCORE_SIMPLE);
$scoreToDisplay = Display::tip($score, $completeScore);
} else {
$scoreToDisplay = '-';
$categoryScore = null;
}
// Students get the results and certificates columns
//if (count($this->evals_links) > 0 && $status_user != 1) {
if (1) {
$value_data = isset($data[4]) ? $data[4] : null;
$best = isset($data['best']) ? $data['best'] : null;
$average = isset($data['average']) ? $data['average'] : null;
$ranking = isset($data['ranking']) ? $data['ranking'] : null;
$totalResult = [$totalResult[0] + $data['result_score_weight'][0], $totalResult[1] + $data['result_score_weight'][1]];
$totalBest = [$totalBest[0] + $data['best_score'][0], $totalBest[1] + $data['best_score'][1]];
$totalAverage = [$totalAverage[0] + $data['average_score'][0], $totalAverage[1] + $data['average_score'][1]];
// Student result
$row[] = $value_data;
$totalResultAverageValue = strip_tags($scoredisplay->display_score($totalResult, SCORE_AVERAGE));
$this->dataForGraph['my_result'][] = (double) str_replace('%', '', $totalResultAverageValue);
$totalAverageValue = strip_tags($scoredisplay->display_score($totalAverage, SCORE_AVERAGE));
$this->dataForGraph['average'][] = (double) str_replace('%', '', $totalAverageValue);
// Ranking
$row[] = $ranking;
// Best
$row[] = $best;
// Average
$row[] = $average;
if (get_class($item) == 'Category') {
if ($this->exportToPdf == false) {
$row[] = $this->build_edit_column($item);
}
}
} else {
$row[] = $scoreToDisplay;
if (!empty($this->cats)) {
if ($this->exportToPdf == false) {
$row[] = $this->build_edit_column($item);
}
}
}
}
// Category added.
$sortable_data[] = $row;
// Loading children
if (get_class($item) == 'Category') {
$course_code = api_get_course_id();
$session_id = api_get_session_id();
$parent_id = $item->get_id();
$cats = Category::load($parent_id, null, null, null, null, null);
if (isset($cats[0])) {
$allcat = $cats[0]->get_subcategories($this->userId, $course_code, $session_id);
$alleval = $cats[0]->get_evaluations($this->userId);
$alllink = $cats[0]->get_links($this->userId);
$sub_cat_info = new GradebookDataGenerator($allcat, $alleval, $alllink);
$sub_cat_info->userId = $user_id;
$data_array2 = $sub_cat_info->get_data($sorting, $from, $this->per_page, false, $this->studentList);
$total_weight = 0;
// Links.
foreach ($data_array2 as $data) {
$row = array();
$item = $data[0];
//if the item is invisible, wrap it in a span with class invisible
$invisibility_span_open = api_is_allowed_to_edit() && $item->is_visible() == '0' ? '<span class="invisible">' : '';
$invisibility_span_close = api_is_allowed_to_edit() && $item->is_visible() == '0' ? '</span>' : '';
if (isset($item)) {
$main_categories[$parent_id]['children'][$item->get_id()]['name'] = $item->get_name();
$main_categories[$parent_id]['children'][$item->get_id()]['weight'] = $item->get_weight();
}
if ($this->teacherView) {
if ($this->exportToPdf == false) {
$row[] = $this->build_id_column($item);
}
}
// Type
$row[] = $this->build_type_column($item, array('style' => 'padding-left:5px'));
// Name.
$row[] = $invisibility_span_open . " " . $this->build_name_link($item, $type) . $invisibility_span_close;
// Description.
if ($this->exportToPdf == false) {
$row[] = $invisibility_span_open . $data[2] . $invisibility_span_close;
}
$weight = $data[3];
$total_weight += $weight;
// Weight
$row[] = $invisibility_span_open . $weight . $invisibility_span_close;
if ($this->teacherView) {
//$weight_total_links += intval($data[3]);
} else {
$cattotal = Category::load($_GET['selectcat']);
$scoretotal = $cattotal[0]->calc_score($this->userId);
$item_value = $scoretotal[0];
}
// Admins get an edit column.
if (api_is_allowed_to_edit(null, true) && isset($_GET['user_id']) == false && (isset($_GET['action']) && $_GET['action'] != 'export_all' || !isset($_GET['action']))) {
$cat = new Category();
$show_message = $cat->show_message_resource_delete($item->get_course_code());
if ($show_message === false) {
if ($this->exportToPdf == false) {
$row[] = $this->build_edit_column($item);
}
}
} else {
// Students get the results and certificates columns
$eval_n_links = array_merge($alleval, $alllink);
if (count($eval_n_links) > 0) {
$value_data = isset($data[4]) ? $data[4] : null;
if (!is_null($value_data)) {
//$score = $item->calc_score(api_get_user_id());
//$new_score = $data[3] * $score[0] / $score[1];
//$new_score = floatval(number_format($new_score, api_get_setting('gradebook_number_decimals')));
// Result
$row[] = $value_data;
$best = isset($data['best']) ? $data['best'] : null;
$average = isset($data['average']) ? $data['average'] : null;
$ranking = isset($data['ranking']) ? $data['ranking'] : null;
// Ranking
$row[] = $ranking;
// Best
$row[] = $best;
// Average
$row[] = $average;
}
}
if (!empty($cats)) {
if ($this->exportToPdf == false) {
$row[] = null;
}
}
}
if ($this->exportToPdf == false) {
$row['child_of'] = $parent_id;
}
$sortable_data[] = $row;
}
// "Warning row"
if (!empty($data_array)) {
if ($this->teacherView) {
// Compare the category weight to the sum of all weights inside the category
if (intval($total_weight) == $category_weight) {
$label = null;
$total = GradebookUtils::score_badges(array($total_weight . ' / ' . $category_weight, '100'));
} else {
$label = Display::return_icon('warning.png', sprintf(get_lang('TotalWeightMustBeX'), $category_weight));
$total = Display::badge($total_weight . ' / ' . $category_weight, 'warning');
}
$row = array(null, null, " <h5>" . get_lang('SubTotal') . '</h5>', null, $total . ' ' . $label, 'child_of' => $parent_id);
$sortable_data[] = $row;
}
}
}
}
}
}
//end looping categories
$main_weight = 0;
if (count($main_cat) > 1) {
/** @var Category $myCat */
foreach ($main_cat as $myCat) {
$myParentId = $myCat->get_parent_id();
if ($myParentId == 0) {
$main_weight = intval($myCat->get_weight());
}
}
}
if ($this->teacherView) {
// Total for teacher.
if (count($main_cat) > 1) {
if (intval($total_categories_weight) == $main_weight) {
$total = GradebookUtils::score_badges(array($total_categories_weight . ' / ' . $main_weight, '100'));
} else {
$total = Display::badge($total_categories_weight . ' / ' . $main_weight, 'warning');
}
$row = array(null, null, '<strong>' . get_lang('Total') . '</strong>', null, $total);
$sortable_data[] = $row;
}
} else {
// Total for student.
if (count($main_cat) > 1) {
$main_weight = intval($main_cat[0]->get_weight());
$global = null;
$average = null;
// Overwrite main weight
$totalResult[1] = $main_weight;
$totalResult = $scoredisplay->display_score($totalResult, SCORE_DIV);
$totalRanking = array();
$invalidateRanking = true;
$average = 0;
foreach ($this->studentList as $student) {
$score = $main_cat[0]->calc_score($student['user_id']);
if (!empty($score[0])) {
$invalidateRanking = false;
}
$totalRanking[$student['user_id']] = $score[0];
$average += $score[0];
}
$totalRanking = AbstractLink::getCurrentUserRanking($user_id, $totalRanking);
$totalRanking = $scoredisplay->display_score($totalRanking, SCORE_DIV, SCORE_BOTH, true);
if ($invalidateRanking) {
$totalRanking = null;
}
// Overwrite main weight
$totalBest[1] = $main_weight;
$totalBest = $scoredisplay->display_score($totalBest, SCORE_DIV, SCORE_BOTH, true);
// Overwrite main weight
$totalAverage[0] = $average / count($this->studentList);
$totalAverage[1] = $main_weight;
$totalAverage = $scoredisplay->display_score($totalAverage, SCORE_DIV, SCORE_BOTH, true);
if ($this->exportToPdf) {
$row = array(null, '<h3>' . get_lang('Total') . '</h3>', $main_weight, $totalResult, $totalRanking, $totalBest, $totalAverage);
} else {
$row = array(null, '<h3>' . get_lang('Total') . '</h3>', null, $main_weight, $totalResult, $totalRanking, $totalBest, $totalAverage);
}
$sortable_data[] = $row;
}
}
// Warning messages
$view = isset($_GET['view']) ? $_GET['view'] : null;
if ($this->teacherView) {
if (isset($_GET['selectcat']) && $_GET['selectcat'] > 0 && $view != 'presence') {
$id_cat = intval($_GET['selectcat']);
$category = Category::load($id_cat);
$weight_category = intval($this->build_weight($category[0]));
$course_code = $this->build_course_code($category[0]);
$weight_total_links = round($weight_total_links);
if ($weight_total_links > $weight_category || $weight_total_links < $weight_category || $weight_total_links > $weight_category) {
$warning_message = sprintf(get_lang('TotalWeightMustBeX'), $weight_category);
$modify_icons = '<a href="gradebook_edit_cat.php?editcat=' . $id_cat . '&cidReq=' . $course_code . '&id_session=' . api_get_session_id() . '">' . Display::return_icon('edit.png', $warning_message, array(), ICON_SIZE_SMALL) . '</a>';
$warning_message .= $modify_icons;
Display::display_warning_message($warning_message, false);
}
$content_html = DocumentManager::replace_user_info_into_html(api_get_user_id(), $course_code);
if (!empty($content_html)) {
$new_content = explode('</head>', $content_html['content']);
}
if (empty($new_content[0])) {
// Set default certificate
$courseData = api_get_course_info($course_code);
DocumentManager::generateDefaultCertificate($courseData);
}
}
if (empty($_GET['selectcat'])) {
$categories = Category::load();
$weight_categories = $certificate_min_scores = $course_codes = array();
foreach ($categories as $category) {
$course_code_category = $this->build_course_code($category);
if (!empty($course_code)) {
if ($course_code_category == $course_code) {
$weight_categories[] = intval($this->build_weight($category));
$certificate_min_scores[] = intval($this->build_certificate_min_score($category));
$course_codes[] = $course_code;
break;
}
} else {
$weight_categories[] = intval($this->build_weight($category));
$certificate_min_scores[] = intval($this->build_certificate_min_score($category));
$course_codes[] = $course_code_category;
}
}
if (is_array($weight_categories) && is_array($certificate_min_scores) && is_array($course_codes)) {
$warning_message = '';
for ($x = 0; $x < count($weight_categories); $x++) {
$weight_category = intval($weight_categories[$x]);
$certificate_min_score = intval($certificate_min_scores[$x]);
$course_code = $course_codes[$x];
if (empty($certificate_min_score) || $certificate_min_score > $weight_category) {
$warning_message .= $course_code . ' - ' . get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan') . ' ' . $weight_category . '<br />';
}
}
if (!empty($warning_message)) {
Display::display_warning_message($warning_message, false);
}
}
}
}
return $sortable_data;
}
