public/main/gradebook/lib/be/exerciselink.class.php
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CQuiz;
/**
* Class ExerciseLink
* Defines a gradebook ExerciseLink object.
*
* @author Bert Steppé
*/
class ExerciseLink extends AbstractLink
{
public $checkBaseExercises = false;
private $exercise_table;
private $exercise_data = [];
private $is_hp;
/**
* @param int $hp
*/
public function __construct($hp = 0)
{
parent::__construct();
$this->set_type(LINK_EXERCISE);
$this->is_hp = $hp;
if (1 == $this->is_hp) {
$this->set_type(LINK_HOTPOTATOES);
}
}
/**
* Generate an array of all exercises available.
*
* @param bool $getOnlyHotPotatoes
*
* @return array 2-dimensional array - every element contains 2 subelements (id, name)
*/
public function get_all_links($getOnlyHotPotatoes = false)
{
$exerciseTable = $this->get_exercise_table();
$lpItemTable = Database::get_course_table(TABLE_LP_ITEM);
if (empty($this->getCourseId())) {
return [];
}
$sessionId = $this->get_session_id();
if (empty($sessionId)) {
$session_condition = api_get_session_condition(0, true);
} else {
$session_condition = api_get_session_condition($sessionId, true, true);
}
// @todo
$uploadPath = null;
$repo = Container::getQuizRepository();
$course = api_get_course_entity($this->course_id);
$session = api_get_session_entity($sessionId);
$qb = $repo->findAllByCourse($course, $session, null, 1, false);
/** @var CQuiz[] $exercises */
$exercises = $qb->getQuery()->getResult();
$cats = [];
if (!empty($exercises)) {
foreach ($exercises as $exercise) {
$cats[] = [$exercise->getIid(), $exercise->getTitle()];
}
}
$sqlLp = "SELECT e.iid, e.title
FROM $exerciseTable e
INNER JOIN $lpItemTable i
ON (e.iid = i.path)
WHERE
active = 0 AND
item_type = 'quiz'
";
$resultLp = Database::query($sqlLp);
$exerciseInLP = Database::store_result($resultLp);
if (!empty($exerciseInLP)) {
foreach ($exerciseInLP as $exercise) {
$cats[] = [
$exercise['iid'],
$exercise['title'].' ('.get_lang('Learning path').')',
];
}
}
return $cats;
}
/**
* Has anyone done this exercise yet ?
* @throws Exception
*/
public function has_results()
{
$tbl_stats = Database::get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES);
$sessionId = $this->get_session_id();
$course_id = ($this->getCourseId());
$sessionCondition = api_get_session_condition($sessionId);
$sql = "SELECT count(exe_id) AS number
FROM $tbl_stats
WHERE
c_id = $course_id AND
exe_exo_id = ".$this->get_ref_id()."
$sessionCondition
";
$result = Database::query($sql);
$number = Database::fetch_row($result);
return 0 != $number[0];
}
/**
* Get the score of this exercise. Only the first attempts are taken into account.
*
* @param int $studentId (default: all students who have results then the average is returned)
* @param string $type
*
* @return array (score, max) if student is given
* array (sum of scores, number of scores) otherwise
* or null if no scores available
*/
public function calc_score($studentId = null, $type = null)
{
$allowStats = ('true' === api_get_setting('gradebook.allow_gradebook_stats'));
if ($allowStats) {
$link = $this->entity;
if (!empty($link)) {
$weight = $link->getScoreWeight();
switch ($type) {
case 'best':
$bestResult = $link->getBestScore();
return [$bestResult, $weight];
break;
case 'average':
$count = count($link->getUserScoreList());
//$count = count($this->getStudentList());
if (empty($count)) {
return [0, $weight];
}
$sumResult = array_sum($link->getUserScoreList());
return [$sumResult / $count, $weight];
break;
case 'ranking':
return [null, null];
break;
default:
if (!empty($studentId)) {
$scoreList = $link->getUserScoreList();
$result = [0, $weight];
if (isset($scoreList[$studentId])) {
$result = [$scoreList[$studentId], $weight];
}
return $result;
} else {
$studentCount = count($this->getStudentList());
$sumResult = array_sum($link->getUserScoreList());
$result = [$sumResult, $studentCount];
}
return $result;
break;
}
}
}
$tblStats = Database::get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES);
$tblHp = Database::get_main_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
$tblDoc = Database::get_course_table(TABLE_DOCUMENT);
/* the following query should be similar (in conditions) to the one used
in exercise/exercise.php, look for note-query-exe-results marker*/
$sessionId = $this->get_session_id();
$courseId = $this->getCourseId();
$exerciseData = $this->get_exercise_data();
$exerciseId = isset($exerciseData['iid']) ? (int) $exerciseData['iid'] : 0;
$studentId = (int) $studentId;
if (empty($exerciseId)) {
return null;
}
$key = 'exercise_link_id:'.
$this->get_id().
'exerciseId:'.$exerciseId.'student:'.$studentId.'session:'.$sessionId.'courseId:'.$courseId.'type:'.$type;
$useCache = ('true' === api_get_setting('gradebook.gradebook_use_apcu_cache'));
$cacheAvailable = api_get_configuration_value('apc') && $useCache;
$cacheDriver = null;
if ($cacheAvailable) {
$cache = new \Symfony\Component\Cache\Adapter\ApcuAdapter();
if ($cache->hasItem($key)) {
return $cache->getItem($key)->get();
}
}
$exercise = new Exercise($courseId);
$exercise->read($exerciseId);
if (!$this->is_hp) {
if (false == $exercise->exercise_was_added_in_lp) {
$sessionCondition = api_get_session_condition($sessionId);
$sql = "SELECT * FROM $tblStats
WHERE
exe_exo_id = $exerciseId AND
orig_lp_id = 0 AND
orig_lp_item_id = 0 AND
status <> 'incomplete' AND
c_id = $courseId
$sessionCondition
";
} else {
$lpCondition = null;
if (!empty($exercise->lpList)) {
//$lpId = $exercise->getLpBySession($sessionId);
$lpList = [];
foreach ($exercise->lpList as $lpData) {
if ($this->checkBaseExercises) {
if (0 == (int) $lpData['session_id']) {
$lpList[] = $lpData['lp_id'];
}
} else {
if (in_array('session_id', $lpData) && (int) $lpData['session_id'] == $sessionId) {
$lpList[] = $lpData['lp_id'];
}
}
}
if (empty($lpList) && !empty($sessionId)) {
// Check also if an LP was added in the base course.
foreach ($exercise->lpList as $lpData) {
if (0 == (int) $lpData['session_id']) {
$lpList[] = $lpData['lp_id'];
}
}
}
$lpCondition = ' (orig_lp_id = 0 OR (orig_lp_id IN ("'.implode('", "', $lpList).'"))) AND ';
}
$sql = "SELECT *
FROM $tblStats
WHERE
exe_exo_id = $exerciseId AND
$lpCondition
status <> 'incomplete' AND
session_id = $sessionId AND
c_id = $courseId ";
}
if (!empty($studentId) && 'ranking' !== $type) {
$sql .= " AND exe_user_id = $studentId ";
}
$sql .= ' ORDER BY exe_id DESC';
} else {
$sql = "SELECT * FROM $tblHp hp
INNER JOIN $tblDoc doc
ON (hp.title = doc.path AND doc.c_id = hp.c_id)
WHERE
hp.c_id = $courseId AND
doc.iid = $exerciseId";
if (!empty($studentId)) {
$sql .= " AND hp.exe_user_id = $studentId ";
}
}
$scores = Database::query($sql);
if (isset($studentId) && empty($type)) {
// for 1 student
if ($data = Database::fetch_assoc($scores)) {
$attempts = Database::query($sql);
$counter = 0;
while ($attempt = Database::fetch_array($attempts)) {
$counter++;
}
$result = [$data['score'], $data['max_score'], $data['exe_date'], $counter];
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set($result);
$cache->save($cacheItem);
}
return $result;
} else {
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set(null);
$cache->save($cacheItem);
}
return null;
}
} else {
// all students -> get average
// normal way of getting the info
$students = []; // user list, needed to make sure we only
// take first attempts into account
$student_count = 0;
$sum = 0;
$bestResult = 0;
$weight = 0;
$sumResult = 0;
$studentList = $this->getStudentList();
$studentIdList = [];
if (!empty($studentList)) {
$studentIdList = array_column($studentList, 'user_id');
}
while ($data = Database::fetch_assoc($scores)) {
// Only take into account users in the current student list.
if (!empty($studentIdList)) {
if (!in_array($data['exe_user_id'], $studentIdList)) {
continue;
}
}
if (!isset($students[$data['exe_user_id']])) {
if (0 != $data['max_score']) {
$students[$data['exe_user_id']] = $data['score'];
$student_count++;
if ($data['score'] > $bestResult) {
$bestResult = $data['score'];
}
$sum += $data['score'] / $data['max_score'];
$sumResult += $data['score'];
$weight = $data['max_score'];
}
}
}
if (0 == $student_count) {
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set(null);
$cache->save($cacheItem);
}
return null;
} else {
switch ($type) {
case 'best':
$result = [$bestResult, $weight];
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set($result);
$cache->save($cacheItem);
}
return $result;
case 'average':
$count = count($this->getStudentList());
if (empty($count)) {
$result = [0, $weight];
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set($result);
$cache->save($cacheItem);
}
return $result;
}
$result = [$sumResult / $count, $weight];
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set($result);
$cache->save($cacheItem);
}
return $result;
case 'ranking':
$ranking = AbstractLink::getCurrentUserRanking($studentId, $students);
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set($ranking);
$cache->save($cacheItem);
}
return $ranking;
default:
$result = [$sum, $student_count];
if ($cacheAvailable) {
$cacheItem = $cache->getItem($key);
$cacheItem->set($result);
$cache->save($cacheItem);
}
return $result;
}
}
}
}
/**
* Get URL where to go to if the user clicks on the link.
* First we go to exercise_jump.php and then to the result page.
* Check this php file for more info.
*/
public function get_link()
{
$sessionId = $this->get_session_id();
$data = $this->get_exercise_data();
$exerciseId = $data['iid'];
$path = isset($data['path']) ? $data['path'] : '';
return api_get_path(WEB_CODE_PATH).'gradebook/exercise_jump.php?'
.http_build_query(
[
'path' => $path,
'sid' => $sessionId,
'cid' => $this->getCourseId(),
'gradebook' => 'view',
'exerciseId' => $exerciseId,
'type' => $this->get_type(),
]
);
}
/**
* Get name to display: same as exercise title.
*/
public function get_name()
{
$data = $this->get_exercise_data();
return $data['title'];
}
public function getLpListToString()
{
$data = $this->get_exercise_data();
$lpList = Exercise::getLpListFromExercise($data['iid'], $this->getCourseId());
$lpListToString = '';
if (!empty($lpList)) {
foreach ($lpList as &$list) {
$list['name'] = Display::label($list['name'], 'warning');
}
$lpListToString = implode(' ', array_column($lpList, 'name'));
}
return $lpListToString;
}
/**
* Get description to display: same as exercise description.
*/
public function get_description()
{
$data = $this->get_exercise_data();
return isset($data['description']) ? $data['description'] : null;
}
/**
* Check if this still links to an exercise.
*/
public function is_valid_link()
{
$exerciseData = $this->get_exercise_data();
return !empty($exerciseData);
}
/**
* @return string
*/
public function get_type_name()
{
if (1 == $this->is_hp) {
return 'HotPotatoes';
}
return get_lang('Tests');
}
public function needs_name_and_description()
{
return false;
}
public function needs_max()
{
return false;
}
public function needs_results()
{
return false;
}
public function is_allowed_to_change_name()
{
return false;
}
/**
* @return string
*/
public function get_icon_name()
{
return 'exercise';
}
/**
* @param bool $hp
*/
public function setHp($hp)
{
$this->hp = $hp;
}
public function getBestScore()
{
return $this->getStats('best');
}
public function getStats($type)
{
switch ($type) {
case 'best':
break;
}
}
/**
* Lazy load function to get the database contents of this exercise.
*/
public function get_exercise_data()
{
if (1 == $this->is_hp) {
$table = Database::get_course_table(TABLE_DOCUMENT);
} else {
$table = Database::get_course_table(TABLE_QUIZ_TEST);
}
$exerciseId = $this->get_ref_id();
if (empty($this->exercise_data)) {
if (1 == $this->is_hp) {
/*$sql = "SELECT * FROM $table ex
INNER JOIN $tableItemProperty ip
ON (ip.ref = ex.id AND ip.c_id = ex.c_id)
WHERE
ip.c_id = $this->course_id AND
ex.c_id = $this->course_id AND
ip.ref = $exerciseId AND
ip.tool = '".TOOL_DOCUMENT."' AND
ex.path LIKE '%htm%' AND
ex.path LIKE '%HotPotatoes_files%' AND
ip.visibility = 1";
$result = Database::query($sql);
$this->exercise_data = Database::fetch_array($result);*/
} else {
// Try with iid
$sql = 'SELECT * FROM '.$table.'
WHERE
iid = '.$exerciseId;
$result = Database::query($sql);
$rows = Database::num_rows($result);
if (!empty($rows)) {
$this->exercise_data = Database::fetch_array($result);
} else {
// Try wit id
$sql = 'SELECT * FROM '.$table.'
WHERE
c_id = '.$this->course_id.' AND
iid = '.$exerciseId;
$result = Database::query($sql);
$this->exercise_data = Database::fetch_array($result);
}
}
}
if (empty($this->exercise_data)) {
return false;
}
return $this->exercise_data;
}
/**
* Lazy load function to get the database table of the exercise.
*/
private function get_exercise_table()
{
$this->exercise_table = Database::get_course_table(TABLE_QUIZ_TEST);
return $this->exercise_table;
}
}