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

/**
 * Library of interface functions and constants.
 *
 * @package     mod_wikisearch
 * @copyright   2020 LEARNING.BOG.GE <contact@learning.bog.ge>
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

/**
 * Return if the plugin supports $feature.
 *
 * @param string $feature Constant representing the feature.
 * @return true | null True if the feature is supported, null otherwise.
 */
function wikisearch_supports($feature) {
    switch ($feature) {
        case FEATURE_MOD_INTRO:
            return true;
        default:
            return null;
    }
}

/**
 * Saves a new instance of the mod_wikisearch into the database.
 *
 * Given an object containing all the necessary data, (defined by the form
 * in mod_form.php) this function will create a new instance and return the id
 * number of the instance.
 *
 * @param object $moduleinstance An object from the form.
 * @param mod_wikisearch_mod_form $mform The form.
 * @return int The id of the newly inserted record.
 */
function wikisearch_add_instance($moduleinstance, $mform = null) {
    global $DB;

    $moduleinstance->timecreated = time();

    $id = $DB->insert_record('wikisearch', $moduleinstance);

    return $id;
}

/**
 * Updates an instance of the mod_wikisearch in the database.
 *
 * Given an object containing all the necessary data (defined in mod_form.php),
 * this function will update an existing instance with new data.
 *
 * @param object $moduleinstance An object from the form in mod_form.php.
 * @param mod_wikisearch_mod_form $mform The form.
 * @return bool True if successful, false otherwise.
 */
function wikisearch_update_instance($moduleinstance, $mform = null) {
    global $DB;

    $moduleinstance->timemodified = time();
    $moduleinstance->id = $moduleinstance->instance;

    return $DB->update_record('wikisearch', $moduleinstance);
}

/**
 * Removes an instance of the mod_wikisearch from the database.
 *
 * @param int $id Id of the module instance.
 * @return bool True if successful, false on failure.
 */
function wikisearch_delete_instance($id) {
    global $DB;

    $exists = $DB->get_record('wikisearch', array('id' => $id));
    if (!$exists) {
        return false;
    }

    $DB->delete_records('wikisearch', array('id' => $id));

    return true;
}

function wikisearch_search_results($searchstring) {
    global $DB;

    $sql = "
        SELECT
            p.*
        FROM {wiki_pages} p
        WHERE
            p.title LIKE '%" . $searchstring . "%'
         OR p.cachedcontent LIKE '%" . $searchstring . "%'
    ";

    return $DB->get_records_sql($sql);
}

function wikisearch_highlight_keywords($text, $keywords) {
    $keywords = explode(' ', $keywords);

    for ($i = 0; $i < count($keywords); $i++) {
        $highlighted_text = '<span style="
            background: yellow;
            padding: 3px;
            color: #ff5f5f;
            font-weight: bold;
        ">' . $keywords[$i] . '</span>';
        $text = str_ireplace($keywords[$i], $highlighted_text, $text);
    }

    return $text;
}