cescobedo
a9ed34a944
This is the external method for triggering the course module viewed event and update the module completion status. Affects mobile app.
108 lines
3.3 KiB
PHP
108 lines
3.3 KiB
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/>.
|
|
|
|
/**
|
|
* This is the external method for triggering the course module viewed event.
|
|
*
|
|
* @package mod_h5pactivity
|
|
* @since Moodle 3.9
|
|
* @copyright 2020 Carlos Escobedo <carlos@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace mod_h5pactivity\external;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once($CFG->libdir . '/externallib.php');
|
|
|
|
use external_api;
|
|
use external_function_parameters;
|
|
use external_value;
|
|
use external_single_structure;
|
|
use external_warnings;
|
|
use context_module;
|
|
use mod_h5pactivity\local\manager;
|
|
|
|
/**
|
|
* This is the external method for triggering the course module viewed event.
|
|
*
|
|
* @package mod_h5pactivity
|
|
* @since Moodle 3.9
|
|
* @copyright 2020 Carlos Escobedo <carlos@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class view_h5pactivity extends external_api {
|
|
/**
|
|
* Parameters.
|
|
*
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function execute_parameters(): external_function_parameters {
|
|
return new external_function_parameters(
|
|
[
|
|
'h5pactivityid' => new external_value(PARAM_INT, 'H5P activity instance id')
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Trigger the course module viewed event and update the module completion status.
|
|
*
|
|
* @param int $h5pactivityid The h5p activity id.
|
|
* @return array of warnings and the access information
|
|
* @since Moodle 3.9
|
|
* @throws moodle_exception
|
|
*/
|
|
public static function execute(int $h5pactivityid): array {
|
|
|
|
$params = external_api::validate_parameters(self::execute_parameters(), [
|
|
'h5pactivityid' => $h5pactivityid
|
|
]);
|
|
$warnings = [];
|
|
|
|
// Request and permission validation.
|
|
list($course, $cm) = get_course_and_cm_from_instance($params['h5pactivityid'], 'h5pactivity');
|
|
|
|
$context = context_module::instance($cm->id);
|
|
self::validate_context($context);
|
|
|
|
$manager = manager::create_from_coursemodule($cm);
|
|
$manager->set_module_viewed($course);
|
|
|
|
$result = array(
|
|
'status' => true,
|
|
'warnings' => $warnings,
|
|
);
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Describes the view_h5pactivity return value.
|
|
*
|
|
* @return external_single_structure
|
|
* @since Moodle 3.9
|
|
*/
|
|
public static function execute_returns() {
|
|
return new external_single_structure(
|
|
[
|
|
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
|
|
'warnings' => new external_warnings()
|
|
]
|
|
);
|
|
}
|
|
}
|