lib.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/>.

/**
 * Library of functions of the townsquare block, that can be used moodle wide.
 *
 * @package block_townsquare
 * @copyright 2024 Tamaro Walter
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

// Color constants from bootstrap.
define('TOWNSQUARE_BASICLETTER_DEFAULTCOLOR', '#0f6cbf');
define('TOWNSQUARE_POSTLETTER_DEFAULTCOLOR', '#f7634d');
define('TOWNSQUARE_COMPLETIONLETTER_DEFAULTCOLOR', '#ca3120');
define('TOWNSQUARE_ORIENTATIONMARKER_DEFAULTCOLOR', '#6a737b');

/**
 * Gets the id of all courses where the current user is enrolled
 * @return array
 */
function townsquare_get_courses(): array {
    global $USER;

    $enrolledcourses = enrol_get_all_users_courses($USER->id, true);
    $courses = [];
    foreach ($enrolledcourses as $enrolledcourse) {
        $courses[] = $enrolledcourse->id;
    }

    return $courses;
}

/**
 * Function for subplugins to get the start time of the search.
 * @return int
 */
function townsquare_get_timestart(): int {
    return time() - 7884000;
}

/**
 * Function for subplugins to get the end time of the search.
 * @return int
 */
function townsquare_get_timeend(): int {
    return time() + 7884000;
}

/**
 * Merge sort function for townsquare events.
 * @param $events
 * @return array
 */
function townsquare_mergesort($events): array {
    $length = count($events);
    if ($length <= 1) {
        return $events;
    }
    $mid = (int) ($length / 2);
    $left = townsquare_mergesort(array_slice($events, 0, $mid));
    $right = townsquare_mergesort(array_slice($events, $mid));
    return townsquare_merge($left, $right);
}

/**
 * Function that sorts events in descending order by time created (newest event first)
 * @param array $left
 * @param array $right
 * @return array
 */
function townsquare_merge(array $left, array $right): array {
    $result = [];
    reset($left);
    reset($right);
    $numberofelements = count($left) + count($right);
    for ($i = 0; $i < $numberofelements; $i++) {
        if (current($left) && current($right)) {
            if (current($left)->timestart > current($right)->timestart) {
                $result[$i] = current($left);
                next($left);
            } else {
                $result[$i] = current($right);
                next($right);
            }
        } else if (current($left)) {
            $result[$i] = current($left);
            next($left);
        } else {
            $result[$i] = current($right);
            next($right);
        }
    }
    return $result;
}

// Filter functions.

/**
 * Filter that checks if the event needs to be filtered out for the current user because it is not available.
 * @param object $event event that is checked
 * @return bool true if the event needs to filtered out, false if not.
 */
function townsquare_filter_availability($event): bool {
    // If there is no restriction defined, the event is available.
    if ($event->availability == null) {
        return false;
    }

    // If there is a restriction, check if it applies to the user.
    $modinfo = get_fast_modinfo($event->courseid);
    $moduleinfo = $modinfo->get_cm($event->coursemoduleid);
    if ($moduleinfo->uservisible) {
        return false;
    }

    return true;
}

/**
 * Filter that checks if the event needs to be filtered out for the current user because it is already completed.
 * Applies to activity completion events.
 * @param object $coreevent coreevent that is checked
 * @return bool true if the event needs to filtered out, false if not.
 */
function townsquare_filter_activitycompletions($coreevent): bool {
    global $DB, $USER;
    if ($completionstatus = $DB->get_record('course_modules_completion',
        ['coursemoduleid' => $coreevent->coursemoduleid, 'userid' => $USER->id])) {
        if ($completionstatus->completionstate != 0) {
            return true;
        }
    }
    return false;
}