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-56020 search: New WS core_search_view_results
- Loading branch information
Showing
3 changed files
with
204 additions
and
0 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,125 @@ | ||
<?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 core_external\external_value; | ||
use core_external\external_warnings; | ||
use moodle_exception; | ||
|
||
/** | ||
* External function for trigger view search results event. | ||
* | ||
* @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 view_results extends external_api { | ||
|
||
/** | ||
* Webservice parameters. | ||
* | ||
* @return external_function_parameters | ||
*/ | ||
public static function execute_parameters(): external_function_parameters { | ||
return new external_function_parameters( | ||
[ | ||
'query' => new external_value(PARAM_NOTAGS, 'the search query'), | ||
'filters' => new external_single_structure( | ||
[ | ||
'title' => new external_value(PARAM_NOTAGS, 'result title', VALUE_OPTIONAL), | ||
'areaids' => new external_multiple_structure( | ||
new external_value(PARAM_RAW, 'areaid'), 'restrict results to these areas', VALUE_DEFAULT, [] | ||
), | ||
'courseids' => new external_multiple_structure( | ||
new external_value(PARAM_INT, 'courseid'), 'restrict results to these courses', VALUE_DEFAULT, [] | ||
), | ||
'timestart' => new external_value(PARAM_INT, 'docs modified after this date', VALUE_DEFAULT, 0), | ||
'timeend' => new external_value(PARAM_INT, 'docs modified before this date', VALUE_DEFAULT, 0) | ||
], 'filters to apply', VALUE_DEFAULT, [] | ||
), | ||
'page' => new external_value(PARAM_INT, 'results page number starting from 0, defaults to the first page', | ||
VALUE_DEFAULT, 0) | ||
] | ||
); | ||
} | ||
|
||
/** | ||
* Trigger view results event. | ||
* | ||
* @param string $query the search query | ||
* @param array $filters filters to apply | ||
* @param int $page results page | ||
* @return array status and warnings | ||
*/ | ||
public static function execute(string $query, array $filters = [], int $page = 0): array { | ||
|
||
$params = self::validate_parameters(self::execute_parameters(), | ||
[ | ||
'query' => $query, | ||
'filters' => $filters, | ||
'page' => $page, | ||
] | ||
); | ||
|
||
$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'); | ||
} | ||
|
||
$filters = new \stdClass(); | ||
$filters->title = $params['filters']['title'] ?? ''; | ||
$filters->timestart = $params['filters']['timestart'] ?? 0; | ||
$filters->timeend = $params['filters']['timeend'] ?? 0; | ||
$filters->areaids = $params['filters']['areaids'] ?? []; | ||
$filters->courseids = $params['filters']['courseids'] ?? []; | ||
|
||
\core_search\manager::trigger_search_results_viewed([ | ||
'q' => $params['query'], | ||
'page' => $params['page'], | ||
'title' => !empty($filters->title) ? $filters->title : '', | ||
'areaids' => !empty($filters->areaids) ? $filters->areaids : [], | ||
'courseids' => !empty($filters->courseids) ? $filters->courseids : [], | ||
'timestart' => isset($filters->timestart) ? $filters->timestart : 0, | ||
'timeend' => isset($filters->timeend) ? $filters->timeend : 0 | ||
]); | ||
|
||
return ['status' => true, 'warnings' => []]; | ||
} | ||
|
||
/** | ||
* Webservice returns. | ||
* | ||
* @return external_single_structure | ||
*/ | ||
public static function execute_returns(): external_single_structure { | ||
return new external_single_structure( | ||
[ | ||
'status' => new external_value(PARAM_BOOL, 'status: true if success'), | ||
'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,72 @@ | ||
<?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; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
global $CFG; | ||
require_once($CFG->dirroot . '/webservice/tests/helpers.php'); | ||
|
||
/** | ||
* Tests for the view_results external function. | ||
* | ||
* @package core_search | ||
* @category test | ||
* @copyright 2023 Juan Leyva ([email protected]) | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
* @coversDefaultClass \core_search\external\view_results | ||
*/ | ||
class view_results_test extends \externallib_advanced_testcase { | ||
|
||
public function setUp(): void { | ||
$this->resetAfterTest(); | ||
} | ||
|
||
/** | ||
* test external api | ||
* @covers ::execute | ||
* @return void | ||
*/ | ||
public function test_external_view_results(): void { | ||
|
||
set_config('enableglobalsearch', true); | ||
|
||
$this->setAdminUser(); | ||
// Trigger and capture the event. | ||
$sink = $this->redirectEvents(); | ||
|
||
$result = view_results::execute('forum post', ['title' => 'My progress'], 1); | ||
$result = external_api::clean_returnvalue(view_results::execute_returns(), $result); | ||
$this->assertEmpty($result['warnings']); | ||
$this->assertTrue($result['status']); | ||
|
||
$events = $sink->get_events(); | ||
$this->assertCount(1, $events); | ||
$event = array_shift($events); | ||
$sink->close(); | ||
|
||
// Checking that the event contains the expected values. | ||
$this->assertInstanceOf('core\event\search_results_viewed', $event); | ||
$this->assertEventContextNotUsed($event); | ||
$this->assertNotEmpty($event->get_name()); | ||
$this->assertEquals('forum post', $event->get_data()['other']['q']); | ||
$this->assertEquals('My progress', $event->get_data()['other']['title']); | ||
$this->assertEquals(1, $event->get_data()['other']['page']); | ||
} | ||
} |