public/main/gradebook/lib/be/abstractlink.class.php
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\GradebookCategory;
use Chamilo\CoreBundle\Entity\GradebookLink;
/**
* Class AbstractLink
* Defines a gradebook AbstractLink object.
* To implement specific links,
* extend this class and define a type in LinkFactory.
* Use the methods in LinkFactory to create link objects.
*
* @author Bert Steppé
* @author Julio Montoya <gugli100@gmail.com> security improvements
*/
abstract class AbstractLink implements GradebookItem
{
public $course_id;
public $studentList;
/** @var GradebookLink */
public $entity;
protected $id;
protected $type;
protected $ref_id;
protected $user_id;
protected $course_code;
/** @var Category */
protected $category;
protected $created_at;
protected $weight;
protected $visible;
protected $session_id;
/**
* Constructor.
*/
public function __construct()
{
$this->course_id = api_get_course_int_id();
}
/**
* @return bool
*/
abstract public function has_results();
/**
* @return string
*/
abstract public function get_link();
/**
* @return bool
*/
abstract public function is_valid_link();
/**
* @return string
*/
abstract public function get_type_name();
/**
* @return bool
*/
abstract public function needs_name_and_description();
/**
* @return bool
*/
abstract public function needs_max();
/**
* @return bool
*/
abstract public function needs_results();
/**
* @return bool
*/
abstract public function is_allowed_to_change_name();
/**
* @return int
*/
public function get_id()
{
return $this->id;
}
/**
* @return string
*/
public function get_type()
{
return $this->type;
}
/**
* @return int
*/
public function get_ref_id()
{
return (int) $this->ref_id;
}
/**
* @return int
*/
public function get_session_id()
{
return (int) $this->session_id;
}
/**
* @return int
*/
public function get_user_id()
{
return $this->user_id;
}
/**
* @return string
*/
public function get_course_code()
{
return $this->course_code;
}
/**
* @return Category
*/
public function getCategory()
{
return $this->category;
}
/**
* @param Category $category
*/
public function setCategory($category)
{
$this->category = $category;
}
/**
* @return int
*/
public function get_category_id()
{
return $this->category->get_id();
}
/**
* @param int $category_id
*/
public function set_category_id($category_id)
{
$categories = Category::load($category_id);
if (isset($categories[0])) {
$this->setCategory($categories[0]);
}
}
public function get_date()
{
return $this->created_at;
}
public function get_weight()
{
return $this->weight;
}
public function is_locked()
{
return isset($this->locked) && 1 == $this->locked ? true : false;
}
public function is_visible()
{
return $this->visible;
}
public function set_id($id)
{
$this->id = $id;
}
public function set_type($type)
{
$this->type = $type;
}
public function set_ref_id($ref_id)
{
$this->ref_id = $ref_id;
}
public function set_user_id($user_id)
{
$this->user_id = $user_id;
}
/**
* Set course ID and course code. If ID is empty, set both to null
* @param ?int $courseId
*/
public function setCourseId(?int $courseId = null): AbstractLink {
$courseInfo = api_get_course_info_by_id($courseId);
if (!empty($courseInfo)) {
$this->course_code = $courseInfo['code'];
$this->course_id = $courseId;
} else {
$this->course_code = null;
$this->course_id = null;
}
return $this;
}
/**
* @return array
*/
public function getStudentList()
{
if (empty($this->studentList)) {
return [];
}
return $this->studentList;
}
/**
* @param array $list
*/
public function setStudentList($list)
{
$this->studentList = $list;
}
public function set_date($date)
{
$this->created_at = $date;
}
public function set_weight($weight)
{
$this->weight = $weight;
}
public function set_visible($visible)
{
$this->visible = $visible;
}
/**
* @param int $id
*/
public function set_session_id($id)
{
$this->session_id = $id;
}
/**
* @param $locked
*/
public function set_locked($locked)
{
$this->locked = $locked;
}
/**
* @return int
*/
public function getCourseId()
{
return (int) $this->course_id;
}
/**
* Retrieve links and return them as an array of extensions of AbstractLink.
* To keep consistency, do not call this method but LinkFactory::load instead.
*
* @param int $id
* @param int $type
* @param int $ref_id
* @param int $user_id
* @param ?int $courseId
* @param int $category_id
* @param int $visible
*
* @return array
*/
public static function load(
$id = null,
$type = null,
$ref_id = null,
$user_id = null,
?int $courseId = null,
$category_id = null,
$visible = null
) {
$tbl_grade_links = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
$sql = 'SELECT * FROM '.$tbl_grade_links;
$paramcount = 0;
if (isset($id)) {
$sql .= ' WHERE id = '.intval($id);
$paramcount++;
}
if (isset($type)) {
if (0 != $paramcount) {
$sql .= ' AND';
} else {
$sql .= ' WHERE';
}
$sql .= ' type = '.intval($type);
$paramcount++;
}
if (isset($ref_id)) {
if (0 != $paramcount) {
$sql .= ' AND';
} else {
$sql .= ' WHERE';
}
$sql .= ' ref_id = '.intval($ref_id);
$paramcount++;
}
if (isset($user_id)) {
if (0 != $paramcount) {
$sql .= ' AND';
} else {
$sql .= ' WHERE';
}
$sql .= ' user_id = '.intval($user_id);
$paramcount++;
}
if (!empty($courseId)) {
if (0 != $paramcount) {
$sql .= ' AND';
} else {
$sql .= ' WHERE';
}
$sql .= " c_id = $courseId";
$paramcount++;
}
if (isset($category_id)) {
if (0 != $paramcount) {
$sql .= ' AND';
} else {
$sql .= ' WHERE';
}
$sql .= ' category_id = '.intval($category_id);
$paramcount++;
}
if (isset($visible)) {
if (0 != $paramcount) {
$sql .= ' AND';
} else {
$sql .= ' WHERE';
}
$sql .= ' visible = '.intval($visible);
}
$result = Database::query($sql);
$links = self::create_objects_from_sql_result($result);
return $links;
}
/**
* Insert this link into the database.
* @return int 0 on error, or the link's database id
* @throws Exception
*/
public function add(): int
{
$this->add_linked_data();
if (!empty($this->type) &&
!empty($this->ref_id) &&
!empty($this->course_id) &&
!empty($this->category)
) {
$table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
$sql = "SELECT count(*) count FROM $table
WHERE
ref_id = ".$this->get_ref_id()." AND
category_id = ".$this->category->get_id()." AND
c_id = '".$this->course_id."' AND
type = ".$this->type." ";
$result = Database::query($sql);
$row = Database::fetch_assoc($result);
if (0 == $row['count']) {
$em = Database::getManager();
$category = null;
if (!empty($this->get_category_id())) {
$category = $em->getRepository(GradebookCategory::class)->find($this->get_category_id());
}
$link = new GradebookLink();
$link
->setType($this->get_type())
->setVisible($this->is_visible())
->setWeight(api_float_val($this->get_weight()))
->setRefId($this->get_ref_id())
->setCategory($category)
->setCourse(api_get_course_entity($this->course_id))
;
$em->persist($link);
$em->flush();
$this->set_id($link->getId());
Event::addEvent(
'gradebook_link_created',
'link',
$link->getId(),
null,
api_get_user_id(),
$this->course_id
);
return $link->getId();
}
}
return 0;
}
/**
* Update the properties of this link in the database.
*/
public function save()
{
$em = Database::getManager();
$link = $em->find(GradebookLink::class, $this->id);
if (!$link) {
return;
}
self::add_link_log($this->id);
$this->save_linked_data();
$course = api_get_course_entity($this->getCourseId());
$category = null;
if (!empty($this->get_category_id())) {
$category = $em->getRepository(GradebookCategory::class)->find($this->get_category_id());
}
$link
->setType($this->get_type())
->setRefId($this->get_ref_id())
->setCourse($course)
->setCategory($category)
->setWeight($this->get_weight())
->setVisible($this->is_visible())
;
$em->persist($link);
$em->flush();
}
/**
* @param int $evaluationId
*/
public static function add_link_log($evaluationId, $nameLog = null)
{
$table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINKEVAL_LOG);
$dateobject = self::load($evaluationId, null, null, null, null);
$now = api_get_utc_datetime();
$arreval = get_object_vars($dateobject[0]);
$description_log = isset($arreval['description']) ? $arreval['description'] : '';
if (empty($nameLog)) {
if (isset($_POST['name_link'])) {
$name_log = isset($_POST['name_link']) ? $_POST['name_link'] : $arreval['course_id'];
} elseif (isset($_POST['link_'.$evaluationId]) && $_POST['link_'.$evaluationId]) {
$name_log = $_POST['link_'.$evaluationId];
} else {
$name_log = $arreval['course_id'];
}
} else {
$name_log = $nameLog;
}
$params = [
'id_linkeval_log' => $arreval['id'],
'title' => $name_log,
'description' => $description_log,
'created_at' => $now,
'weight' => $arreval['weight'],
'visible' => $arreval['visible'],
'type' => 'Link',
'user_id_log' => api_get_user_id(),
];
Database::insert($table, $params);
}
/**
* Delete this link from the database.
*/
public function delete()
{
$this->delete_linked_data();
$table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
$sql = 'DELETE FROM '.$table.'
WHERE id = '.intval($this->id);
Database::query($sql);
}
/**
* Generate an array of possible categories where this link can be moved to.
* Notice: its own parent will be included in the list: it's up to the frontend
* to disable this element.
*
* @return array 2-dimensional array - every element contains 3 subelements (id, name, level)
*/
public function get_target_categories()
{
// links can only be moved to categories inside this course
$targets = [];
$level = 0;
$categories = Category::load(null, null, $this->course_id, 0);
foreach ($categories as $cat) {
$targets[] = [$cat->get_id(), $cat->get_name(), $level + 1];
$targets = $this->addTargetSubcategories(
$targets,
$level + 1,
$cat->get_id()
);
}
return $targets;
}
/**
* Move this link to the given category.
* If this link moves to outside a course, delete it.
*/
public function move_to_cat(GradebookCategory $cat)
{
if ($this->getCourseId() != $cat->getCourse()->getId()) {
$this->delete();
} else {
$this->set_category_id($cat->getId());
$this->save();
}
}
/**
* Find links by name
* To keep consistency, do not call this method but LinkFactory::find_links instead.
*
* @todo can be written more efficiently using a new (but very complex) sql query
*
* @param string $name_mask
*
* @return array
*/
public static function find_links($name_mask, $selectcat)
{
$rootcat = Category::load($selectcat);
$links = $rootcat[0]->get_links((api_is_allowed_to_edit() ? null : api_get_user_id()), true);
$foundlinks = [];
foreach ($links as $link) {
if (!(false === api_strpos(api_strtolower($link->get_name()), api_strtolower($name_mask)))) {
$foundlinks[] = $link;
}
}
return $foundlinks;
}
/**
* @return string
*/
public function get_item_type()
{
return 'L';
}
/**
* @return string
*/
public function get_icon_name()
{
return 'link';
}
public function get_all_links()
{
return [];
}
public function add_linked_data()
{
}
public function save_linked_data()
{
}
public function delete_linked_data()
{
}
/**
* @param string $name
*/
public function set_name($name)
{
}
/**
* @param string $description
*/
public function set_description($description)
{
}
/**
* @param int $max
*/
public function set_max($max)
{
}
public function get_view_url($stud_id)
{
return null;
}
/**
* Locks a link.
*
* @param int $locked 1 or unlocked 0
*
* */
public function lock($locked)
{
$table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
$sql = "UPDATE $table SET locked = '".intval($locked)."'
WHERE id='".$this->id."'";
Database::query($sql);
}
/**
* Get current user ranking.
*
* @param int $userId
* @param array $studentList Array with user id and scores
* Example: [1 => 5.00, 2 => 8.00]
*
* @return array
*/
public static function getCurrentUserRanking($userId, $studentList)
{
$ranking = null;
$currentUserId = $userId;
if (!empty($studentList) && !empty($currentUserId)) {
$studentList = array_map('floatval', $studentList);
asort($studentList);
$ranking = $count = count($studentList);
foreach ($studentList as $userId => $position) {
if ($currentUserId == $userId) {
break;
}
$ranking--;
}
// If no ranking was detected.
if (0 == $ranking) {
return [];
}
return [$ranking, $count];
}
return [];
}
/**
* @return string
*/
public function getSkillsFromItem()
{
$toolType = '';
switch ($this->type) {
case LINK_ATTENDANCE:
$toolType = ITEM_TYPE_ATTENDANCE;
break;
case LINK_EXERCISE:
$toolType = ITEM_TYPE_EXERCISE;
break;
case LINK_FORUM_THREAD:
$toolType = ITEM_TYPE_FORUM_THREAD;
break;
case LINK_LEARNPATH:
$toolType = ITEM_TYPE_LEARNPATH;
break;
case LINK_HOTPOTATOES:
$toolType = ITEM_TYPE_HOTPOTATOES;
break;
case LINK_STUDENTPUBLICATION:
$toolType = ITEM_TYPE_STUDENT_PUBLICATION;
break;
case LINK_SURVEY:
$toolType = ITEM_TYPE_SURVEY;
break;
}
$skillToString = SkillModel::getSkillRelItemsToString($toolType, $this->get_ref_id());
return $skillToString;
}
/**
* @param int $itemId
* @param int $linkType
* @param int $courseId
* @param int $sessionId
*
* @return array
* @throws Exception
*/
public static function getGradebookLinksFromItem(
int $itemId,
int $linkType,
int $courseId,
?int $sessionId = 0
): array
{
if (empty($courseId) || empty($itemId) || empty($linkType)) {
return false;
}
$table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
$tableCategory = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY);
$sessionId = (int) $sessionId;
$sessionCondition = api_get_session_condition($sessionId, true, false, 'c.session_id');
$sql = "SELECT DISTINCT l.*
FROM $table l INNER JOIN $tableCategory c
ON (c.c_id = l.c_id AND c.id = l.category_id)
WHERE
ref_id = $itemId AND
type = $linkType AND
l.c_id = $courseId
$sessionCondition ";
$result = Database::query($sql);
if (Database::num_rows($result)) {
return Database::store_result($result);
}
return [];
}
private static function create_objects_from_sql_result(\Doctrine\DBAL\Result $result): array
{
$links = [];
$allow = ('true' === api_get_setting('gradebook.allow_gradebook_stats'));
if ($allow) {
$em = Database::getManager();
$repo = $em->getRepository(GradebookLink::class);
}
while ($data = Database::fetch_array($result)) {
$link = LinkFactory::create($data['type']);
$link->set_id($data['id']);
$link->set_type($data['type']);
$link->set_ref_id($data['ref_id']);
$link->setCourseId($data['c_id']);
$link->set_category_id($data['category_id']);
$link->set_date($data['created_at']);
$link->set_weight($data['weight']);
$link->set_visible($data['visible']);
$link->set_locked($data['locked']);
//session id should depend on the category --> $data['category_id']
$session_id = api_get_session_id();
$link->set_session_id($session_id);
if ($allow) {
$link->entity = $repo->find($data['id']);
}
$links[] = $link;
}
return $links;
}
/**
* Internal function used by get_target_categories().
*
* @param array $targets
* @param int $level
* @param int $catid
*
* @return array
*/
private function addTargetSubcategories($targets, $level, $catid)
{
$subcats = Category::load(null, null, 0, $catid);
foreach ($subcats as $cat) {
$targets[] = [$cat->get_id(), $cat->get_name(), $level + 1];
$targets = $this->addTargetSubcategories(
$targets,
$level + 1,
$cat->get_id()
);
}
return $targets;
}
}