forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-60425 core_blog: New WS core_blog_get_entries
- Loading branch information
Showing
5 changed files
with
940 additions
and
1 deletion.
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,180 @@ | ||
| <?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 API for blogs. | ||
| * | ||
| * @package core_blog | ||
| * @copyright 2018 Juan Leyva | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core_blog; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| require_once($CFG->libdir .'/externallib.php'); | ||
| require_once($CFG->dirroot .'/blog/lib.php'); | ||
| require_once($CFG->dirroot .'/blog/locallib.php'); | ||
|
|
||
| use external_api; | ||
| use external_function_parameters; | ||
| use external_value; | ||
| use external_single_structure; | ||
| use external_multiple_structure; | ||
| use external_warnings; | ||
| use context_system; | ||
| use context_course; | ||
| use moodle_exception; | ||
| use core_blog\external\post_exporter; | ||
|
|
||
| /** | ||
| * This is the external API for blogs. | ||
| * | ||
| * @copyright 2018 Juan Leyva | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class external extends external_api { | ||
|
|
||
| /** | ||
| * Returns description of get_entries() parameters. | ||
| * | ||
| * @return external_function_parameters | ||
| * @since Moodle 3.6 | ||
| */ | ||
| public static function get_entries_parameters() { | ||
| return new external_function_parameters( | ||
| array( | ||
| 'filters' => new external_multiple_structure ( | ||
| new external_single_structure( | ||
| array( | ||
| 'name' => new external_value(PARAM_ALPHA, | ||
| 'The expected keys (value format) are: | ||
| tag PARAM_NOTAGS blog tag | ||
| tagid PARAM_INT blog tag id | ||
| userid PARAM_INT blog author (userid) | ||
| cmid PARAM_INT course module id | ||
| entryid PARAM_INT entry id | ||
| groupid PARAM_INT group id | ||
| courseid PARAM_INT course id | ||
| search PARAM_RAW search term | ||
| ' | ||
| ), | ||
| 'value' => new external_value(PARAM_RAW, 'The value of the filter.') | ||
| ) | ||
| ), 'Parameters to filter blog listings.', VALUE_DEFAULT, array() | ||
| ), | ||
| 'page' => new external_value(PARAM_INT, 'The blog page to return.', VALUE_DEFAULT, 0), | ||
| 'perpage' => new external_value(PARAM_INT, 'The number of posts to return per page.', VALUE_DEFAULT, 10), | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Return blog entries. | ||
| * | ||
| * @param array $filters the parameters to filter the blog listing | ||
| * @param int $page the blog page to return | ||
| * @param int $perpage the number of posts to return per page | ||
| * @return array with the blog entries and warnings | ||
| * @since Moodle 3.6 | ||
| */ | ||
| public static function get_entries($filters = array(), $page = 0, $perpage = 10) { | ||
| global $CFG, $DB, $PAGE; | ||
|
|
||
| $warnings = array(); | ||
| $params = self::validate_parameters(self::get_entries_parameters(), | ||
| array('filters' => $filters, 'page' => $page, 'perpage' => $perpage)); | ||
|
|
||
| if (empty($CFG->enableblogs)) { | ||
| throw new moodle_exception('blogdisable', 'blog'); | ||
| } | ||
|
|
||
| // Init filters. | ||
| $filterstype = array('courseid' => PARAM_INT, 'groupid' => PARAM_INT, 'userid' => PARAM_INT, 'tagid' => PARAM_INT, | ||
| 'tag' => PARAM_NOTAGS, 'cmid' => PARAM_INT, 'entryid' => PARAM_INT, 'search' => PARAM_RAW); | ||
| $filters = array('courseid' => null, 'groupid' => null, 'userid' => null, 'tagid' => null, | ||
| 'tag' => null, 'cmid' => null, 'entryid' => null, 'search' => null); | ||
|
|
||
| foreach ($params['filters'] as $filter) { | ||
| $name = trim($filter['name']); | ||
| if (!isset($filterstype[$name])) { | ||
| throw new moodle_exception('errorinvalidparam', 'webservice', '', $name); | ||
| } | ||
| $filters[$name] = clean_param($filter['value'], $filterstype[$name]); | ||
| } | ||
|
|
||
| // Do not overwrite here the filters, blog_get_headers and blog_listing will take care of that. | ||
| list($courseid, $userid) = blog_validate_access($filters['courseid'], $filters['cmid'], $filters['groupid'], | ||
| $filters['entryid'], $filters['userid']); | ||
|
|
||
| if ($courseid && $courseid != SITEID) { | ||
| $context = context_course::instance($courseid); | ||
| self::validate_context($context); | ||
| } else { | ||
| $context = context_system::instance(); | ||
| if ($CFG->bloglevel == BLOG_GLOBAL_LEVEL) { | ||
| // Everybody can see anything - no login required unless site is locked down using forcelogin. | ||
| if ($CFG->forcelogin) { | ||
| self::validate_context($context); | ||
| } | ||
| } else { | ||
| self::validate_context($context); | ||
| } | ||
| } | ||
| $PAGE->set_context($context); // Needed by internal APIs. | ||
|
|
||
| // Get filters. | ||
| $blogheaders = blog_get_headers($filters['courseid'], $filters['groupid'], $filters['userid'], $filters['tagid'], | ||
| $filters['tag'], $filters['cmid'], $filters['entryid'], $filters['search']); | ||
| $bloglisting = new \blog_listing($blogheaders['filters']); | ||
|
|
||
| $page = $params['page']; | ||
| $limit = empty($params['perpage']) ? get_user_preferences('blogpagesize', 10) : $params['perpage']; | ||
| $start = $page * $limit; | ||
| $entries = $bloglisting->get_entries($start, $limit); | ||
| $totalentries = $bloglisting->count_entries(); | ||
|
|
||
| $exportedentries = array(); | ||
| $output = $PAGE->get_renderer('core'); | ||
| foreach ($entries as $entry) { | ||
| $exporter = new post_exporter($entry, array('context' => $context)); | ||
| $exportedentries[] = $exporter->export($output); | ||
| } | ||
| return array( | ||
| 'warnings' => $warnings, | ||
| 'entries' => $exportedentries, | ||
| 'totalentries' => $totalentries, | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns description of get_entries() result value. | ||
| * | ||
| * @return external_description | ||
| * @since Moodle 3.6 | ||
| */ | ||
| public static function get_entries_returns() { | ||
| return new external_single_structure( | ||
| array( | ||
| 'entries' => new external_multiple_structure( | ||
| post_exporter::get_read_structure() | ||
| ), | ||
| 'totalentries' => new external_value(PARAM_INT, 'The total number of entries found.'), | ||
| '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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Class for exporting a blog post (entry). | ||
| * | ||
| * @package core_blog | ||
| * @copyright 2018 Juan Leyva <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| namespace core_blog\external; | ||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| use core\external\exporter; | ||
| use external_util; | ||
| use external_files; | ||
| use renderer_base; | ||
| use context_system; | ||
|
|
||
| /** | ||
| * Class for exporting a blog post (entry). | ||
| * | ||
| * @copyright 2018 Juan Leyva <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class post_exporter extends exporter { | ||
|
|
||
| /** | ||
| * Return the list of properties. | ||
| * | ||
| * @return array list of properties | ||
| */ | ||
| protected static function define_properties() { | ||
| return array( | ||
| 'id' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_ALLOWED, | ||
| 'description' => 'Post/entry id.', | ||
| ), | ||
| 'module' => array( | ||
| 'type' => PARAM_ALPHANUMEXT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'description' => 'Where it was published the post (blog, blog_external...).', | ||
| ), | ||
| 'userid' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Post author.', | ||
| ), | ||
| 'courseid' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Course where the post was created.', | ||
| ), | ||
| 'groupid' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Group post was created for.', | ||
| ), | ||
| 'moduleid' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Module id where the post was created (not used anymore).', | ||
| ), | ||
| 'coursemoduleid' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Course module id where the post was created.', | ||
| ), | ||
| 'subject' => array( | ||
| 'type' => PARAM_TEXT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'description' => 'Post subject.', | ||
| ), | ||
| 'summary' => array( | ||
| 'type' => PARAM_RAW, | ||
| 'null' => NULL_ALLOWED, | ||
| 'description' => 'Post summary.', | ||
| ), | ||
| 'content' => array( | ||
| 'type' => PARAM_RAW, | ||
| 'null' => NULL_ALLOWED, | ||
| 'description' => 'Post content.', | ||
| ), | ||
| 'uniquehash' => array( | ||
| 'type' => PARAM_RAW, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'description' => 'Post unique hash.', | ||
| ), | ||
| 'rating' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Post rating.', | ||
| ), | ||
| 'format' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'Post content format.', | ||
| ), | ||
| 'summaryformat' => array( | ||
| 'choices' => array(FORMAT_HTML, FORMAT_MOODLE, FORMAT_PLAIN, FORMAT_MARKDOWN), | ||
| 'type' => PARAM_INT, | ||
| 'default' => FORMAT_MOODLE, | ||
| 'description' => 'Format for the summary field.', | ||
| ), | ||
| 'attachment' => array( | ||
| 'type' => PARAM_RAW, | ||
| 'null' => NULL_ALLOWED, | ||
| 'description' => 'Post atachment.', | ||
| ), | ||
| 'publishstate' => array( | ||
| 'type' => PARAM_ALPHA, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 'draft', | ||
| 'description' => 'Post publish state.', | ||
| ), | ||
| 'lastmodified' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'When it was last modified.', | ||
| ), | ||
| 'created' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_NOT_ALLOWED, | ||
| 'default' => 0, | ||
| 'description' => 'When it was created.', | ||
| ), | ||
| 'usermodified' => array( | ||
| 'type' => PARAM_INT, | ||
| 'null' => NULL_ALLOWED, | ||
| 'description' => 'User that updated the post.', | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| protected static function define_related() { | ||
| return array( | ||
| 'context' => 'context' | ||
| ); | ||
| } | ||
|
|
||
| protected static function define_other_properties() { | ||
| return array( | ||
| 'summaryfiles' => array( | ||
| 'type' => external_files::get_properties_for_exporter(), | ||
| 'multiple' => true | ||
| ), | ||
| 'attachmentfiles' => array( | ||
| 'type' => external_files::get_properties_for_exporter(), | ||
| 'multiple' => true, | ||
| 'optional' => true | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| protected function get_other_values(renderer_base $output) { | ||
| $context = context_system::instance(); // Files always on site context. | ||
|
|
||
| $values['summaryfiles'] = external_util::get_area_files($context->id, 'blog', 'post', $this->data->id); | ||
| $values['attachmentfiles'] = external_util::get_area_files($context->id, 'blog', 'attachment', $this->data->id); | ||
|
|
||
| return $values; | ||
| } | ||
| } |
Oops, something went wrong.