Merge pull request #662 from AngelFQC/BT9442

Certificates report for student boss role - refs BT#9442

main/gradebook/certificate_report.php

@@ -23,10 +23,23 @@ $interbreadcrumb[] = array(
 $selectedSession = isset($_POST['session']) && !empty($_POST['session']) ? intval($_POST['session']) : 0;
 $selectedCourse = isset($_POST['course']) && !empty($_POST['course']) ? intval($_POST['course']) : 0;
 $selectedMonth = isset($_POST['month']) && !empty($_POST['month']) ? intval($_POST['month']) : 0;
-$selectedYear = isset($_POST['year']) && !empty($_POST['year']) ? $_POST['year'] : null;
+$selectedYear = isset($_POST['year']) && !empty($_POST['year']) ? trim($_POST['year']) : null;
+$selectedStudent = isset($_POST['student']) && !empty($_POST['student']) ? intval($_POST['student']) : 0;
 
 $userId = api_get_user_id();
-$sessions = SessionManager::getSessionsCoachedByUser($userId);
+
+$sessions = $courses = $months = $students = [0 => get_lang('Select')];
+
+if (api_is_student_boss()) {
+    $userList = GroupPortalManager::getGroupUsersByUser($userId);
+    $sessionsList = SessionManager::getSessionsFollowedForGroupAdmin($userId);
+} else {
+    $sessionsList = SessionManager::getSessionsCoachedByUser($userId);
+}
+
+foreach ($sessionsList as $session) {
+    $sessions[$session['id']] = $session['name'];
+}
 
 if ($selectedSession > 0) {
     if (!SessionManager::isValidId($selectedSession)) {
@@ -36,32 +49,39 @@ if ($selectedSession > 0) {
         exit;
     }
 
-    $courses = SessionManager::get_course_list_by_session_id($selectedSession);
+    $coursesList = SessionManager::get_course_list_by_session_id($selectedSession);
 
-    if (is_array($courses)) {
-        foreach ($courses as &$course) {
+    if (is_array($coursesList)) {
+        foreach ($coursesList as &$course) {
             $course['real_id'] = $course['id'];
         }
     }
 } else {
-    $courses = CourseManager::get_courses_list_by_user_id($userId);
+    if (api_is_student_boss()) {
+        $coursesList = CourseManager::getCoursesFollowedByGroupAdmin($userId);
+    } else {
+        $coursesList = CourseManager::get_courses_list_by_user_id($userId);
 
-    if (is_array($courses)) {
-        foreach ($courses as &$course) {
-            $courseInfo = api_get_course_info_by_id($course['real_id']);
+        if (is_array($coursesList)) {
+            foreach ($coursesList as &$course) {
+                $courseInfo = api_get_course_info_by_id($course['real_id']);
 
-            $course = array_merge($course, $courseInfo);
+                $course = array_merge($course, $courseInfo);
+            }
         }
     }
 }
 
-$months = array();
+foreach ($coursesList as $course) {
+    if (isset($course['real_id'])) {
+        $courses[$course['real_id']] = $course['title'];
+    } else {
+        $courses[$course['id']] = $course['title'];
+    }
+}
 
 for ($key = 1; $key <= 12; $key++) {
-    $months[] = array(
-        'key' => $key,
-        'name' => sprintf("%02d", $key)
-    );
+    $months[$key] = sprintf("%02d", $key);
 }
 
 $exportAllLink = null;
@@ -69,6 +89,7 @@ $certificateStudents = array();
 
 $searchSessionAndCourse = $selectedSession > 0 && $selectedCourse > 0;
 $searchCourseOnly = $selectedSession <= 0 && $selectedCourse > 0;
+$searchStudentOnly = $selectedStudent > 0;
 
 if ($searchSessionAndCourse || $searchCourseOnly) {
     $selectedCourseInfo = api_get_course_info_by_id($selectedCourse);
@@ -98,14 +119,23 @@ if ($searchSessionAndCourse || $searchCourseOnly) {
             "cat_id" => $gradebook->get_id()
         ));
 
+        $sessionName = api_get_session_name($selectedSession);
+        $courseName = api_get_course_info($selectedCourseInfo['code'])['title'];
+
         $studentList = GradebookUtils::get_list_users_certificates($gradebook->get_id());
 
         $certificateStudents = array();
 
         if (is_array($studentList) && !empty($studentList)) {
             foreach ($studentList as $student) {
+                if (api_is_student_boss() && !in_array($student['user_id'], $userList)) {
+                    continue;
+                }
+
                 $certificateStudent = array(
                     'fullName' => api_get_person_name($student['firstname'], $student['lastname']),
+                    'sessionName' => $sessionName,
+                    'courseName' => $courseName,
                     'certificates' => array()
                 );
 
@@ -133,7 +163,7 @@ if ($searchSessionAndCourse || $searchCourseOnly) {
                             continue;
                         }
                     } elseif ($selectedMonth > 0 && !empty($selectedYear)) {
-                        if ($creationMonthYear != sprintf("%d %s", $selectedMonth, $selectedYear)) {
+                        if ($creationMonthYear != sprintf("%02d %s", $selectedMonth, $selectedYear)) {
                             continue;
                         }
                     }
@@ -144,6 +174,62 @@ if ($searchSessionAndCourse || $searchCourseOnly) {
                     );
                 }
 
+                if (count($certificateStudent['certificates']) > 0) {
+                    $certificateStudents[] = $certificateStudent;
+                }
+            }
+        }
+    }
+} elseif ($searchStudentOnly) {
+    $selectedStudentInfo = api_get_user_info($selectedStudent);
+
+    if (empty($selectedStudentInfo)) {
+        Session::write('reportErrorMessage', get_lang('NoUser'));
+
+        Header::location($selfUrl);
+    }
+
+    $sessionList = SessionManager::getSessionsFollowedByUser($selectedStudent);
+
+    foreach ($sessionList as $session) {
+        $sessionCourseList = SessionManager::get_course_list_by_session_id($session['id']);
+
+        foreach ($sessionCourseList as $sessionCourse) {
+            $gradebookCategories = Category::load(null, null, $sessionCourse['code'], null, false, $session['id']);
+
+            $gradebook = null;
+
+            if (!empty($gradebookCategories)) {
+                $gradebook = current($gradebookCategories);
+            }
+
+            if (!is_null($gradebook)) {
+                $sessionName = $session['name'];
+                $courseName = $sessionCourse['title'];
+
+                $certificateStudent = [
+                    'fullName' => $selectedStudentInfo['complete_name'],
+                    'sessionName' => $sessionName,
+                    'courseName' => $courseName,
+                    'certificates' => []
+                ];
+
+                $studentCertificates = GradebookUtils::get_list_gradebook_certificates_by_user_id(
+                    $selectedStudent,
+                    $gradebook->get_id()
+                );
+
+                if (!is_array($studentCertificates) || empty($studentCertificates)) {
+                    continue;
+                }
+
+                foreach ($studentCertificates as $certificate) {
+                    $certificateStudent['certificates'][] = array(
+                        'createdAt' => api_convert_and_format_date($certificate['created_at']),
+                        'id' => $certificate['id']
+                    );
+                }
+
                 if (count($certificateStudent['certificates']) > 0) {
                     $certificateStudents[] = $certificateStudent;
                 }
@@ -159,10 +245,54 @@ if (Session::has('reportErrorMessage')) {
     $template->assign('errorMessage', Session::read('reportErrorMessage'));
 }
 
-$template->assign('selectedSession', $selectedSession);
-$template->assign('selectedCourse', $selectedCourse);
-$template->assign('selectedMonth', $selectedMonth);
-$template->assign('selectedYear', $selectedYear);
+$searchBySessionCourseDateForm = new FormValidator(
+    'certificate_report_form',
+    'post',
+    api_get_path(WEB_CODE_PATH) . 'gradebook/certificate_report.php'
+);
+$searchBySessionCourseDateForm->addSelect('session', get_lang('Sessions'), $sessions, ['id' => 'session']);
+$searchBySessionCourseDateForm->addSelect('course', get_lang('Courses'), $courses, ['id' => 'course']);
+$searchBySessionCourseDateForm->addGroup(
+    [
+        $searchBySessionCourseDateForm->createElement('select', 'month', null, $months, ['id' => 'month']),
+        $searchBySessionCourseDateForm->createElement(
+            'text',
+            'year',
+            null,
+            ['id' => 'year', 'placeholder' => get_lang('Year')]
+        )
+    ],
+    null,
+    get_lang('Date')
+);
+$searchBySessionCourseDateForm->addButtonSearch();
+$searchBySessionCourseDateForm->setDefaults([
+    'session' => $selectedSession,
+    'course' => $selectedCourse,
+    'month' => $selectedMonth,
+    'year' => $selectedYear
+]);
+
+if (api_is_student_boss()) {
+    foreach ($userList as $studentId) {
+        $students[$studentId] = api_get_user_info($studentId)['complete_name_with_username'];
+    }
+
+    $searchByStudentForm = new FormValidator(
+        'certificate_report_form',
+        'post',
+        api_get_path(WEB_CODE_PATH) . 'gradebook/certificate_report.php'
+    );
+    $searchByStudentForm->addSelect('student', get_lang('Students'), $students, ['id' => 'student']);
+    $searchByStudentForm->addButtonSearch();
+    $searchByStudentForm->setDefaults([
+        'student' => $selectedStudent
+    ]);
+
+    $template->assign('searchByStudentForm', $searchByStudentForm->returnForm());
+}
+
+$template->assign('searchBySessionCourseDateForm', $searchBySessionCourseDateForm->returnForm());
 $template->assign('sessions', $sessions);
 $template->assign('courses', $courses);
 $template->assign('months', $months);

main/gradebook/gradebook_display_certificate.php

@@ -8,7 +8,9 @@
 require_once '../inc/global.inc.php';
 $current_course_tool  = TOOL_GRADEBOOK;
 
-api_protect_course_script();
+if (!api_is_student_boss()) {
+    api_protect_course_script();
+}
 
 set_time_limit(0);
 ini_set('max_execution_time', 0);
@@ -25,7 +27,7 @@ function confirmation() {
 </script>";
 api_block_anonymous_users();
 
-if (!api_is_allowed_to_edit()) {
+if (!api_is_allowed_to_edit() && !api_is_student_boss()) {
     api_not_allowed(true);
 }
 
@@ -36,10 +38,15 @@ $filterOfficialCodeGet = isset($_GET['filter']) ? Security::remove_XSS($_GET['fi
 
 switch ($action) {
     case 'export_all_certificates':
-        $userList = array();
-        if (!empty($filterOfficialCodeGet)) {
-            $userList = UserManager::getUsersByOfficialCode($filterOfficialCodeGet);
+        if (api_is_student_boss()) {
+            $userList = GroupPortalManager::getGroupUsersByUser(api_get_user_id());
+        } else {
+            $userList = array();
+            if (!empty($filterOfficialCodeGet)) {
+                $userList = UserManager::getUsersByOfficialCode($filterOfficialCodeGet);
+            }
         }
+
         Category::exportAllCertificates($cat_id, $userList);
         break;
     case 'generate_all_certificates':

main/inc/ajax/model.ajax.php

@@ -211,39 +211,10 @@ switch ($action) {
         }
 
         if ($searchByGroups) {
-            $groups = GroupPortalManager::get_groups_by_user(api_get_user_id(), GROUP_USER_PERMISSION_ADMIN);
-            $groupsId = array_keys($groups);
-            $subgroupsId = [];
-
-            if (is_array($groupsId)) {
-                foreach ($groupsId as $groupId) {
-                    $subgroupsId = array_merge(
-                        $subgroupsId,
-                        GroupPortalManager::getGroupsByDepthLevel($groupId)
-                    );
-                }
-
-                $groupsId = array_merge(
-                    $groupsId,
-                    $subgroupsId
-                );
-
-                foreach ($groupsId as $groupId) {
-                    $groupUsers = GroupPortalManager::get_users_by_group($groupId);
-
-                    if (!is_array($groupUsers)) {
-                        continue;
-                    }
-
-                    foreach ($groupUsers as $memberId => $member) {
-                        if ($member['user_id'] == $userId ) {
-                            continue;
-                        }
-
-                        $userIdList[] = intval($member['user_id']);
-                    }
-                }
-            }
+            $userIdList = array_merge(
+                $userIdList,
+                GroupPortalManager::getGroupUsersByUser(api_get_user_id())
+            );
         }
 
         if (is_array($userIdList)) {

main/inc/lib/course.lib.php

@@ -5682,4 +5682,56 @@ class CourseManager
         }
         return $courses;
     }
+
+    /**
+     * Get list of courses based on users of a group for a group admin
+     * @param int $userId The user id
+     * @return array
+     */
+    public static function getCoursesFollowedByGroupAdmin($userId)
+    {
+        $coursesList = [];
+
+        $courseTable = Database::get_main_table(TABLE_MAIN_COURSE);
+        $courseUserTable = Database::get_main_table(TABLE_MAIN_COURSE_USER);
+
+        $userIdList = GroupPortalManager::getGroupUsersByUser($userId);
+
+        if (empty($userIdList)) {
+            return [];
+        }
+
+        $sql = "SELECT DISTINCT(c.id), c.title "
+            . "FROM $courseTable c "
+            . "INNER JOIN $courseUserTable cru ON c.code = cru.course_code "
+            . "WHERE ( "
+            . "cru.user_id IN(" . implode(', ', $userIdList) . ") "
+            . "AND cru.relation_type = 0 "
+            . ")";
+
+        if (api_is_multiple_url_enabled()) {
+            $courseAccessUrlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
+            $accessUrlId = api_get_current_access_url_id();
+
+            if ($accessUrlId != -1) {
+                $sql = "SELECT DISTINCT(c.id), c.title "
+                    . "FROM $courseTable c "
+                    . "INNER JOIN $courseUserTable cru ON c.code = cru.course_code "
+                    . "INNER JOIN $courseAccessUrlTable crau ON c.code = crau.course_code "
+                    . "WHERE crau.access_url_id = $accessUrlId "
+                    . "AND ( "
+                    . "cru.id_user IN (" . implode(', ', $userIdList) . ") "
+                    . "AND cru.relation_type = 0 "
+                    . ")";
+            }
+        }
+
+        $result = Database::query($sql);
+
+        while ($row = Database::fetch_assoc($result)) {
+            $coursesList[] = $row;
+        }
+
+        return $coursesList;
+    }
 }

main/inc/lib/group_portal_manager.lib.php

@@ -1359,4 +1359,59 @@ class GroupPortalManager
         }
         return true;
     }
+
+    /**
+     * Get the group member list by a user and his group role
+     * @param int $userId The user ID
+     * @param int $relationType Optional. The relation type. GROUP_USER_PERMISSION_ADMIN by default
+     * @param boolean $includeSubgroupsUsers Optional. Whether include the users from subgroups
+     * @return array
+     */
+    public static function getGroupUsersByUser(
+        $userId,
+        $relationType = GROUP_USER_PERMISSION_ADMIN,
+        $includeSubgroupsUsers = true
+    )
+    {
+        $userId = intval($userId);
+
+        $groups = GroupPortalManager::get_groups_by_user($userId, $relationType);
+
+        $groupsId = array_keys($groups);
+        $subgroupsId = [];
+        $userIdList = [];
+
+        if ($includeSubgroupsUsers) {
+            foreach ($groupsId as $groupId) {
+                $subgroupsId = array_merge($subgroupsId, GroupPortalManager::getGroupsByDepthLevel($groupId));
+            }
+
+            $groupsId = array_merge($groupsId, $subgroupsId);
+        }
+
+        $groupsId = array_unique($groupsId);
+
+        if (empty($groupsId)) {
+            return [];
+        }
+
+        foreach ($groupsId as $groupId) {
+            $groupUsers = GroupPortalManager::get_users_by_group($groupId);
+
+            if (empty($groupUsers)) {
+                continue;
+            }
+
+            foreach ($groupUsers as $member) {
+                if ($member['user_id'] == $userId) {
+                    continue;
+                }
+
+                $userIdList[] = intval($member['user_id']);
+            }
+        }
+
+        return array_unique($userIdList);
+    }
+
 }

main/inc/lib/sessionmanager.lib.php

@@ -5952,4 +5952,56 @@ class SessionManager
 
         return false;
     }
+
+    /**
+     * Get list of sessions based on users of a group for a group admin
+     * @param int $userId The user id
+     * @return array
+     */
+    public static function getSessionsFollowedForGroupAdmin($userId)
+    {
+        $sessionList = array();
+
+        $sessionTable = Database::get_main_table(TABLE_MAIN_SESSION);
+        $sessionUserTable = Database::get_main_table(TABLE_MAIN_SESSION_USER);
+
+        $userIdList = GroupPortalManager::getGroupUsersByUser($userId);
+
+        if (empty($userIdList)) {
+            return [];
+        }
+
+        $sql = "SELECT DISTINCT s.* "
+            . "FROM $sessionTable s "
+            . "INNER JOIN $sessionUserTable sru ON s.id = sru.id_session "
+            . "WHERE ( "
+            . "sru.id_user IN (" . implode(', ', $userIdList) . ") "
+            . "AND sru.relation_type = 0"
+            . ")";
+
+        if (api_is_multiple_url_enabled()) {
+            $sessionAccessUrlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
+            $accessUrlId = api_get_current_access_url_id();
+
+            if ($accessUrlId != -1) {
+                $sql = "SELECT DISTINCT s.* "
+                    . "FROM $sessionTable s "
+                    . "INNER JOIN $sessionUserTable sru ON s.id = sru.id_session "
+                    . "INNER JOIN $sessionAccessUrlTable srau ON s.id = srau.session_id "
+                    . "WHERE srau.access_url_id = $accessUrlId "
+                    . "AND ( "
+                    . "sru.id_user IN (" . implode(', ', $userIdList) . ") "
+                    . "AND sru.relation_type = 0"
+                    . ")";
+            }
+        }
+
+        $result = Database::query($sql);
+
+        while ($row = Database::fetch_assoc($result)) {
+            $sessionList[] = $row;
+        }
+
+        return $sessionList;
+    }
 }

main/mySpace/company_reports.php

@@ -110,6 +110,15 @@ if (api_is_student_boss()) {
         Display::return_icon("statistics.png", get_lang("CompanyReport"), array(), ICON_SIZE_MEDIUM),
         "#"
     );
+    $actions .= Display::url(
+        Display::return_icon(
+            "certificate_list.png",
+            get_lang("GradebookSeeListOfStudentsCertificates"),
+            [],
+            ICON_SIZE_MEDIUM
+        ),
+        api_get_path(WEB_CODE_PATH) . "gradebook/certificate_report.php"
+    );
 }
 
 $content = '<div class="actions">';

main/mySpace/company_reports_resumed.php

@@ -99,6 +99,15 @@ if (api_is_student_boss()) {
         Display::return_icon("statistics.png", get_lang("CompanyReport"), array(), ICON_SIZE_MEDIUM),
         api_get_path(WEB_CODE_PATH) . "mySpace/company_reports.php"
     );
+    $actions .= Display::url(
+        Display::return_icon(
+            "certificate_list.png",
+            get_lang("GradebookSeeListOfStudentsCertificates"),
+            [],
+            ICON_SIZE_MEDIUM
+        ),
+        api_get_path(WEB_CODE_PATH) . "gradebook/certificate_report.php"
+    );
 }
 
 $content = '<div class="actions">';

main/mySpace/student.php

@@ -211,6 +211,15 @@ if (api_is_drh()) {
         Display::return_icon("statistics.png", get_lang("CompanyReport"), array(), ICON_SIZE_MEDIUM),
         api_get_path(WEB_CODE_PATH) . "mySpace/company_reports.php"
     );
+    $actions .= Display::url(
+        Display::return_icon(
+            "certificate_list.png",
+            get_lang("GradebookSeeListOfStudentsCertificates"),
+            [],
+            ICON_SIZE_MEDIUM
+        ),
+        api_get_path(WEB_CODE_PATH) . "gradebook/certificate_report.php"
+    );
 }
 
 $actions .= '<span style="float:right">';

main/template/default/gradebook/certificate_report.tpl

@@ -10,8 +10,6 @@
                 a: 'display_sessions_courses',
                 session: sessionId
             }, function (courseList) {
-                var $option = null;
-
                 $('<option>', {
                     value: 0,
                     text: "{{ 'Select' | get_lang }}"
@@ -30,63 +28,32 @@
     });
 </script>
 
-<form action="{{ _p.web_main }}gradebook/certificate_report.php" method="post" class="form-horizontal">
-    <div class="control-group">
-        <label class="control-label" for="session">{{ 'Sessions' | get_lang }}</label>
-        <div class="controls">
-            <select name="session" id="session">
-                <option value="0">{{ 'Select' | get_lang }}</option>
-                {% for session in sessions %}
-                    <option value="{{ session.id }}" {{ selectedSession == session.id ? 'selected' : '' }}>{{ session.name }}</option>
-                {% endfor %}
-            </select>
-        </div>
-    </div>
-    <div class="control-group">
-        <label class="control-label" for="course">{{ 'Courses' | get_lang }}</label>
-        <div class="controls">
-            <select name="course" id="course">
-                <option value="0">{{ 'Select' | get_lang }}</option>
-                {% for course in courses %}
-                    <option value="{{ course.real_id }}" {{ selectedCourse == course.real_id ? 'selected' : ''}}>{{ course.title }}</option>
-                {% endfor %}
-            </select>
-        </div>
-    </div>
-    <div class="control-group">
-        <label class="control-label" for="month">{{ 'Date' | get_lang }}</label>
-        <div class="controls">
-            <select name="month" id="month">
-                <option value="0">{{ 'Select' | get_lang }}</option>
-                {% for month in months %}
-                    <option value="{{ month.key }}" {{ selectedMonth == month.key ? 'selected' : ''}}>{{ month.name }}</option>
-                {% endfor %}
-            </select>
-            <input type="text" name="year" id="year" class="input-mini" value="{{ selectedYear }}">
-        </div>
-    </div>
-    <div class="control-group">
-        <div class="controls">
-            <button type="submit" class="btn btn-primary">{{ 'Search' | get_lang }}</button>
-        </div>
-    </div>
-</form>
+{{ searchBySessionCourseDateForm }}
+
+<hr>
 
-<h1 class="page-header">{{ 'GradebookListOfStudentsCertificates' | get_lang }}</h1>
+{{ searchByStudentForm }}
 
 {% if errorMessage is defined %}
     <div class="alert alert-error">{{ errorMessage }}</div>
 {% endif %}
 
 {% if not certificateStudents is empty %}
-    <p>
-        <a href="{{ exportAllLink }}" class="btn btn-info">{{ 'ExportAllCertificatesToPDF' | get_lang }}</a>
-    </p>
+    <h2 class="page-header">{{ "GradebookListOfStudentsCertificates" | get_lang }}</h2>
+    {% if not exportAllLink is null %}
+        <div class="actions">
+            <a href="{{ exportAllLink }}" class="btn btn-info">
+                <i class="fa fa-check"></i> {{ 'ExportAllCertificatesToPDF' | get_lang }}
+            </a>
+        </div>
+    {% endif %}
 
     <table class="table table-striped">
         <thead>
             <tr>
                 <th>{{ 'Student' | get_lang }}</th>
+                <th>{{ 'Sesion' | get_lang }}</th>
+                <th>{{ 'Course' | get_lang }}</th>
                 <th>{{ 'Date' | get_lang }}</th>
                 <th>{{ 'Certificate' | get_lang }}</th>
             </tr>
@@ -94,6 +61,8 @@
         <tfoot>
             <tr>
                 <th>{{ 'Student' | get_lang }}</th>
+                <th>{{ 'Sesion' | get_lang }}</th>
+                <th>{{ 'Course' | get_lang }}</th>
                 <th>{{ 'Date' | get_lang }}</th>
                 <th>{{ 'Certificate' | get_lang }}</th>
             </tr>
@@ -102,6 +71,8 @@
             {% for student in certificateStudents %}
                 <tr>
                     <td>{{ student.fullName }}</td>
+                    <td>{{ student.sessionName }}</td>
+                    <td>{{ student.courseName }}</td>
                     <td>
                         {% for certificate in student.certificates %}
                             <p>{{ certificate.createdAt }}</p>