forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-65978 blog: New WS core_blog_add_entry
- Loading branch information
Showing
5 changed files
with
371 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| <?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/>. | ||
|
|
||
| namespace core_blog\external; | ||
|
|
||
| use core_external\external_api; | ||
| use core_external\external_format_value; | ||
| use core_external\external_function_parameters; | ||
| use core_external\external_multiple_structure; | ||
| use core_external\external_single_structure; | ||
| use core_external\external_value; | ||
| use core_external\external_warnings; | ||
| use context_system; | ||
| use context_course; | ||
| use context_module; | ||
| use moodle_exception; | ||
|
|
||
| /** | ||
| * This is the external method for adding 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 add_entry extends external_api { | ||
|
|
||
| /** | ||
| * Parameters. | ||
| * | ||
| * @return external_function_parameters | ||
| */ | ||
| public static function execute_parameters(): external_function_parameters { | ||
| return new external_function_parameters([ | ||
| 'subject' => new external_value(PARAM_TEXT, 'Blog subject'), | ||
| 'summary' => new external_value(PARAM_RAW, 'Blog post content'), | ||
| 'summaryformat' => new external_format_value('summary'), | ||
| 'options' => new external_multiple_structure ( | ||
| new external_single_structure( | ||
| [ | ||
| 'name' => new external_value(PARAM_ALPHANUM, | ||
| 'The allowed keys (value format) are: | ||
| inlineattachmentsid (int); the draft file area id for inline attachments. Default to 0. | ||
| attachmentsid (int); the draft file area id for attachments. Default to 0. | ||
| publishstate (str); the publish state of the entry (draft, site or public). Default to site. | ||
| courseassoc (int); the course id to associate the entry with. Default to 0. | ||
| modassoc (int); the module id to associate the entry with. Default to 0. | ||
| tags (str); the tags to associate the entry with, comma separated. Default to empty.'), | ||
| 'value' => new external_value(PARAM_RAW, 'the value of the option (validated inside the function)'), | ||
| ] | ||
| ), 'Optional settings', VALUE_DEFAULT, [] | ||
| ), | ||
| ]); | ||
| } | ||
|
|
||
| /** | ||
| * Add the indicated glossary entry. | ||
| * | ||
| * @param string $subject the glossary subject | ||
| * @param string $summary the subject summary | ||
| * @param int $summaryformat the subject summary format | ||
| * @param array $options additional settings | ||
| * @return array with result and warnings | ||
| * @throws moodle_exception | ||
| */ | ||
| public static function execute(string $subject, string $summary, int $summaryformat, | ||
| array $options = []): array { | ||
|
|
||
| global $DB, $CFG; | ||
| require_once($CFG->dirroot . '/blog/lib.php'); | ||
| require_once($CFG->dirroot . '/blog/locallib.php'); | ||
|
|
||
| $params = self::validate_parameters(self::execute_parameters(), compact('subject', 'summary', | ||
| 'summaryformat', 'options')); | ||
|
|
||
| if (empty($CFG->enableblogs)) { | ||
| throw new moodle_exception('blogdisable', 'blog'); | ||
| } | ||
|
|
||
| $context = context_system::instance(); | ||
|
|
||
| if (!has_capability('moodle/blog:create', $context)) { | ||
| throw new \moodle_exception('cannoteditentryorblog', 'blog'); | ||
| } | ||
|
|
||
| // Prepare the entry object. | ||
| $entrydata = new \stdClass(); | ||
| $entrydata->subject = $params['subject']; | ||
| $entrydata->summary_editor = [ | ||
| 'text' => $params['summary'], | ||
| 'format' => $params['summaryformat'], | ||
| ]; | ||
| $entrydata->publishstate = 'site'; | ||
|
|
||
| // Options. | ||
| foreach ($params['options'] as $option) { | ||
| $name = trim($option['name']); | ||
| switch ($name) { | ||
| case 'inlineattachmentsid': | ||
| $entrydata->summary_editor['itemid'] = clean_param($option['value'], PARAM_INT); | ||
| break; | ||
| case 'attachmentsid': | ||
| $entrydata->attachment_filemanager = clean_param($option['value'], PARAM_INT); | ||
| break; | ||
| case 'publishstate': | ||
| $entrydata->publishstate = clean_param($option['value'], PARAM_ALPHA); | ||
| $applicable = \blog_entry::get_applicable_publish_states(); | ||
| if (empty($applicable[$entrydata->publishstate])) { | ||
| throw new moodle_exception('errorinvalidparam', 'webservice', '', $name); | ||
| } | ||
| break; | ||
| case 'courseassoc': | ||
| case 'modassoc': | ||
| $entrydata->{$name} = clean_param($option['value'], PARAM_INT); | ||
| if (!$CFG->useblogassociations) { | ||
| throw new moodle_exception('errorinvalidparam', 'webservice', '', $name); | ||
| } | ||
| break; | ||
| case 'tags': | ||
| $entrydata->tags = clean_param($option['value'], PARAM_TAGLIST); | ||
| // Convert to the expected format. | ||
| $entrydata->tags = explode(',', $entrydata->tags); | ||
| break; | ||
| default: | ||
| throw new moodle_exception('errorinvalidparam', 'webservice', '', $name); | ||
| } | ||
| } | ||
|
|
||
| // Validate course association. We need to convert the course id to context. | ||
| if (!empty($entrydata->courseassoc)) { | ||
| $coursecontext = context_course::instance($entrydata->courseassoc); | ||
| $entrydata->courseid = $entrydata->courseassoc; | ||
| $entrydata->courseassoc = $coursecontext->id; // Convert to context. | ||
| $context = $coursecontext; | ||
| } | ||
|
|
||
| // Validate mod association. | ||
| if (!empty($entrydata->modassoc)) { | ||
| $modcontext = context_module::instance($entrydata->modassoc); | ||
| if (!empty($coursecontext) && $coursecontext->id != $modcontext->get_course_context(true)->id) { | ||
| throw new moodle_exception('errorinvalidparam', 'webservice', '', 'modassoc'); | ||
| } | ||
| $entrydata->coursemoduleid = $entrydata->modassoc; | ||
| $entrydata->modassoc = $modcontext->id; // Convert to context. | ||
| $context = $modcontext; | ||
| } | ||
|
|
||
| // Validate context for where the blog entry is going to be posted. | ||
| self::validate_context($context); | ||
|
|
||
| [$summaryoptions, $attachmentoptions] = blog_get_editor_options(); | ||
|
|
||
| $blogentry = new \blog_entry(null, $entrydata, null); | ||
| $blogentry->add(); | ||
| $blogentry->edit((array) $entrydata, null, $summaryoptions, $attachmentoptions); | ||
|
|
||
| return [ | ||
| 'entryid' => $blogentry->id, | ||
| 'warnings' => [], | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Return. | ||
| * | ||
| * @return external_single_structure | ||
| */ | ||
| public static function execute_returns(): external_single_structure { | ||
| return new external_single_structure([ | ||
| 'entryid' => new external_value(PARAM_INT, 'The new entry id.'), | ||
| 'warnings' => new external_warnings(), | ||
| ]); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.