Chamilo is a learning management system focused on ease of use and accessibility
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
chamilo-lms/main/exercise/TestCategory.php

1283 lines
41 KiB

<?php
/* For licensing terms, see /license.txt */
use ChamiloSession as Session;
/**
* Class TestCategory.
* Manage question categories inside an exercise.
*
* @author hubert.borderiou
* @author Julio Montoya - several fixes
*
* @todo rename to ExerciseCategory
*/
class TestCategory
{
public $iid;
public $name;
public $description;
/**
* Constructor of the class Category.
*/
public function __construct()
{
$this->name = '';
$this->description = '';
}
/**
* return the TestCategory object with iid=$id.
*
* @param int $id
* @param int $courseId
*
* @return TestCategory
*/
public function getCategory($id, $courseId = 0)
{
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$id = (int) $id;
$courseId = empty($courseId) ? api_get_course_int_id() : (int) $courseId;
$sql = "SELECT * FROM $table
WHERE iid = ".$id;
$res = Database::query($sql);
if (Database::num_rows($res)) {
$row = Database::fetch_array($res);
$this->iid = $row['iid'];
$this->name = $row['title'];
$this->description = $row['description'];
return $this;
}
return false;
}
/**
* Save TestCategory in the database if name doesn't exists.
*
* @param int $courseId
*
* @return bool
*/
public function save($courseId = 0)
{
$courseId = empty($courseId) ? api_get_course_int_id() : (int) $courseId;
$courseInfo = api_get_course_info_by_id($courseId);
if (empty($courseInfo)) {
return false;
}
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
// check if name already exists
$sql = "SELECT count(*) AS nb FROM $table
WHERE title = '".Database::escape_string($this->name)."' AND c_id = $courseId";
$result = Database::query($sql);
$row = Database::fetch_array($result);
// lets add in BDD if not the same name
if ($row['nb'] <= 0) {
$params = [
'c_id' => $courseId,
'title' => $this->name,
'description' => $this->description,
];
$newId = Database::insert($table, $params);
if ($newId) {
api_item_property_update(
$courseInfo,
TOOL_TEST_CATEGORY,
$newId,
'TestCategoryAdded',
api_get_user_id()
);
}
return $newId;
} else {
return false;
}
}
/**
* Removes the category from the database
* if there were question in this category, the link between question and category is removed.
*
* @param int $id
*
* @return bool
*/
public function removeCategory($id)
{
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$tbl_question_rel_cat = Database::get_course_table(TABLE_QUIZ_QUESTION_REL_CATEGORY);
$id = (int) $id;
$course_id = api_get_course_int_id();
$category = $this->getCategory($id);
if ($category) {
$sql = "DELETE FROM $table
WHERE iid = ".$id;
Database::query($sql);
// remove link between question and category
$sql = "DELETE FROM $tbl_question_rel_cat
WHERE category_id = ".$id;
Database::query($sql);
// item_property update
$courseInfo = api_get_course_info_by_id($course_id);
api_item_property_update(
$courseInfo,
TOOL_TEST_CATEGORY,
$this->iid,
'TestCategoryDeleted',
api_get_user_id()
);
return true;
}
return false;
}
/**
* Modify category name or description of category with id=in_id.
*
* @param int $courseId
*
* @return bool
*/
public function modifyCategory($courseId = 0)
{
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$id = (int) $this->iid;
$name = Database::escape_string($this->name);
$description = Database::escape_string($this->description);
$cat = $this->getCategory($id, $courseId);
$courseId = empty($courseId) ? api_get_course_int_id() : (int) $courseId;
$courseInfo = api_get_course_info_by_id($courseId);
if (empty($courseInfo)) {
return false;
}
if ($cat) {
$sql = "UPDATE $table SET
title = '$name',
description = '$description'
WHERE iid = $id";
Database::query($sql);
api_item_property_update(
$courseInfo,
TOOL_TEST_CATEGORY,
$this->iid,
'TestCategoryModified',
api_get_user_id()
);
return true;
}
return false;
}
/**
* Gets the number of question of category id=in_id.
*/
public function getCategoryQuestionsNumber()
{
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_REL_CATEGORY);
$id = (int) $this->iid;
$sql = "SELECT count(*) AS nb
FROM $table
WHERE category_id = $id AND c_id = ".api_get_course_int_id();
$res = Database::query($sql);
$row = Database::fetch_array($res);
return $row['nb'];
}
/**
* Return an array of all Category objects in the database
* If $field=="" Return an array of all category objects in the database
* Otherwise, return an array of all in_field value
* in the database (in_field = id or name or description).
*
* @param string $field
* @param int $courseId
*
* @return array
*/
public static function getCategoryListInfo($field = '', $courseId = 0)
{
$courseId = empty($courseId) ? api_get_course_int_id() : (int) $courseId;
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$categories = [];
if (empty($field)) {
$sql = "SELECT iid FROM $table
WHERE c_id = $courseId
ORDER BY title ASC";
$res = Database::query($sql);
while ($row = Database::fetch_array($res)) {
$category = new TestCategory();
$categories[] = $category->getCategory($row['iid'], $courseId);
}
} else {
$field = Database::escape_string($field);
$sql = "SELECT $field FROM $table
WHERE c_id = $courseId
ORDER BY `$field` ASC";
$res = Database::query($sql);
while ($row = Database::fetch_array($res)) {
$categories[] = $row[$field];
}
}
return $categories;
}
/**
* Return the TestCategory id for question with question_id = $questionId
* In this version, a question has only 1 TestCategory.
* Return the TestCategory id, 0 if none.
*
* @param int $questionId
* @param int $courseId
*
* @return int
*/
public static function getCategoryForQuestion($questionId, $courseId = 0)
{
$categoryInfo = self::getCategoryInfoForQuestion($questionId, $courseId);
if (!empty($categoryInfo) && isset($categoryInfo['category_id'])) {
return (int) $categoryInfo['category_id'];
}
return 0;
}
public static function getCategoryInfoForQuestion($questionId, $courseId = 0)
{
$courseId = (int) $courseId;
$questionId = (int) $questionId;
if (empty($courseId)) {
$courseId = api_get_course_int_id();
}
if (empty($courseId) || empty($questionId)) {
return 0;
}
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_REL_CATEGORY);
$sql = "SELECT *
FROM $table
WHERE question_id = $questionId AND c_id = $courseId";
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
return Database::fetch_array($res, 'ASSOC');
}
return [];
}
/**
* Return the category name for question with question_id = $questionId
* In this version, a question has only 1 category.
*
* @param $questionId
* @param int $courseId
*
* @return string
*/
public static function getCategoryNameForQuestion($questionId, $courseId = 0)
{
if (empty($courseId)) {
$courseId = api_get_course_int_id();
}
$courseId = (int) $courseId;
$categoryId = self::getCategoryForQuestion($questionId, $courseId);
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$sql = "SELECT title
FROM $table
WHERE iid = $categoryId";
$res = Database::query($sql);
$data = Database::fetch_array($res);
$result = '';
if (Database::num_rows($res) > 0) {
$result = $data['title'];
}
return $result;
}
/**
* Return the list of different categories ID for a test in the current course
* hubert.borderiou 07-04-2011.
*
* @param int $exerciseId
* @param int $courseId
*
* @return array
*/
public static function getListOfCategoriesIDForTest($exerciseId, $courseId = 0)
{
// Check test questions, obtaining unique categories in a table
$exercise = new Exercise($courseId);
$exercise->read($exerciseId, false);
$categoriesInExercise = $exercise->getQuestionWithCategories();
// the array given by selectQuestionList start at indice 1 and not at indice 0 !!! ???
$categories = [];
if (!empty($categoriesInExercise)) {
foreach ($categoriesInExercise as $category) {
$categories[$category['iid']] = $category;
}
}
return $categories;
}
/**
* @return array
*/
public static function getListOfCategoriesIDForTestObject(Exercise $exercise)
{
// Check the categories of a test, obtaining unique categories in table
$categories_in_exercise = [];
$question_list = $exercise->getQuestionOrderedListByName();
// the array given by selectQuestionList start at indice 1 and not at indice 0 !!! ???
foreach ($question_list as $questionInfo) {
$question_id = $questionInfo['question_id'];
$category_list = self::getCategoryForQuestion($question_id);
if (is_numeric($category_list)) {
$category_list = [$category_list];
}
if (!empty($category_list)) {
$categories_in_exercise = array_merge($categories_in_exercise, $category_list);
}
}
if (!empty($categories_in_exercise)) {
$categories_in_exercise = array_unique(array_filter($categories_in_exercise));
}
return $categories_in_exercise;
}
/**
* Return the list of different categories NAME for a test.
*
* @param int $exerciseId
* @param bool
*
* @return array
*
* @author function rewrote by jmontoya
*/
public static function getListOfCategoriesNameForTest($exerciseId, $grouped_by_category = true)
{
$result = [];
$categories = self::getListOfCategoriesIDForTest($exerciseId);
foreach ($categories as $catInfo) {
$categoryId = $catInfo['iid'];
if (!empty($categoryId)) {
$result[$categoryId] = [
'iid' => $categoryId,
'title' => $catInfo['title'],
//'parent_id' => $catInfo['parent_id'],
'parent_id' => '',
'c_id' => $catInfo['c_id'],
];
}
}
return $result;
}
/**
* @return array
*/
public static function getListOfCategoriesForTest(Exercise $exercise)
{
$result = [];
$categories = self::getListOfCategoriesIDForTestObject($exercise);
foreach ($categories as $cat_id) {
$cat = new TestCategory();
//Todo remove this weird array casting
$cat = (array) $cat->getCategory($cat_id);
$cat['title'] = $cat['name'];
$result[$cat['iid']] = $cat;
}
return $result;
}
/**
* return the number of question of a category id in a test.
*
* @param int $exerciseId
* @param int $categoryId
*
* @return int
*
* @author hubert.borderiou 07-04-2011
*/
public static function getNumberOfQuestionsInCategoryForTest($exerciseId, $categoryId)
{
$nbCatResult = 0;
$quiz = new Exercise();
$quiz->read($exerciseId);
$questionList = $quiz->selectQuestionList();
// the array given by selectQuestionList start at indice 1 and not at indice 0 !!! ? ? ?
for ($i = 1; $i <= count($questionList); $i++) {
if (self::getCategoryForQuestion($questionList[$i]) == $categoryId) {
$nbCatResult++;
}
}
return $nbCatResult;
}
/**
* return the number of question for a test using random by category
* input : test_id, number of random question (min 1).
*
* @param int $exerciseId
* @param int $random
*
* @return int
* hubert.borderiou 07-04-2011
* question without categories are not counted
*/
public static function getNumberOfQuestionRandomByCategory($exerciseId, $random)
{
$count = 0;
$categories = self::getListOfCategoriesIDForTest($exerciseId);
foreach ($categories as $category) {
if (empty($category['iid'])) {
continue;
}
$nbQuestionInThisCat = self::getNumberOfQuestionsInCategoryForTest(
$exerciseId,
$category['iid']
);
if ($nbQuestionInThisCat > $random) {
$count += $random;
} else {
$count += $nbQuestionInThisCat;
}
}
return $count;
}
/**
* Return an array (id=>name)
* array[0] = get_lang('NoCategory');.
*
* @param int $courseId
*
* @return array
*/
public static function getCategoriesIdAndName($courseId = 0)
{
if (empty($courseId)) {
$courseId = api_get_course_int_id();
}
$categories = self::getCategoryListInfo('', $courseId);
$result = ['0' => get_lang('NoCategorySelected')];
for ($i = 0; $i < count($categories); $i++) {
$result[$categories[$i]->iid] = Security::remove_XSS($categories[$i]->name);
}
return $result;
}
/**
* Returns an array of question ids for each category
* $categories[1][30] = 10, array with category id = 1 and question_id = 10
* A question has "n" categories.
*
* @param int $exerciseId
* @param array $check_in_question_list
* @param array $categoriesAddedInExercise
*
* @return array
*/
public static function getQuestionsByCat(
$exerciseId,
$check_in_question_list = [],
$categoriesAddedInExercise = [],
$onlyMandatory = false,
$courseId = null
) {
$tableQuestion = Database::get_course_table(TABLE_QUIZ_QUESTION);
$TBL_EXERCICE_QUESTION = Database::get_course_table(TABLE_QUIZ_TEST_QUESTION);
$TBL_QUESTION_REL_CATEGORY = Database::get_course_table(TABLE_QUIZ_QUESTION_REL_CATEGORY);
$categoryTable = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$exerciseId = (int) $exerciseId;
if (!isset($courseId)) {
$courseId = api_get_course_int_id();
}
$mandatoryCondition = '';
if ($onlyMandatory) {
$mandatoryCondition = ' AND qrc.mandatory = 1';
}
$sql = "SELECT DISTINCT qrc.question_id, qrc.category_id
FROM $TBL_QUESTION_REL_CATEGORY qrc
INNER JOIN $TBL_EXERCICE_QUESTION eq
ON (eq.question_id = qrc.question_id)
INNER JOIN $categoryTable c
ON (c.iid = qrc.category_id AND c.c_id = eq.c_id)
INNER JOIN $tableQuestion q
ON q.iid = qrc.question_id
WHERE
exercice_id = $exerciseId AND
qrc.c_id = $courseId
$mandatoryCondition
";
$res = Database::query($sql);
$categories = [];
while ($data = Database::fetch_array($res)) {
if (!empty($check_in_question_list)) {
if (!in_array($data['question_id'], $check_in_question_list)) {
continue;
}
}
if (!isset($categories[$data['category_id']]) ||
!is_array($categories[$data['category_id']])
) {
$categories[$data['category_id']] = [];
}
$categories[$data['category_id']][] = $data['question_id'];
}
if (!empty($categoriesAddedInExercise)) {
$newCategoryList = [];
foreach ($categoriesAddedInExercise as $category) {
$categoryId = $category['category_id'];
if (isset($categories[$categoryId])) {
$newCategoryList[$categoryId] = $categories[$categoryId];
}
}
$checkQuestionsWithNoCategory = false;
foreach ($categoriesAddedInExercise as $category) {
if (empty($category['category_id'])) {
// Check
$checkQuestionsWithNoCategory = true;
break;
}
}
// Select questions that don't have any category related
if ($checkQuestionsWithNoCategory) {
$originalQuestionList = $check_in_question_list;
foreach ($originalQuestionList as $questionId) {
$categoriesFlatten = array_flatten($categories);
if (!in_array($questionId, $categoriesFlatten)) {
$newCategoryList[0][] = $questionId;
}
}
}
$categories = $newCategoryList;
}
return $categories;
}
/**
* Returns an array of $numberElements from $elements.
*
* @param array $elements
* @param int $numberElements
* @param bool $shuffle
* @param array $mandatoryElements
*
* @return array
*/
public static function getNElementsFromArray($elements, $numberElements, $shuffle = true, $mandatoryElements = [])
{
$countElements = count($elements);
$countMandatory = count($mandatoryElements);
if (!empty($countMandatory)) {
if ($countMandatory >= $numberElements) {
if ($shuffle) {
shuffle($mandatoryElements);
}
$elements = array_slice($mandatoryElements, 0, $numberElements);
return $elements;
}
$diffCount = $numberElements - $countMandatory;
$diffElements = array_diff($elements, $mandatoryElements);
if ($shuffle) {
shuffle($diffElements);
}
$elements = array_slice($diffElements, 0, $diffCount);
$totalElements = array_merge($mandatoryElements, $elements);
if ($shuffle) {
shuffle($totalElements);
}
return $totalElements;
}
if ($shuffle) {
shuffle($elements);
}
if ($numberElements < $countElements) {
$elements = array_slice($elements, 0, $numberElements);
}
return $elements;
}
/**
* @param int $questionId
* @param int $displayCategoryName
*/
public static function displayCategoryAndTitle($questionId, $displayCategoryName = 1)
{
echo self::returnCategoryAndTitle($questionId, $displayCategoryName);
}
/**
* @param int $questionId
* @param int $in_display_category_name
*
* @return string|null
*/
public static function returnCategoryAndTitle($questionId, $in_display_category_name = 1)
{
$is_student = !(api_is_allowed_to_edit(null, true) || api_is_session_admin());
$objExercise = Session::read('objExercise');
if (!empty($objExercise)) {
$in_display_category_name = $objExercise->display_category_name;
}
$content = null;
if (self::getCategoryNameForQuestion($questionId) != '' &&
($in_display_category_name == 1 || !$is_student)
) {
$content .= '<div class="page-header">';
$content .= '<h4>'.get_lang('Category').": ".Security::remove_XSS(self::getCategoryNameForQuestion($questionId)).'</h4>';
$content .= "</div>";
}
return $content;
}
/**
* sortTabByBracketLabel ($tabCategoryQuestions)
* key of $tabCategoryQuestions are the category id (0 for not in a category)
* value is the array of question id of this category
* Sort question by Category.
*/
public static function sortTabByBracketLabel($in_tab)
{
$tabResult = [];
$tabCatName = []; // tab of category name
foreach ($in_tab as $cat_id => $tabquestion) {
$category = new TestCategory();
$category = $category->getCategory($cat_id);
$tabCatName[$cat_id] = $category->name;
}
reset($in_tab);
// sort table by value, keeping keys as they are
asort($tabCatName);
// keys of $tabCatName are keys order for $in_tab
foreach ($tabCatName as $key => $val) {
$tabResult[$key] = $in_tab[$key];
}
return $tabResult;
}
/**
* Return the number max of question in a category
* count the number of questions in all categories, and return the max.
*
* @param int $exerciseId
*
* @author - hubert borderiou
*
* @return int
*/
public static function getNumberMaxQuestionByCat($exerciseId)
{
$res_num_max = 0;
// foreach question
$categories = self::getListOfCategoriesIDForTest($exerciseId);
foreach ($categories as $category) {
if (empty($category['iid'])) {
continue;
}
$nbQuestionInThisCat = self::getNumberOfQuestionsInCategoryForTest(
$exerciseId,
$category['iid']
);
if ($nbQuestionInThisCat > $res_num_max) {
$res_num_max = $nbQuestionInThisCat;
}
}
return $res_num_max;
}
/**
* Returns a category summary report.
*
* @param Exercise $exercise
* @param array $category_list
* pre filled array with the category_id, score, and weight
* example: array(1 => array('score' => '10', 'total' => 20));
*
* @return string
*/
public static function get_stats_table_by_attempt($exercise, $category_list = [])
{
if (empty($category_list) || empty($exercise)) {
return '';
}
$hide = (int) $exercise->getPageConfigurationAttribute('hide_category_table');
if (1 === $hide) {
return '';
}
$exerciseId = $exercise->iid;
$categoryNameList = self::getListOfCategoriesNameForTest($exerciseId);
$table = new HTML_Table(
[
'class' => 'table table-hover table-striped table-bordered',
'id' => 'category_results',
]
);
$table->setHeaderContents(0, 0, get_lang('Categories'));
$table->setHeaderContents(0, 1, get_lang('AbsoluteScore'));
$table->setHeaderContents(0, 2, get_lang('RelativeScore'));
$row = 1;
$none_category = [];
if (isset($category_list['none'])) {
$none_category = $category_list['none'];
unset($category_list['none']);
}
$total = [];
if (isset($category_list['total'])) {
$total = $category_list['total'];
unset($category_list['total']);
}
$radar = '';
$countCategories = count($category_list);
if ($countCategories > 1) {
$tempResult = [];
$labels = [];
$labelsWithId = array_column($categoryNameList, 'title', 'iid');
asort($labelsWithId);
foreach ($labelsWithId as $category_id => $title) {
if (!isset($category_list[$category_id])) {
continue;
}
$labels[] = $title;
$categoryItem = $category_list[$category_id];
$table->setCellContents($row, 0, $title);
$table->setCellContents(
$row,
1,
ExerciseLib::show_score(
$categoryItem['score'],
$categoryItem['total'],
false
)
);
$table->setCellContents(
$row,
2,
ExerciseLib::show_score(
$categoryItem['score'],
$categoryItem['total'],
true,
false,
true
)
);
if ($categoryItem['total'] > 0) {
$tempResult[$category_id] = round($categoryItem['score'] / $categoryItem['total'] * 10);
} else {
$tempResult[$category_id] = 0;
}
$row++;
}
// Radar requires more than 3 categories.
if ($countCategories > 2 && RESULT_DISABLE_RADAR === (int) $exercise->results_disabled) {
$resultsArray = [];
foreach ($labelsWithId as $categoryId => $label) {
if (isset($tempResult[$categoryId])) {
$resultsArray[] = $tempResult[$categoryId];
} else {
$resultsArray[] = 0;
}
}
$radar = $exercise->getRadar($labels, [$resultsArray]);
}
if (!empty($none_category)) {
$table->setCellContents($row, 0, get_lang('None'));
$table->setCellContents(
$row,
1,
ExerciseLib::show_score(
$none_category['score'],
$none_category['total'],
false
)
);
$table->setCellContents(
$row,
2,
ExerciseLib::show_score(
$none_category['score'],
$none_category['total'],
true,
false,
true
)
);
$row++;
}
if (!empty($total)) {
$table->setCellContents($row, 0, get_lang('Total'));
$table->setCellContents(
$row,
1,
ExerciseLib::show_score(
$total['score'],
$total['total'],
false
)
);
$table->setCellContents(
$row,
2,
ExerciseLib::show_score(
$total['score'],
$total['total'],
true,
false,
true
)
);
}
return $radar.$table->toHtml();
}
return '';
}
/**
* @param Exercise $exercise
* @param int $courseId
* @param string $order
* @param bool $shuffle
* @param bool $excludeCategoryWithNoQuestions
*
* @return array
*/
public function getCategoryExerciseTree(
$exercise,
$courseId,
$order = null,
$shuffle = false,
$excludeCategoryWithNoQuestions = true
) {
if (empty($exercise)) {
return [];
}
$courseId = (int) $courseId;
$table = Database::get_course_table(TABLE_QUIZ_REL_CATEGORY);
$categoryTable = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$exercise->iid = (int) $exercise->iid;
$sql = "SELECT * FROM $table qc
LEFT JOIN $categoryTable c
ON (c.iid = qc.category_id)
WHERE qc.c_id = $courseId AND exercise_id = {$exercise->iid} ";
if (!empty($order)) {
$order = Database::escape_string($order);
$sql .= "ORDER BY $order";
}
$categories = [];
$result = Database::query($sql);
if (Database::num_rows($result)) {
while ($row = Database::fetch_array($result, 'ASSOC')) {
if ($excludeCategoryWithNoQuestions) {
if ($row['count_questions'] == 0) {
continue;
}
}
if (empty($row['title']) && empty($row['category_id'])) {
$row['title'] = get_lang('NoCategory');
}
$categories[$row['category_id']] = $row;
}
}
if ($shuffle) {
shuffle_assoc($categories);
}
return $categories;
}
/**
* @param FormValidator $form
* @param string $action
*/
public function getForm(&$form, $action = 'new')
{
switch ($action) {
case 'new':
$header = get_lang('AddACategory');
$submit = get_lang('AddTestCategory');
break;
case 'edit':
$header = get_lang('EditCategory');
$submit = get_lang('ModifyCategory');
break;
}
// Setting the form elements
$form->addElement('header', $header);
$form->addElement('hidden', 'category_id');
$form->addElement(
'text',
'category_name',
get_lang('CategoryName'),
['class' => 'span6']
);
$form->add_html_editor(
'category_description',
get_lang('CategoryDescription'),
false,
false,
[
'ToolbarSet' => 'test_category',
'Width' => '90%',
'Height' => '200',
]
);
$category_parent_list = [];
$options = [
'1' => get_lang('Visible'),
'0' => get_lang('Hidden'),
];
$form->addElement(
'select',
'visibility',
get_lang('Visibility'),
$options
);
$script = null;
if (!empty($this->parent_id)) {
$parent_cat = new TestCategory();
$parent_cat = $parent_cat->getCategory($this->parent_id);
$category_parent_list = [$parent_cat->iid => $parent_cat->name];
$script .= '<script>$(function() { $("#parent_id").trigger("addItem",[{"title": "'.$parent_cat->name.'", "value": "'.$parent_cat->iid.'"}]); });</script>';
}
$form->addElement('html', $script);
$form->addElement('select', 'parent_id', get_lang('Parent'), $category_parent_list, ['id' => 'parent_id']);
$form->addElement('style_submit_button', 'SubmitNote', $submit, 'class="add"');
// setting the defaults
$defaults = [];
$defaults["category_id"] = $this->iid;
$defaults["category_name"] = $this->name;
$defaults["category_description"] = $this->description;
$defaults["parent_id"] = $this->parent_id;
$defaults["visibility"] = $this->visibility;
$form->setDefaults($defaults);
// setting the rules
$form->addRule('category_name', get_lang('ThisFieldIsRequired'), 'required');
}
/**
* Returns the category form.
*
* @return string
*/
public function returnCategoryForm(Exercise $exercise)
{
$categories = $this->getListOfCategoriesForTest($exercise);
$sortedCategories = [];
foreach ($categories as $catId => $cat) {
$sortedCategories[$cat['title']] = $cat;
}
ksort($sortedCategories);
$saved_categories = $exercise->getCategoriesInExercise();
$return = null;
if (!empty($sortedCategories)) {
$nbQuestionsTotal = $exercise->getNumberQuestionExerciseCategory();
$exercise->setCategoriesGrouping(true);
$real_question_count = count($exercise->getQuestionList());
$warning = null;
if ($nbQuestionsTotal != $real_question_count) {
$warning = Display::return_message(
get_lang('CheckThatYouHaveEnoughQuestionsInYourCategories'),
'warning'
);
}
$return .= $warning;
$return .= '<table class="table table-hover table-bordered data_table">';
$return .= '<tr>';
$return .= '<th height="24">'.get_lang('Categories').'</th>';
$return .= '<th width="70" height="24">'.get_lang('Number').'</th></tr>';
$emptyCategory = [
'id' => '0',
'name' => get_lang('NoCategory'),
'description' => '',
'iid' => '0',
'title' => get_lang('NoCategory'),
];
$sortedCategories[] = $emptyCategory;
foreach ($sortedCategories as $category) {
$cat_id = $category['iid'];
$return .= '<tr>';
$return .= '<td>';
$return .= Display::div($category['name']);
$return .= '</td>';
$return .= '<td>';
$value = isset($saved_categories) && isset($saved_categories[$cat_id]) ? $saved_categories[$cat_id]['count_questions'] : -1;
$return .= Display::input(
'number',
"category[$cat_id]",
$value,
['class' => 'form-control', 'min' => -1, 'step' => 1]
);
$return .= '</td>';
$return .= '</tr>';
}
$return .= '</table>';
$return .= get_lang('ZeroMeansNoQuestionWillBeSelectedMinusOneMeansThatAllQuestionsWillBeSelected');
}
return $return;
}
/**
* Return true if a category already exists with the same name.
*
* @param string $name
* @param int $courseId
*
* @return bool
*/
public static function categoryTitleExists($name, $courseId = 0)
{
$categories = self::getCategoryListInfo('title', $courseId);
foreach ($categories as $title) {
if ($title == $name) {
return true;
}
}
return false;
}
/**
* Return the id of the test category with title = $in_title.
*
* @param string $title
* @param int $courseId
*
* @return int is id of test category
*/
public static function get_category_id_for_title($title, $courseId = 0)
{
$out_res = 0;
if (empty($courseId)) {
$courseId = api_get_course_int_id();
}
$courseId = (int) $courseId;
$tbl_cat = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$sql = "SELECT iid FROM $tbl_cat
WHERE c_id = $courseId AND title = '".Database::escape_string($title)."'";
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
$data = Database::fetch_array($res);
$out_res = $data['iid'];
}
return $out_res;
}
/**
* Add a relation between question and category in table c_quiz_question_rel_category.
*
* @param int $categoryId
* @param int $questionId
* @param int $courseId
*
* @return string|false
*/
public static function addCategoryToQuestion($categoryId, $questionId, $courseId)
{
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_REL_CATEGORY);
// if question doesn't have a category
// @todo change for 1.10 when a question can have several categories
if (self::getCategoryForQuestion($questionId, $courseId) == 0 &&
$questionId > 0 &&
$courseId > 0
) {
$sql = "INSERT INTO $table (c_id, question_id, category_id)
VALUES (".intval($courseId).", ".intval($questionId).", ".intval($categoryId).")";
Database::query($sql);
$id = Database::insert_id();
return $id;
}
return false;
}
/**
* @param int $courseId
* @param int $sessionId
*
* @return array
*/
public function getCategories($courseId, $sessionId = 0)
{
$table = Database::get_course_table(TABLE_QUIZ_QUESTION_CATEGORY);
$itemProperty = Database::get_course_table(TABLE_ITEM_PROPERTY);
$sessionId = intval($sessionId);
$courseId = intval($courseId);
if (empty($sessionId)) {
$sessionCondition = api_get_session_condition(
$sessionId,
true,
false,
'i.session_id'
);
} else {
$sessionCondition = api_get_session_condition(
$sessionId,
true,
true,
'i.session_id'
);
}
if (empty($courseId)) {
return [];
}
$sql = "SELECT cat.* FROM $table cat
INNER JOIN $itemProperty i
ON cat.c_id = i.c_id AND i.ref = cat.iid
WHERE
cat.c_id = $courseId AND
i.tool = '".TOOL_TEST_CATEGORY."'
$sessionCondition
ORDER BY title ASC";
$result = Database::query($sql);
return Database::store_result($result, 'ASSOC');
}
/**
* @param int $courseId
* @param int $sessionId
*
* @return string
*/
public function displayCategories($courseId, $sessionId = 0)
{
$sessionId = (int) $sessionId;
$categories = $this->getCategories($courseId, $sessionId);
$html = '';
foreach ($categories as $category) {
$tmpobj = new TestCategory();
$tmpobj = $tmpobj->getCategory($category['iid']);
$nb_question = $tmpobj->getCategoryQuestionsNumber();
$rowname = self::protectJSDialogQuote($category['title']);
$nb_question_label = $nb_question == 1 ? $nb_question.' '.get_lang('Question') : $nb_question.' '.get_lang('Questions');
$content = "<span style='float:right'>".$nb_question_label."</span>";
$content .= '<div class="sectioncomment">';
$content .= Security::remove_XSS($category['description']);
$content .= '</div>';
$links = '';
if (!$sessionId) {
$links .= '<a href="'.api_get_self().'?action=editcategory&category_id='.$category['iid'].'&'.api_get_cidreq().'">'.
Display::return_icon('edit.png', get_lang('Edit'), [], ICON_SIZE_SMALL).'</a>';
$links .= ' <a href="'.api_get_self().'?'.api_get_cidreq().'&action=deletecategory&category_id='.$category['iid'].'" ';
$links .= 'onclick="return confirmDelete(\''.self::protectJSDialogQuote(get_lang('DeleteCategoryAreYouSure').'['.$rowname).'] ?\', \'id_cat'.$category['iid'].'\');">';
$links .= Display::return_icon('delete.png', get_lang('Delete'), [], ICON_SIZE_SMALL).'</a>';
}
$html .= Display::panel($content, Security::remove_XSS($category['title']).$links);
}
return $html;
}
/**
* To allowed " in javascript dialog box without bad surprises
* replace " with two '.
*
* @param string $text
*
* @return mixed
*/
public function protectJSDialogQuote($text)
{
$res = $text;
$res = str_replace("'", "\'", $res);
// super astuce pour afficher les " dans les boite de dialogue
$res = str_replace('"', "\'\'", $res);
return $res;
}
}