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

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

View file

@ -56,17 +56,25 @@ class post extends \core_search\base_mod {
* Returns recordset containing required data for indexing forum posts.
*
* @param int $modifiedfrom timestamp
* @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;
$sql = 'SELECT fp.*, f.id AS forumid, f.course AS courseid
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, 'forum', 'f');
if ($contextjoin === null) {
return null;
}
$sql = "SELECT fp.*, f.id AS forumid, f.course AS courseid
FROM {forum_posts} fp
JOIN {forum_discussions} fd ON fd.id = fp.discussion
JOIN {forum} f ON f.id = fd.forum
WHERE fp.modified >= ? ORDER BY fp.modified ASC';
return $DB->get_recordset_sql($sql, array($modifiedfrom));
$contextjoin
WHERE fp.modified >= ? ORDER BY fp.modified ASC";
return $DB->get_recordset_sql($sql, array_merge($contextparams, [$modifiedfrom]));
}
/**

View file

@ -144,6 +144,26 @@ class mod_forum_search_testcase extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Context test: create another forum with 1 post.
$forum2 = self::getDataGenerator()->create_module('forum', ['course' => $course1->id]);
$record = new stdClass();
$record->course = $course1->id;
$record->userid = $user1->id;
$record->forum = $forum2->id;
$record->message = 'discussion';
self::getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
// Test indexing with each forum then combined course context.
$rs = $searcharea->get_document_recordset(0, context_module::instance($forum1->cmid));
$this->assertEquals(2, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_module::instance($forum2->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_course::instance($course1->id));
$this->assertEquals(3, iterator_count($rs));
$rs->close();
}
/**