CHIEFSOFT\ameye
105 lines
3.2 KiB
PHP
105 lines
3.2 KiB
PHP
<?php
|
|
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
|
|
|
|
namespace core_blog\external;
|
|
|
|
use core_external\external_api;
|
|
use core_external\external_function_parameters;
|
|
use core_external\external_single_structure;
|
|
use core_external\external_value;
|
|
use core_external\external_warnings;
|
|
use context_course;
|
|
use moodle_exception;
|
|
|
|
/**
|
|
* This is the external method for deleting a blog post entry.
|
|
*
|
|
* @package core_blog
|
|
* @copyright 2024 Juan Leyva <juan@moodle.com>
|
|
* @category external
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class delete_entry extends external_api {
|
|
|
|
/**
|
|
* Describes the external function parameters.
|
|
*
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function execute_parameters(): external_function_parameters {
|
|
return new external_function_parameters(
|
|
[
|
|
'entryid' => new external_value(PARAM_INT, 'The entry id to remove.'),
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Deletes a blog entry.
|
|
*
|
|
* @param int $entryid The entry id to remove.
|
|
* @throws moodle_exception;
|
|
* @return array result of the operation
|
|
*/
|
|
public static function execute(int $entryid): array {
|
|
global $USER, $CFG;
|
|
|
|
require_once($CFG->dirroot . '/blog/lib.php');
|
|
require_once($CFG->dirroot . '/blog/locallib.php');
|
|
|
|
$params = self::validate_parameters(self::execute_parameters(), ['entryid' => $entryid]);
|
|
|
|
if (empty($CFG->enableblogs)) {
|
|
throw new moodle_exception('blogdisable', 'blog');
|
|
}
|
|
|
|
if (!$entry = new \blog_entry($params['entryid'])) {
|
|
throw new moodle_exception('wrongentryid', 'blog');
|
|
}
|
|
|
|
$courseid = !empty($entry->courseid) ? $entry->courseid : SITEID;
|
|
$context = context_course::instance($courseid);
|
|
|
|
self::validate_context($context);
|
|
|
|
if (!blog_user_can_edit_entry($entry)) {
|
|
throw new \moodle_exception('nopermissionstodeleteentry', 'blog');
|
|
}
|
|
|
|
$entry->delete();
|
|
|
|
$result = [
|
|
'status' => true,
|
|
'warnings' => [],
|
|
];
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Return.
|
|
*
|
|
* @return external_single_structure
|
|
*/
|
|
public static function execute_returns() : external_single_structure {
|
|
return new external_single_structure(
|
|
[
|
|
'status' => new external_value(PARAM_BOOL, 'True indicates the entry was deleted.'),
|
|
'warnings' => new external_warnings(),
|
|
]
|
|
);
|
|
}
|
|
}
|