public/main/lp/learnpathList.class.php
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CLp;
/**
* Class LearnpathList
* This class is only a learning path list container with several practical methods for sorting the list and
* provide links to specific paths.
*
* @uses \Database.lib.php to use the database
* @uses \learnpath.class.php to generate learnpath objects to get in the list
*
* @author Yannick Warnier <ywarnier@beeznest.org>
*/
class LearnpathList
{
// Holds a flat list of learnpaths data from the database.
public $list = [];
// Holds a flat list of learnpaths sorted by alphabetical name order.
public $alpha_list = [];
public $course_code;
public $user_id;
/**
* This method is the constructor for the learnpathList. It gets a list of available learning paths from
* the database and creates the learnpath objects. This list depends on the user that is connected
* (only displays) items if he has enough permissions to view them.
*
* @param int $user_id
* @param array $courseInfo Optional course code (otherwise we use api_get_course_id())
* @param int $session_id Optional session id (otherwise we use api_get_session_id())
* @param string $order_by
* @param bool $check_publication_dates
* @param int $categoryId
* @param bool $ignoreCategoryFilter
* @param bool $ignoreLpVisibility get the list of LPs for reports
*/
public function __construct(
$user_id,
$courseInfo = [],
$session_id = 0,
$order_by = null,
$check_publication_dates = false,
$categoryId = null,
$ignoreCategoryFilter = false,
$ignoreLpVisibility = false
) {
if (empty($courseInfo)) {
$courseInfo = api_get_course_info();
}
$course_id = $courseInfo['real_id'];
$this->user_id = $user_id;
$repo = Container::getLpRepository();
$course = api_get_course_entity($course_id);
$session = api_get_session_entity($session_id);
$qb = $repo->getResourcesByCourse($course, $session, null, null, true, true);
if (!empty($order_by)) {
$qb->addOrderBy($order_by);
}
$now = api_get_utc_datetime();
if ($check_publication_dates) {
$qb->andWhere(
" (resource.publishedOn IS NOT NULL AND resource.publishedOn < '$now' AND resource.expiredOn IS NOT NULL AND resource.expiredOn > '$now') OR
(resource.publishedOn IS NOT NULL AND resource.publishedOn < '$now' AND resource.expiredOn IS NULL) OR
(resource.publishedOn IS NULL AND resource.expiredOn IS NOT NULL AND resource.expiredOn > '$now') OR
(resource.publishedOn IS NULL AND resource.expiredOn IS NULL) "
);
}
if (false == $ignoreCategoryFilter) {
if (!empty($categoryId)) {
$categoryId = (int) $categoryId;
$categoryFilter = " resource.category = $categoryId";
} else {
$categoryFilter = ' resource.category IS NULL ';
}
$qb->andWhere($categoryFilter);
}
/*$dql = "SELECT lp FROM ChamiloCourseBundle:CLp as lp
WHERE
$time_conditions
$condition_session
$categoryFilter
$order
";*/
//$learningPaths = Database::getManager()->createQuery($dql)->getResult();
$showBlockedPrerequisite = ('true' === api_get_setting('lp.show_prerequisite_as_blocked'));
$names = [];
$isAllowToEdit = api_is_allowed_to_edit();
$learningPaths = $qb->getQuery()->getResult();
$shortcutRepository = Container::getShortcutRepository();
/** @var CLp $lp */
foreach ($learningPaths as $lp) {
$pub = 'i';
$shortcut = $shortcutRepository->getShortcutFromResource($lp);
if ($shortcut) {
$pub = 'v';
}
/*if (Database::num_rows($res2) > 0) {
$lp2 = Database::fetch_array($res2);
$pub = $lp2['visibility'];
}*/
// Check if visible.
/*$visibility = api_get_item_visibility(
$courseInfo,
'learnpath',
$lp->getId(),
$session_id
);*/
$visibility = $lp->isVisible($course, $session);
// If option is not true then don't show invisible LP to user
if (false === $ignoreLpVisibility) {
if (true !== $showBlockedPrerequisite && !$isAllowToEdit) {
$lpVisibility = learnpath::is_lp_visible_for_student(
$lp,
$user_id,
$course
);
if (false === $lpVisibility) {
continue;
}
}
}
$link = $lp->getFirstResourceLink();
$resourceNode = $lp->getResourceNode();
$this->list[$lp->getIid()] = [
'lp_type' => $lp->getLpType(),
'lp_session' => $link && $link->getSession() ? (int) $link->getSession()->getId() : 0,
'lp_name' => stripslashes($lp->getTitle()),
'lp_desc' => stripslashes($lp->getDescription()),
'lp_path' => $lp->getPath(),
'lp_view_mode' => $lp->getDefaultViewMod(),
'lp_force_commit' => $lp->getForceCommit(),
'lp_maker' => stripslashes($lp->getContentMaker()),
'lp_proximity' => $lp->getContentLocal(),
'lp_encoding' => api_get_system_encoding(),
'lp_visibility' => $visibility,
'lp_published' => $pub,
'lp_prevent_reinit' => $lp->getPreventReinit(),
'seriousgame_mode' => $lp->getSeriousgameMode(),
'lp_scorm_debug' => $lp->getDebug(),
'autolaunch' => $lp->getAutolaunch(),
'created_on' => $lp->getCreatedOn() ? $lp->getCreatedOn()->format('Y-m-d H:i:s') : null,
'modified_on' => $lp->getModifiedOn() ? $lp->getModifiedOn()->format('Y-m-d H:i:s') : null,
'published_on' => $lp->getPublishedOn() ? $lp->getPublishedOn()->format('Y-m-d H:i:s') : null,
'expired_on' => $lp->getExpiredOn() ? $lp->getExpiredOn()->format('Y-m-d H:i:s') : null,
//'category_id' => $lp['category_id'],
'subscribe_users' => $lp->getSubscribeUsers(),
'lp_old_id' => $lp->getIid(),
'iid' => $lp->getIid(),
'prerequisite' => $lp->getPrerequisite(),
'entity' => $lp,
];
$names[$lp->getTitle()] = $lp->getIid();
}
//asort($names);
$this->alpha_list = $names;
}
/**
* Gets a table of the different learnpaths we have at the moment.
*
* @return array Learnpath info as [lp_id] => ([lp_type]=> ..., [lp_name]=>...,[lp_desc]=>...,[lp_path]=>...)
*/
public function get_flat_list()
{
return $this->list;
}
/**
* Gets a list of lessons of the given course_code and session_id
* This functions doesn't need user_id.
*
* @param string $course_code Text code of the course
* @param int $session_id Id of session
*
* @return array List of lessons with lessons id as keys
*/
public static function get_course_lessons($course_code, $session_id)
{
$table = Database::get_course_table(TABLE_LP_MAIN);
$course = api_get_course_info($course_code);
// @todo AND session_id = %s ?
$sql = "SELECT * FROM $table WHERE c_id = %s ";
$sql_query = sprintf($sql, $course['real_id']);
$result = Database::query($sql_query);
$lessons = [];
while ($row = Database::fetch_array($result)) {
if (api_get_item_visibility($course, 'learnpath', $row['id'], $session_id)) {
$lessons[$row['id']] = $row;
}
}
return $lessons;
}
}