weekly release 3.8dev
[moodle.git] / search / upgrade.txt
1This files describes API changes in /search/*,
2information provided here is intended especially for developers.
4=== 3.8 ===
6* Search indexing supports time limits to make the scheduled task run more neatly since 3.4. In order for
7 this to work, search engine plugins will need to implement the 'stopat' parameter if they
8 override the add_documents() function, and return an extra parameter from this function (see base
9 class in engine.php). Unmodified plugins will not work anymore.
11=== 3.7 ===
13* Search areas now have categories and can optionally implement get_category_names method to
14 display search results of the area in the required tab on the search results screen (if this
15 feature is enabled).
16* Added a new call back search_area_categories. Plugins can implement this method in lib.php and
17 return a list of custom search area categories (\core_search\area_category) and associated with
18 them search areas. This will bring additional custom tabs to the search results screen.
19* Added \core_search\manager::clean_up_non_existing_area method to clean up removed or renamed
20 search areas. To support that a new adhoc task core\task\clean_up_deleted_search_area_task
21 added.
25564a78 23=== 3.5 ===
25* Search areas may now optionally implement the get_contexts_to_reindex function (for modules and
26 blocks, see also get_contexts_to_reindex_extra_sql). This allows a search area to customise the
27 order in which it is reindexed when doing a gradual reindex, so as to reindex the most important
65da6840 28 contexts first. If not implemented, the default behaviour for modules and blocks is to reindex
29 the newest items first; for other types of search area it will just index the whole system
30 context, oldest data first.
fc440796 31* Search engines may now implement get_supported_orders function to provide multiple ordering
32 options (other than 'relevance' which is default). If there is more than one order then a choice
33 will be shown to users. (This is an optional feature, existing search engine plugins do not need
34 to be modified in order to continue working.)
4359ef18 35* Module search areas that wish to support group filtering should set the new optional search
36 document field groupid (note: to remain compatible with earlier versions, do this inside an if
37 statement so that it only happens on 3.4+) and return true to the supports_group_restriction
38 function. See documentation in \core_search\base_mod class and example in \mod_forum\search\post.
4359ef18 39* When a search engine supports group filtering, the \core_search\manager::search function now
40 accepts the optional 'groupids' parameter in its $data input. This parameter is an array of one
41 or more group IDs. If supplied, only results from those groups will be returned.
4359ef18 42* Search engine plugins will need to be be modified if they wish to support group filtering.
43 (Search engines should continue to work unmodified, but will not then support group filtering.)
44 The modification steps are:
45 - Implement the new update_schema function to make the schema change (add groupid field).
46 - Ensure that the groupid field is stored correctly when provided in a document while indexing.
47 - Return true to new supports_group_filtering() function.
48 - execute_query should support the new $data->groupids parameter (to allow users to restrict
49 search results to specific groups) and the modified meaning of the second parameter,
50 $accessinfo (to automatically restrict search results users cannot access due to groups).
51 See implementation in Solr search engine.
73fd5666 52* Search engine plugins can optionally use a new $this->should_skip_schema_check() function to
53 decide when to skip slow schema checking inside the is_server_ready function, improving user
54 performance on the search page. The Solr plugin implements this.
55* API function \core_search\manager::instance() now includes a $fast parameter to skip schema
56 checks (as above).
4359ef18 57
222a97ce 58* Search engines should now implement the 'userids' option to restrict search results to those from
59 specific users, and return true to the new supports_users() function. The supplied Solr search
60 engine includes this feature. If this is not implemented, the search engine will continue to work
61 but the 'Users' search option will not appear.
67d64795 63=== 3.4 ===
65* Search indexing now supports time limits to make the scheduled task run more neatly. In order for
66 this to work, search engine plugins will need to implement the 'stopat' parameter if they
67 override the add_documents() function, and return an extra parameter from this function (see base
68 class in engine.php). Unmodified plugins will still work, but without supporting time limits.
427b7563 69* Search areas should now implement the get_document_recordset function instead of the old
70 get_recordset_by_timestamp API (implement both if the area should work in older Moodle versions
71 as well). The new function is the same as the old one, but has an additional context parameter.
72 There is a helper function get_context_restriction_sql to make this easy to implement; see code
73 in base_activity.php for an example of how to implement this in your search area. (The
74 change was required to make search work after restoring sites. It also allows more flexible
75 reindexing in other cases.)
67d64795 76
77=== 3.2 ===
79* Base search area classes have been renamed, please update your search areas to use the classes below:
80 - \core_search\area\base has been renamed to \core_search\base
81 - \core_search\area\base_mod has been renamed to \core_search\base_mod
82 - \core_search\area\base_activity has been renamed to \core_search\base_activity