chamilo/chamilo-lms

<?php
/**
 * This file is part of course block plugin for dashboard,
 * it should be required inside dashboard controller for showing it into dashboard interface from plattform.
 *
 * @author Christian Fasanando
 */
/**
 * This class is used like controller for this course block plugin,
 * the class name must be registered inside path.info file
 * (e.g: controller = "BlockCourse"), so dashboard controller will be instantiate it.
 */
class BlockCourse extends Block
{
    private $user_id;
    private $courses;
    private $permission = [DRH];

    /**
     * Constructor.
     */
    public function __construct($user_id)
    {
        $this->user_id = $user_id;
        $this->path = 'block_course';
        if ($this->is_block_visible_for_user($user_id)) {
            $this->courses = CourseManager::get_courses_followed_by_drh($user_id);
        }
    }

    /**
     * This method check if a user is allowed to see the block inside dashboard interface.
     *
     * @param int $user_id User id
     *
     * @return bool Is block visible for user
     */
    public function is_block_visible_for_user($user_id)
    {
        $user_info = api_get_user_info($user_id);
        $user_status = $user_info['status'];
        $is_block_visible_for_user = false;
        if (UserManager::is_admin($user_id) || in_array(
                $user_status,
                $this->permission
            )
        ) {
            $is_block_visible_for_user = true;
        }

        return $is_block_visible_for_user;
    }

    /**
     * This method return content html containing information
     * about courses and its position for showing it inside dashboard interface
     * it's important to use the name 'get_block' for beeing used from dashboard controller.
     *
     * @return array column and content html
     */
    public function get_block()
    {
        $column = 2;
        $data = [];
        $html = $this->getBlockCard(
            get_lang('Your courses'),
            $this->getContent()
        );
        $data['column'] = $column;
        $data['content_html'] = $html;

        return $data;
    }

    /**
     * This method return a content html, it's used inside get_block method for showing it inside dashboard interface.
     *
     * @return string content html
     */
    public function getContent()
    {
        $course_data = $this->get_course_information_data();
        $content = '';
        $data_table = null;
        if (!empty($course_data)) {
            $data_table .= '<table class="data_table" width:"95%">';
            $data_table .= '<tr>
                                <th>'.get_lang('Course title').'</th>
                                <th width="20%">'.get_lang('Learners').'</th>
                                <th width="20%">'.get_lang('Time').'</th>
                                <th width="20%">'.get_lang('Thematic advance').'</th>
                            </tr>';
            $i = 1;
            foreach ($course_data as $course) {
                if (0 == $i % 2) {
                    $class_tr = 'row_odd';
                } else {
                    $class_tr = 'row_even';
                }
                $data_table .= '<tr class="'.$class_tr.'">';
                if (!isset($course[2])) {
                    $course[2] = '0:00:00';
                }
                foreach ($course as $cell) {
                    $data_table .= '<td align="right">'.$cell.'</td>';
                }
                $data_table .= '</tr>';
                $i++;
            }
            $data_table .= '</table>';
        } else {
            $data_table .= get_lang('There is no available information about your courses');
        }
        $content .= $data_table;
        if (!empty($course_data)) {
            $content .= '<div style="text-align:right;margin-top:10px;">
            <a href="'.api_get_path(WEB_CODE_PATH).'my_space/course.php?follow">'.get_lang('See more').'</a></div>';
        }

        return $content;
    }

    /**
     * Get number of courses.
     *
     * @return int
     */
    public function get_number_of_courses()
    {
        return count($this->courses);
    }

    /**
     * Get course information data.
     *
     * @return array
     */
    public function get_course_information_data()
    {
        $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
        $course_data = [];
        $courses = $this->courses;
        $thematic = new Thematic();

        foreach ($courses as $row_course) {
            $course_code = $row_course['code'];
            $courseInfo = api_get_course_info($course_code);
            $courseId = $courseInfo['real_id'];
            $course = api_get_course_entity($courseId);
            $nb_students_in_course = $avg_progress_in_course = $avg_score_in_course = $avg_time_spent_in_course = $avg_score_in_exercise = 0;

            // students directly subscribed to the course
            $sql = "SELECT user_id FROM $tbl_course_user as course_rel_user
                    WHERE course_rel_user.status=".STUDENT." AND course_rel_user.c_id='$courseId'";
            $rs = Database::query($sql);
            $users = [];
            while ($row = Database::fetch_array($rs)) {
                $users[] = $row['user_id'];
            }
            if (count($users) > 0) {
                $nb_students_in_course = count($users);
                $avg_time_spent_in_course = api_time_to_hms(
                    Tracking::get_time_spent_on_the_course($users, $courseId) / $nb_students_in_course
                );
            } else {
                $avg_time_spent_in_course = null;
            }
            $tematic_advance = $thematic->get_total_average_of_thematic_advances(
                $course,
                null
            );

            if (!empty($tematic_advance)) {
                $tematic_advance_progress = '<a title="'.get_lang('GoToThematic advance').'" href="'.api_get_path(WEB_CODE_PATH).'course_progress/index.php?cidReq='.$course_code.'&action=thematic_details">'.$tematic_advance.'%</a>';
            } else {
                $tematic_advance_progress = '0%';
            }

            $table_row = [];
            $table_row[] = $row_course['title'];
            $table_row[] = $nb_students_in_course;
            $table_row[] = $avg_time_spent_in_course;
            $table_row[] = $tematic_advance_progress;
            $course_data[] = $table_row;
        }

        return $course_data;
    }
}