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

/**
 * @package    block_pu
 * @copyright  2021 onwards LSU Online & Continuing Education
 * @copyright  2021 onwards Tim Hunt, Robert Russo, David Lowe
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

require_once($CFG->libdir . "/externallib.php");

class block_pu_external extends external_api {

    /**
     * Returns description of method parameters.
     * @return external_function_parameters
     */
    public static function pujax_parameters() {
        return new external_function_parameters(
            array(
                'datachunk' => new external_value(
                    PARAM_TEXT,
                    'Encoded Params"'
                )
            )
        );
    }

    /**
     * Returns welcome message.
     * @return string welcome message
     */
    public static function pujax($datachunk) {
        $datachunk = json_decode($datachunk);

        $classobj = isset($datachunk->class) ? $datachunk->class : null;
        $function = isset($datachunk->call) ? $datachunk->call : null;
        $params = isset($datachunk->params) ? $datachunk->params : array("empty" => true);

        if (isset($classobj)) {
            include_once('classes/external/'.$classobj.'.php');
            $xeclass = new $classobj();
        } else {
            // TODO: If we want custom logging for this plugin then replace.
            debugging("\nPUjax => Rejected, no file specified!!!");
            die (json_encode(array("success" => "false")));
        }

        // Now let's call the method.
        $leftoverdata = null;
        if (method_exists($xeclass, $function)) {
            $leftoverdata = call_user_func(array($xeclass, $function), $params);
        } else {
            // TODO: If we want custom logging for this plugin then replace.
            debugging("\nPUjax.php => Rejected, method does not exist!!!");
            die (json_encode(array("success" => "false")));
        }

        return array('data' => json_encode($leftoverdata));
    }

    /**
     * Returns description of method result value.
     * @return external_description
     */
    public static function pujax_returns() {
        return new external_single_structure(
            array(
                'data' => new external_value(PARAM_TEXT, 'JSON encoded goodness')
            )
        );
    }
}