smtech / advisor-dashboard

js/relative-grades.js.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 3 and the first side effect is on line 4.

define('IGNORE_LTI', true);
require_once __DIR__ . '/../course/common.inc.php';

// http://paletton.com/#uid=33s0u0koA++cP+Mj9+Yus+WMOZA
define('TRANSPARENT', 'rgba(0, 0, 0, 0)');
define('HIGH_STROKE', '#6ed0ff'); // less light blue
define('HIGH_FILL', TRANSPARENT);
define('THIRD_QUARTILE_STROKE', TRANSPARENT);
define('THIRD_QUARTILE_FILL', '#9ddffe'); // light blue
define('MEDIAN_STROKE', '#fff'); // white
define('MEDIAN_FILL', THIRD_QUARTILE_FILL);
define('FIRST_QUARTILE_STROKE', TRANSPARENT);
define('FIRST_QUARTILE_FILL', '#ffe399'); // light yellow
define('LOW_STROKE', '#ff3f0c'); // medium red
define('LOW_FILL', '#fff'); // white
define('SCORE_STROKE', '#000'); // black
define('SCORE_FILL', TRANSPARENT);


$points = 0;
function normalize($numerator, $denominator = false)
{
    global $points;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

    if ($numerator === null) {
        return null;
    }
    $denominator = ($denominator !== false ? $denominator : $points);
    $points = $denominator;
    return ($denominator > 0 ? min(100, $numerator / $denominator * 100) : 100);
}

header('Content-Type: application/javascript');

$toolbox->cache_pushKey(basename(__FILE__, '.js.php'));
$toolbox->cache_pushKey($_REQUEST['advisee']);

$analytics = $toolbox->cache_get('analytics');
if ($analytics === false) {
    exit;
}

?>

Chart.defaults.global.showTooltips = false;
Chart.defaults.global.scaleShowLabels = false;
Chart.defaults.global.scaleBeginAtZero = true;

<?php foreach ($analytics as $course => $analytic) : ?>

    <?php

    $labels = array();
    $max_scores = array();
    $min_scores = array();
    $medians = array();
    $first_quartiles = array();
    $third_quartiles = array();
    $scores = array();
    foreach ($analytic as $data) {
        // if ($data['points_possible'] > 0 && $data['max_score'] > 0) {

58% of this comment could be valid code. Did you maybe forget this after debugging?

            $labels[] = addslashes($data['title']);
            $max_scores[] = normalize($data['max_score'], $data['points_possible']);
            $min_scores[] = normalize($data['min_score']);
            $medians[] = normalize($data['median']);
            $first_quartiles[] = normalize($data['first_quartile']);
            $third_quartiles[] = normalize($data['third_quartile']);
            if (empty($data['submission'])) {
                $scores[] = '""'; /* some assignments may not have grades */
            } else {
                $scores[] = normalize($data['submission']['score']);
            }
        // }
    }

    ?>

    var data = {
        labels: [<?= '"' . implode('", "', $labels) . '"' ?>],
        datasets: [
            {
                label: "Score",
                backgroundColor: "<?= SCORE_FILL ?>",
                borderColor: "<?= SCORE_STROKE ?>",
                data: [<?= implode(', ', $scores) ?>]
            },
            {
                label: "Low Score",
                backgroundColor: "<?= LOW_FILL ?>",
                borderColor: "<?= LOW_STROKE ?>",
                borderWidth: 1,
                radius: 0,
                tooltips: {enabled: false},
                data: [<?= implode(', ', $min_scores) ?>]
            },
            {
                label: "First Quartile",
                backgroundColor: "<?= FIRST_QUARTILE_FILL ?>",
                borderColor: "<?= FIRST_QUARTILE_STROKE ?>",
                borderWidth: 0,
                radius: 0,
                tooltips: {enabled: false},
                data: [<?= implode(', ', $first_quartiles) ?>]
            },
            {
                label: "Median",
                backgroundColor: "<?= MEDIAN_FILL ?>",
                borderColor: "<?= MEDIAN_STROKE ?>",
                borderWidth: 1,
                radius: 0,
                tooltips: {enabled: false},
                data: [<?= implode(', ', $medians) ?>]
            },
            {
                label: "Third Quartile",
                backgroundColor: "<?= THIRD_QUARTILE_FILL ?>",
                borderColor: "<?= THIRD_QUARTILE_STROKE ?>",
                borderWidth: 0,
                radius: 0,
                tooltips: {enabled: false},
                data: [<?= implode(', ', $third_quartiles) ?>]
            },
            {
                label: "High Score",
                backgroundColor: "<?= HIGH_FILL ?>",
                borderColor: "<?= HIGH_STROKE ?>",
                borderWidth: 1,
                radius: 0,
                tooltips: {enabled: false},
                data: [<?= implode(', ', $max_scores) ?>]
            }
        ]
    };

    var options = {
        pointDot: false,
        scaleShowGridLines: false
    };

    // Get context with jQuery - using jQuery's .get() method.
    var ctx = $("#course_<?= $course ?>").get(0).getContext("2d");

    // TODO detect empty datasets and remove canvas and replace with message

    // This will get the first returned node in the jQuery collection.
    var chart = new Chart(ctx, {
        type: 'line',
        data: data,
        options: options
    });

<?php endforeach; ?>