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-56020 search: New WS core_search_get_top_results
- Loading branch information
Showing
5 changed files
with
379 additions
and
39 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
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,141 @@ | ||
| <?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_search\external; | ||
|
|
||
| use core\external\exporter; | ||
|
|
||
| /** | ||
| * Contains related class for displaying information of a search result. | ||
| * | ||
| * @package core_search | ||
| * @since Moodle 4.3 | ||
| */ | ||
| class document_exporter extends exporter { | ||
|
|
||
| /** | ||
| * Return the list of properties. | ||
| * | ||
| * @return array | ||
| */ | ||
| protected static function define_properties() { | ||
| return [ | ||
| 'itemid' => [ | ||
| 'type' => PARAM_INT, | ||
| 'description' => 'unique id in the search area scope', | ||
| ], | ||
| 'componentname' => [ | ||
| 'type' => PARAM_ALPHANUMEXT, | ||
| 'description' => 'component name', | ||
| ], | ||
| 'areaname' => [ | ||
| 'type' => PARAM_ALPHANUMEXT, | ||
| 'description' => 'search area name', | ||
| ], | ||
| 'courseurl' => [ | ||
| 'type' => PARAM_URL, | ||
| 'description' => 'result course url', | ||
| ], | ||
| 'coursefullname' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'result course fullname', | ||
| ], | ||
| 'timemodified' => [ | ||
| 'type' => PARAM_INT, | ||
| 'description' => 'result modified time', | ||
| ], | ||
| 'title' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'result title', | ||
| ], | ||
| 'docurl' => [ | ||
| 'type' => PARAM_URL, | ||
| 'description' => 'result url', | ||
| ], | ||
| 'iconurl' => [ | ||
| 'type' => PARAM_URL, | ||
| 'description' => 'icon url', | ||
| 'optional' => true, | ||
| 'default' => '', | ||
| 'null' => NULL_ALLOWED, | ||
| ], | ||
| 'content' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'result contents', | ||
| 'optional' => true, | ||
| 'default' => '', | ||
| 'null' => NULL_ALLOWED, | ||
| ], | ||
| 'contextid' => [ | ||
| 'type' => PARAM_INT, | ||
| 'description' => 'result context id', | ||
| ], | ||
| 'contexturl' => [ | ||
| 'type' => PARAM_URL, | ||
| 'description' => 'result context url', | ||
| ], | ||
| 'description1' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'extra result contents, depends on the search area', | ||
| 'optional' => true, | ||
| 'default' => '', | ||
| 'null' => NULL_ALLOWED, | ||
| ], | ||
| 'description2' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'extra result contents, depends on the search area', | ||
| 'optional' => true, | ||
| 'default' => '', | ||
| 'null' => NULL_ALLOWED, | ||
| ], | ||
| 'multiplefiles' => [ | ||
| 'type' => PARAM_INT, | ||
| 'description' => 'whether multiple files are returned or not', | ||
| 'optional' => true, | ||
| ], | ||
| 'filenames' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'result file names if present', | ||
| 'muultiple' => true, | ||
| 'optional' => true, | ||
| ], | ||
| 'filename' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'result file name if present', | ||
| 'optional' => true, | ||
| ], | ||
| 'userid' => [ | ||
| 'type' => PARAM_INT, | ||
| 'description' => 'user id', | ||
| 'optional' => true, | ||
| ], | ||
| 'userurl' => [ | ||
| 'type' => PARAM_URL, | ||
| 'description' => 'user url', | ||
| 'optional' => true, | ||
| ], | ||
| 'userfullname' => [ | ||
| 'type' => PARAM_RAW, | ||
| 'description' => 'user fullname', | ||
| 'optional' => true, | ||
| ], | ||
| 'textformat' => [ | ||
| 'type' => PARAM_INT, | ||
| 'description' => 'text fields format, it is the same for all of them', | ||
| ] | ||
| ]; | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?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_search\external; | ||
|
|
||
| use core_external\external_api; | ||
| use core_external\external_function_parameters; | ||
| use core_external\external_single_structure; | ||
| use core_external\external_multiple_structure; | ||
| use moodle_exception; | ||
|
|
||
| /** | ||
| * External function for retrieving top search results. | ||
| * | ||
| * @package core_search | ||
| * @copyright 2023 Juan Leyva <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| * @since Moodle 4.3 | ||
| */ | ||
| class get_top_results extends external_api { | ||
|
|
||
| /** | ||
| * Webservice parameters. | ||
| * | ||
| * @return external_function_parameters | ||
| */ | ||
| public static function execute_parameters(): external_function_parameters { | ||
|
|
||
| $baseparameters = get_results::execute_parameters(); | ||
|
|
||
| return new external_function_parameters( | ||
| [ | ||
| 'query' => $baseparameters->keys['query'], | ||
| 'filters' => $baseparameters->keys['filters'], | ||
| ] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Gets top search results based on the provided query and filters. | ||
| * | ||
| * @param string $query the search query | ||
| * @param array $filters filters to apply | ||
| * @return array search results | ||
| */ | ||
| public static function execute(string $query, array $filters = []): array { | ||
| global $PAGE; | ||
|
|
||
| $params = self::validate_parameters(self::execute_parameters(), | ||
| [ | ||
| 'query' => $query, | ||
| 'filters' => $filters, | ||
| ] | ||
| ); | ||
|
|
||
| $system = \context_system::instance(); | ||
| external_api::validate_context($system); | ||
|
|
||
| require_capability('moodle/search:query', $system); | ||
|
|
||
| if (\core_search\manager::is_global_search_enabled() === false) { | ||
| throw new moodle_exception('globalsearchdisabled', 'search'); | ||
| } | ||
|
|
||
| $search = \core_search\manager::instance(); | ||
|
|
||
| $data = new \stdClass(); | ||
| // First, mandatory parameters for consistency with web. | ||
| $data->q = $params['query']; | ||
| $data->title = $params['filters']['title'] ?? ''; | ||
| $data->timestart = $params['filters']['timestart'] ?? 0; | ||
| $data->timeend = $params['filters']['timeend'] ?? 0; | ||
| $data->areaids = $params['filters']['areaids'] ?? []; | ||
| $data->courseids = $params['filters']['courseids'] ?? []; | ||
| $data->contextids = $params['filters']['contextids'] ?? []; | ||
| $data->userids = $params['filters']['userids'] ?? []; | ||
| $data->groupids = $params['filters']['groupids'] ?? []; | ||
|
|
||
| $cat = $params['filters']['cat'] ?? ''; | ||
| if (\core_search\manager::is_search_area_categories_enabled()) { | ||
| $cat = \core_search\manager::get_search_area_category_by_name($cat); | ||
| } | ||
| if ($cat instanceof \core_search\area_category) { | ||
| $data->cat = $cat->get_name(); | ||
| } | ||
|
|
||
| $docs = $search->search_top($data); | ||
|
|
||
| $return = [ | ||
| 'warnings' => [], | ||
| 'results' => [] | ||
| ]; | ||
|
|
||
| // Convert results to simple data structures. | ||
| if ($docs) { | ||
| foreach ($docs as $doc) { | ||
| $return['results'][] = $doc->export_doc($PAGE->get_renderer('core')); | ||
| } | ||
| } | ||
| return $return; | ||
| } | ||
|
|
||
| /** | ||
| * Webservice returns. | ||
| * | ||
| * @return external_single_structure | ||
| */ | ||
| public static function execute_returns(): external_single_structure { | ||
|
|
||
| return new external_single_structure( | ||
| [ | ||
| 'results' => new external_multiple_structure( | ||
| \core_search\external\document_exporter::get_read_structure() | ||
| ), | ||
| ] | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.