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

/**
 * Informations block locallib
 *
 * @package    block_informations
 * @copyright  2024 Fondation UNIT
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die;


/**
 * Create a new licence record.
 *
 * @param  object $licence
 * @return resource|moodle_exception The block's configure URL
 */
function block_informations_add_licence($licence) {
    global $DB;

    if ($licence->licencename && $licence->licenceurl && $licence->licenceimage) {
        $id = $DB->insert_record('block_informations_licences', $licence);
        if ($id) {
            $url = new moodle_url('/blocks/informations/configure.php');
            redirect($url);
        }
    }
    throw new moodle_exception('errorinsertingrecord', 'block_informations');
}

/**
 * Get all the configured licences.
 *
 * @return array of licences
 */
function block_informations_get_all_licences() {
    global $DB;

    $licences = $DB->get_records('block_informations_licences');
    $items = array();
    foreach ($licences as $licence) {
        $licence->categoryname = null;
        if ($licence->categoryid > 0) {
            $category = \core_course_category::get($licence->categoryid);
            $licence->categoryname = $category->name;
        }
        array_push($items, (array) $licence);
    }
    return $items;
}

/**
 * Delete a licence.
 *
 * @param  int $itemid
 * @return resource|moodle_exception The block's configure URL
 */
function block_informations_delete_licence($itemid) {
    global $DB;

    $params = ['id' => $itemid];
    if ($DB->delete_records('block_informations_licences', $params)) {
        $redirecto = new moodle_url('/blocks/informations/configure.php');
        redirect($redirecto);
    }
    throw new moodle_exception('errordeletingrecord', 'block_informations');
}

/**
 * Get the names of the available licences.
 *
 * @return array of licences names
 */
function block_informations_get_licences_names() {
    global $DB;

    $licences = $DB->get_records('block_informations_licences');
    $items = [];
    foreach ($licences as $licence) {
        $items[$licence->id] = $licence->licencename;
    }
    return $items;
}

/**
 * Get the licence infos.
 *
 * @param  integer $id
 * @return object of block_informations_licences
 */
function block_informations_get_licence($id) {
    global $DB;

    return $DB->get_record('block_informations_licences', array('id' => $id));
}

/**
 * Get a list of the categories that aren't associated with a licence.
 *
 * @return array of categories id and name
 */
function block_informations_get_available_categories() {
    global $DB;

    $categories = core_course_category::make_categories_list();
    $sql = 'SELECT DISTINCT(categoryid) as id FROM {block_informations_licences} WHERE categoryid IS NOT NULL';
    $usedcategoriesids = $DB->get_records_sql($sql);

    foreach ($usedcategoriesids as $key => $val) {
        unset($categories[$key]);
    }

    $availablecategories = array();
    foreach ($categories as $key => $val) {
        $availablecategories[] = (object) array('id' => $key, 'name' => $val);
    }

    return $availablecategories;
}

/**
 * Retrieve a licence for the given category id.
 *
 * @param  int $categoryid
 * @return object|null $licence A record of block_informations_licences or null
 */
function block_informations_category_licence($categoryid) {
    global $DB;

    $sql = 'SELECT * FROM {block_informations_licences} WHERE categoryid = :categoryid';
    $licence = $DB->get_record_sql($sql, array('categoryid' => $categoryid));

    if (!$licence) {
        $category = $DB->get_record_sql('SELECT * FROM {course_categories} WHERE id = :id', array('id' => $categoryid));
        $children = $DB->get_records('course_categories', array('parent' => $categoryid), 'sortorder ASC');
        if ($category->parent) {
            // Search a licence for the parent category.
            return block_informations_category_licence($category->parent);
        }
    }

    return $licence;
}

/**
 * Get the course category id.
 *
 * @param context $coursecontext
 * @return int $categoryid
 */
function block_informations_get_course_category($coursecontext) {
    global $DB;

    $categoryid = null;
    $courseid = $coursecontext->instanceid;
    $course = $DB->get_record('course', array('id' => $courseid), 'id, category');
    if ($course) {
        $categoryid = $course->category;
    }

    return $categoryid;
}