dashboard-intake.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Intake run history dashboard showing sync run statistics and chart.
 *
 * @package    local_psaelmsync
 * @copyright  2025 BC Public Service
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

// This file mixes HTML and PHP; disable the per-block docblock check.
// phpcs:disable moodle.Commenting.MissingDocblock

require_once('../../config.php');
require_login();

global $DB;

$context = context_system::instance();
require_capability('local/psaelmsync:viewlogs', $context);

$PAGE->set_url('/local/psaelmsync/dashboard-intake.php');
$PAGE->set_context($context);
$PAGE->set_title(
    get_string('pluginname', 'local_psaelmsync') . ' - '
    . get_string('intakerunhistory', 'local_psaelmsync')
);
$PAGE->set_heading(get_string('intakerunhistory', 'local_psaelmsync'));

echo $OUTPUT->header();

?>

<!-- Tabbed Navigation -->
<nav aria-label="PSA ELM Sync sections">
    <ul class="nav nav-tabs mb-3">
        <li class="nav-item">
            <a class="nav-link"
               href="/admin/settings.php?section=local_psaelmsync">
                Settings</a>
        </li>
        <li class="nav-item">
            <a class="nav-link"
               href="/local/psaelmsync/dashboard.php">
                Learner Dashboard</a>
        </li>
        <li class="nav-item">
            <a class="nav-link"
               href="/local/psaelmsync/dashboard-courses.php">
                Course Dashboard</a>
        </li>
        <li class="nav-item">
            <a class="nav-link active"
               href="/local/psaelmsync/dashboard-intake.php"
               aria-current="page">Intake Run Dashboard</a>
        </li>
        <li class="nav-item">
            <a class="nav-link"
               href="/local/psaelmsync/manual-intake.php">
                Manual Intake</a>
        </li>
        <li class="nav-item">
            <a class="nav-link"
               href="/local/psaelmsync/manual-complete.php">
                Manual Complete</a>
        </li>
        <li class="nav-item">
            <a class="nav-link"
               href="/local/psaelmsync/api-test.php">
                API Test</a>
        </li>
    </ul>
</nav>

<?php

// Setup pagination variables.
$perpage = optional_param('perpage', 100, PARAM_INT);
$page = optional_param('page', 0, PARAM_INT);
$offset = $page * $perpage;

// Get the total count of records.
$totalcount = $DB->count_records_select('local_psaelmsync_runs', '');

// Get the most recent records with pagination.
$sql = "SELECT * FROM {local_psaelmsync_runs} ORDER BY endtime DESC";
$lastruns = $DB->get_records_sql($sql, null, $offset, $perpage);

// Prepare data for Chart.js.
$chartdata = [
    'labels' => [],
    'enrolments' => [],
    'suspends' => [],
    'errors' => [],
];

foreach ($lastruns as $run) {
    $start = (int) ($run->starttime / 1000);
    $chartdata['labels'][] = date('Y-m-d H:i:s', $start);
    $chartdata['enrolments'][] = $run->enrolcount;
    $chartdata['suspends'][] = $run->suspendcount;
    $chartdata['errors'][] = $run->errorcount;
}

?>

<!-- Include Chart.js -->
<script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
<script>
document.addEventListener('DOMContentLoaded', function () {
    var ctx = document.getElementById('runsChart').getContext('2d');
    var chartData = <?php echo json_encode($chartdata, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT); ?>;

    new Chart(ctx, {
        type: 'line',
        data: {
            labels: chartData.labels,
            datasets: [
                {
                    label: 'Enrolments',
                    data: chartData.enrolments,
                    borderColor: 'rgba(75, 192, 192, 1)',
                    backgroundColor: 'rgba(75, 192, 192, 0.2)',
                    fill: true
                },
                {
                    label: 'Suspends',
                    data: chartData.suspends,
                    borderColor: 'rgba(255, 159, 64, 1)',
                    backgroundColor: 'rgba(255, 159, 64, 0.2)',
                    fill: true
                },
                {
                    label: 'Errors',
                    data: chartData.errors,
                    borderColor: 'rgba(255, 99, 132, 1)',
                    backgroundColor: 'rgba(255, 99, 132, 0.2)',
                    fill: true
                }
            ]
        },
        options: {
            responsive: true,
            maintainAspectRatio: false,
            title: {
                display: true,
                text: 'Recent Runs Overview'
            },
            scales: {
                xAxes: [{
                    type: 'time',
                    time: {
                        unit: 'minute'
                    },
                    scaleLabel: {
                        display: true,
                        labelString: 'Time'
                    }
                }],
                yAxes: [{
                    scaleLabel: {
                        display: true,
                        labelString: 'Count'
                    },
                    ticks: {
                        beginAtZero: true
                    }
                }]
            }
        }
    });
});
</script>
<?php
$sql = "SELECT
            SUM(enrolcount) AS total_enrols,
            SUM(suspendcount) AS total_suspends,
            SUM(errorcount) AS total_errors
        FROM {local_psaelmsync_runs}";
$totals = $DB->get_record_sql($sql);
?>

<style>
.stat-card {
    background: #f8f9fa;
    border-radius: 0.5rem;
    padding: 1.25rem;
    text-align: center;
    border-left: 4px solid;
}
.stat-card.enrols {
    border-left-color: rgba(75, 192, 192, 1);
}
.stat-card.suspends {
    border-left-color: rgba(255, 159, 64, 1);
}
.stat-card.errors {
    border-left-color: rgba(255, 99, 132, 1);
}
.stat-card .stat-value {
    font-size: 2rem;
    font-weight: bold;
    line-height: 1.2;
}
.stat-card .stat-label {
    font-size: 0.85rem;
    color: #6c757d;
    text-transform: uppercase;
    letter-spacing: 0.05em;
}
.stat-card.enrols .stat-value {
    color: rgba(75, 192, 192, 1);
}
.stat-card.suspends .stat-value {
    color: rgba(255, 159, 64, 1);
}
.stat-card.errors .stat-value {
    color: rgba(255, 99, 132, 1);
}
.sync-info-details {
    margin-top: 1rem;
    margin-bottom: 1rem;
}
.sync-info-details summary {
    cursor: pointer;
    padding: 0.5rem;
    background: #f8f9fa;
    border-radius: 0.25rem;
    font-weight: 500;
}
.sync-info-details[open] summary {
    margin-bottom: 0.5rem;
}
.sync-info-details .info-content {
    padding: 0.75rem;
    background: #fff;
    border: 1px solid #dee2e6;
    border-radius: 0.25rem;
    font-size: 0.9rem;
}
.sr-only {
    position: absolute;
    width: 1px;
    height: 1px;
    padding: 0;
    margin: -1px;
    overflow: hidden;
    clip: rect(0, 0, 0, 0);
    white-space: nowrap;
    border: 0;
}
</style>

<!-- Stats Cards -->
<div class="row mb-3">
    <div class="col-md-4">
        <div class="stat-card enrols">
            <div class="stat-value">
                <?php echo number_format($totals->total_enrols ?? 0); ?>
            </div>
            <div class="stat-label">Total Enrolments</div>
        </div>
    </div>
    <div class="col-md-4">
        <div class="stat-card suspends">
            <div class="stat-value">
                <?php echo number_format($totals->total_suspends ?? 0); ?>
            </div>
            <div class="stat-label">Total Suspends</div>
        </div>
    </div>
    <div class="col-md-4">
        <div class="stat-card errors">
            <div class="stat-value">
                <?php echo number_format($totals->total_errors ?? 0); ?>
            </div>
            <div class="stat-label">Total Errors</div>
        </div>
    </div>
</div>
<p class="text-muted text-center"
   style="margin-top: -0.5rem; font-size: 0.85rem;">
    Since Sept. 4, 2024</p>

<!-- Sync Info -->
<details class="sync-info-details">
    <summary>Sync Info</summary>
    <div class="info-content">
        <p class="mb-2">The cron job for intake (from CData)
            happens every 5 minutes, starting on the 2nd minute
            of the hour, (ELM posts to CData every 5 minutes
            on the 0) between the hours of 06:00 and 18:00;<br>
            <pre>2,7,12,17,22,27,32,37,42,47,52,57</pre>
        </p>
    </div>
</details>

<div class="row mb-2">
    <div class="col-md-12">
        <figure role="figure" aria-labelledby="chart-description">
            <div style="height: 320px;">
                <canvas id="runsChart" aria-hidden="true"></canvas>
            </div>
            <figcaption id="chart-description" class="sr-only">
                Line chart showing enrollment, suspension, and
                error counts over time for recent sync runs.
                The same data is available in the table below.
            </figcaption>
        </figure>

        <!-- Results Table -->
        <table class="table table-striped table-bordered mt-4">
            <caption class="sr-only">
                Intake run history showing date, enrolments,
                drops, errors, and skipped counts for each
                sync run
            </caption>
            <thead>
                <tr>
                    <th scope="col">Date and Time</th>
                    <th scope="col">Enrolments</th>
                    <th scope="col">Drops</th>
                    <th scope="col">Errors</th>
                    <th scope="col">Skipped</th>
                </tr>
            </thead>
            <tbody>
            <?php foreach ($lastruns as $run) : ?>
                <?php
                $starttime = (int) ($run->starttime / 1000);
                $endtime = (int) ($run->endtime / 1000);
                $searchdate = urlencode(
                    date('Y-m-d H:i:s', $starttime)
                );
                $startlabel = date('Y-m-d H:i:s', $starttime);
                $endlabel = date('H:i:s', $endtime);
                ?>
            <tr>
                <td>
                    <a href="/local/psaelmsync/dashboard.php?search=<?php
                        echo $searchdate; ?>">
                        <?php echo $startlabel; ?> -
                        <?php echo $endlabel; ?>
                    </a>
                </td>
                <td><?php echo $run->enrolcount; ?></td>
                <td><?php echo $run->suspendcount; ?></td>
                <td><?php echo $run->errorcount; ?></td>
                <td><?php echo $run->skippedcount; ?></td>
            </tr>
            <?php endforeach; ?>
            </tbody>
        </table>

        <!-- Pagination controls -->
        <?php
        echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $PAGE->url);
        ?>
    </div>
</div>

<?php
echo $OUTPUT->footer();