mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 00:42:54 +02:00
Code Issues Projects Releases Wiki Activity

MDL-63806 glossary: New WS mod_glossary_delete_entry

Browse Source
This commit is contained in:
Juan Leyva 2020-09-25 17:25:34 +02:00
parent f9b56649e7
commit 8441d551ea
5 changed files with 190 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mod/glossary/classes/external.php
View File

@ -162,7 +162,7 @@ class mod_glossary_external extends external_api {
* @param int $id The glossary ID.
* @return array Contains glossary, context, course and cm.
*/
protected static function validate_glossary($id) {
public static function validate_glossary($id) {
global $DB;
$glossary = $DB->get_record('glossary', array('id' => $id), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($glossary, 'glossary');

97
mod/glossary/classes/external/delete_entry.php vendored Normal file
View File

@ -0,0 +1,97 @@
<?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 deleting a content.
*
* @package mod_glossary
* @since Moodle 3.10
* @copyright 2020 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_glossary\external;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/mod/glossary/lib.php');
use external_api;
use external_function_parameters;
use external_multiple_structure;
use external_single_structure;
use external_value;
use external_warnings;
/**
* This is the external method for deleting a content.
*
* @copyright 2020 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class delete_entry extends external_api {
/**
* Parameters.
*
* @return external_function_parameters
*/
public static function execute_parameters(): external_function_parameters {
return new external_function_parameters([
'entryid' => new external_value(PARAM_INT, 'Glossary entry id to delete'),
]);
}
/**
* Delete the indicated entry from the glossary.
*
* @param int $entryid The entry to delete
* @return array with result and warnings
* @throws moodle_exception
*/
public static function execute(int $entryid): array {
global $DB;
$params = self::validate_parameters(self::execute_parameters(), compact('entryid'));
$id = $params['entryid'];
// Get and validate the glossary.
$entry = $DB->get_record('glossary_entries', ['id' => $id], '*', MUST_EXIST);
list($glossary, $context, $course, $cm) = \mod_glossary_external::validate_glossary($entry->glossaryid);
// Check and delete.
mod_glossary_can_delete_entry($entry, $glossary, $context, false);
mod_glossary_delete_entry($entry, $glossary, $cm, $context, $course);
return [
'result' => true,
'warnings' => [],
];
}
/**
* Return.
*
* @return external_single_structure
*/
public static function execute_returns(): external_single_structure {
return new external_single_structure([
'result' => new external_value(PARAM_BOOL, 'The processing result'),
'warnings' => new external_warnings()
]);
}
}

8
mod/glossary/db/services.php
View File

@ -162,4 +162,12 @@ $functions = array(
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_glossary_delete_entry' => [
'classname' => 'mod_glossary\external\delete_entry',
'methodname' => 'execute',
'classpath' => '',
'description' => 'Delete the given entry from the glossary.',
'type' => 'write',
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE]
],
);

83
mod/glossary/tests/external/delete_entry.php vendored Normal file
View File

@ -0,0 +1,83 @@
<?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/>.
/**
* External function test for delete_entry.
*
* @package mod_glossary
* @category external
* @since Moodle 3.10
* @copyright 2020 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_glossary\external;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
use external_api;
use externallib_advanced_testcase;
/**
* External function test for delete_entry.
*
* @package mod_glossary
* @copyright 2020 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class delete_entry_testcase extends externallib_advanced_testcase {
/**
* Test the behaviour of delete_entry().
*/
public function test_delete_entry() {
global $DB;
$this->resetAfterTest();
// Create required data.
$course = $this->getDataGenerator()->create_course();
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
$anotherstudent = $this->getDataGenerator()->create_and_enrol($course, 'student');
$glossary = $this->getDataGenerator()->create_module('glossary', ['course' => $course->id]);
$gg = $this->getDataGenerator()->get_plugin_generator('mod_glossary');
$this->setUser($student);
$entry = $gg->create_content($glossary);
// Test entry creator can delete.
$result = delete_entry::execute($entry->id);
$result = external_api::clean_returnvalue(delete_entry::execute_returns(), $result);
$this->assertTrue($result['result']);
$this->assertEquals(0, $DB->count_records('glossary_entries', ['id' => $entry->id]));
// Test admin can delete.
$this->setAdminUser();
$entry = $gg->create_content($glossary);
$result = delete_entry::execute($entry->id);
$result = external_api::clean_returnvalue(delete_entry::execute_returns(), $result);
$this->assertTrue($result['result']);
$this->assertEquals(0, $DB->count_records('glossary_entries', ['id' => $entry->id]));
$entry = $gg->create_content($glossary);
// Test a different student is not able to delete.
$this->setUser($anotherstudent);
$this->expectExceptionMessage(get_string('nopermissiontodelentry', 'error'));
delete_entry::execute($entry->id);
}
}

2
mod/glossary/version.php
View File

@ -24,7 +24,7 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2021052500; // The current module version (Date: YYYYMMDDXX)
$plugin->version = 2021052501; // The current module version (Date: YYYYMMDDXX)
$plugin->requires = 2021052500; // Requires this Moodle version
$plugin->component = 'mod_glossary'; // Full name of the plugin (used for diagnostics)
$plugin->cron = 0;