weekly release 3.5dev
[moodle.git] / search / upgrade.txt
CommitLineData
5f654ea2
DM
1This files describes API changes in /search/*,
2information provided here is intended especially for developers.
3
25564a78 4=== 3.5 ===
5
6* Search areas may now optionally implement the get_contexts_to_reindex function (for modules and
7 blocks, see also get_contexts_to_reindex_extra_sql). This allows a search area to customise the
8 order in which it is reindexed when doing a gradual reindex, so as to reindex the most important
65da6840 9 contexts first. If not implemented, the default behaviour for modules and blocks is to reindex
10 the newest items first; for other types of search area it will just index the whole system
11 context, oldest data first.
fc440796 12* Search engines may now implement get_supported_orders function to provide multiple ordering
13 options (other than 'relevance' which is default). If there is more than one order then a choice
14 will be shown to users. (This is an optional feature, existing search engine plugins do not need
15 to be modified in order to continue working.)
25564a78 16
4359ef18 17* Module search areas that wish to support group filtering should set the new optional search
18 document field groupid (note: to remain compatible with earlier versions, do this inside an if
19 statement so that it only happens on 3.4+) and return true to the supports_group_restriction
20 function. See documentation in \core_search\base_mod class and example in \mod_forum\search\post.
21
22* When a search engine supports group filtering, the \core_search\manager::search function now
23 accepts the optional 'groupids' parameter in its $data input. This parameter is an array of one
24 or more group IDs. If supplied, only results from those groups will be returned.
25
26* Search engine plugins will need to be be modified if they wish to support group filtering.
27 (Search engines should continue to work unmodified, but will not then support group filtering.)
28 The modification steps are:
29 - Implement the new update_schema function to make the schema change (add groupid field).
30 - Ensure that the groupid field is stored correctly when provided in a document while indexing.
31 - Return true to new supports_group_filtering() function.
32 - execute_query should support the new $data->groupids parameter (to allow users to restrict
33 search results to specific groups) and the modified meaning of the second parameter,
34 $accessinfo (to automatically restrict search results users cannot access due to groups).
35 See implementation in Solr search engine.
36
67d64795 37=== 3.4 ===
38
39* Search indexing now supports time limits to make the scheduled task run more neatly. In order for
40 this to work, search engine plugins will need to implement the 'stopat' parameter if they
41 override the add_documents() function, and return an extra parameter from this function (see base
42 class in engine.php). Unmodified plugins will still work, but without supporting time limits.
427b7563 43* Search areas should now implement the get_document_recordset function instead of the old
44 get_recordset_by_timestamp API (implement both if the area should work in older Moodle versions
45 as well). The new function is the same as the old one, but has an additional context parameter.
46 There is a helper function get_context_restriction_sql to make this easy to implement; see code
47 in base_activity.php for an example of how to implement this in your search area. (The
48 change was required to make search work after restoring sites. It also allows more flexible
49 reindexing in other cases.)
67d64795 50
5f654ea2
DM
51=== 3.2 ===
52
53* Base search area classes have been renamed, please update your search areas to use the classes below:
54 - \core_search\area\base has been renamed to \core_search\base
55 - \core_search\area\base_mod has been renamed to \core_search\base_mod
56 - \core_search\area\base_activity has been renamed to \core_search\base_activity