moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-06 01:16:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-55356 core_search: Change existing search areas to new API

Browse source 
This change considers all existing search areas in Moodle and makes
necessary changes.

Custom change to course search, supported by helper in base.php:

* course/classes/search/mycourse.php

Custom change to message search:

* message/classes/search/message_received.php
* message/classes/search/message_sent.php

Custom change to user search:

* user/classes/search/user.php

Custom changes to module areas, supported by helper in base_mod.php:

* mod/book/classes/search/chapter.php
* mod/data/classes/search/entry.php
* mod/forum/classes/search/post.php
* mod/glossary/classes/search/entry.php
* mod/survey/classes/search/activity.php
* mod/wiki/classes/search/collaborative_page.php

(Note: the unit tests do not exhaustively check every context type
for these, given that's mainly handled by the helper function
which was already tested in the base_activity test.)

Handled by block base class (no change):

* blocks/html/classes/search/content.php

Handled by activity base class (no change):

* mod/assign/classes/search/activity.php
* mod/book/classes/search/activity.php
* mod/chat/classes/search/activity.php
* mod/choice/classes/search/activity.php
* mod/data/classes/search/activity.php
* mod/feedback/classes/search/activity.php
* mod/folder/classes/search/activity.php
* mod/forum/classes/search/activity.php
* mod/glossary/classes/search/activity.php
* mod/imscp/classes/search/activity.php
* mod/label/classes/search/activity.php
* mod/lesson/classes/search/activity.php
* mod/lti/classes/search/activity.php
* mod/page/classes/search/activity.php
* mod/quiz/classes/search/activity.php
* mod/resource/classes/search/activity.php
* mod/scorm/classes/search/activity.php
* mod/url/classes/search/activity.php
* mod/wiki/classes/search/activity.php
* mod/workshop/classes/search/activity.php
This commit is contained in:
sam marshall 2017-09-11 11:29:26 +01:00
parent 81a988833e
commit 66e3702680
21 changed files with 584 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

38
user/classes/search/user.php
View file

@ -41,12 +41,42 @@ class user extends \core_search\base {
* Returns recordset containing required data attributes for indexing.
*
* @param number $modifiedfrom
* @return \moodle_recordset
* @param \context|null $context Optional context to restrict scope of returned results
* @return \moodle_recordset|null Recordset (or null if no results)
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
return $DB->get_recordset_select('user', 'timemodified >= ? AND deleted = ? AND
confirmed = ?', array($modifiedfrom, 0, 1));
// Prepare query conditions.
$where = 'timemodified >= ? AND deleted = ? AND confirmed = ?';
$params = [$modifiedfrom, 0, 1];
// Handle context types.
if (!$context) {
$context = \context_system::instance();
}
switch ($context->contextlevel) {
case CONTEXT_MODULE:
case CONTEXT_BLOCK:
case CONTEXT_COURSE:
case CONTEXT_COURSECAT:
// These contexts cannot contain any users.
return null;
case CONTEXT_USER:
// Restrict to specific user.
$where .= ' AND id = ?';
$params[] = $context->instanceid;
break;
case CONTEXT_SYSTEM:
break;
default:
throw new \coding_exception('Unexpected contextlevel: ' . $context->contextlevel);
}
return $DB->get_recordset_select('user', $where, $params);
}
/**

10
user/tests/search_test.php
View file

@ -57,6 +57,7 @@ class user_search_testcase extends advanced_testcase {
* @return void
*/
public function test_users_indexing() {
global $SITE;
// Returns the instance as long as the area is supported.
$searcharea = \core_search\manager::get_search_area($this->userareaid);
@ -87,6 +88,15 @@ class user_search_testcase extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Context support; first, try an unsupported context type.
$coursecontext = context_course::instance($SITE->id);
$this->assertNull($searcharea->get_document_recordset(0, $coursecontext));
// Try a specific user, will only return 1 record (that user).
$rs = $searcharea->get_document_recordset(0, context_user::instance($user1->id));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
}
/**