Document the changes in search

Closes #250

diff --git a/docs/migration/wsc54/deprecations_removals.md b/docs/migration/wsc54/deprecations_removals.md
index 304ecca490a73f71077d911feab2192c819d8f97..3cd1a987697d7ec01ea4e1c494b3b334016c7e3d 100644 (file)
--- a/docs/migration/wsc54/deprecations_removals.md
+++ b/docs/migration/wsc54/deprecations_removals.md
@@ -13,10 +13,14 @@ With version 5.5, we have deprecated certain components and removed several othe
 - `filebase\system\file\FileDataHandler` (use `filebase\system\cache\runtime\FileRuntimeCache`)
 - `wcf\action\AbstractAjaxAction` (use PSR-7 responses, [WoltLab/WCF#4437](https://github.com/WoltLab/WCF/pull/4437))
 - `wcf\data\IExtendedMessageQuickReplyAction` ([WoltLab/WCF#4575](https://github.com/WoltLab/WCF/pull/4575))
+- `wcf\form\SearchForm` (see [WoltLab/WCF#4605](https://github.com/WoltLab/WCF/pull/4605))
 - `wcf\page\AbstractSecurePage` ([WoltLab/WCF#4515](https://github.com/WoltLab/WCF/pull/4515))
+- `wcf\page\SearchResultPage` (see [WoltLab/WCF#4605](https://github.com/WoltLab/WCF/pull/4605))
 - `wcf\system\exception\ILoggingAwareException` ([WoltLab/WCF#4547](https://github.com/WoltLab/WCF/pull/4547))
 - `wcf\system\io\FTP` (directly use the FTP extension)
+- `wcf\system\search\AbstractSearchableObjectType` (use `AbstractSearchProvider` instead, see [WoltLab/WCF#4605](https://github.com/WoltLab/WCF/pull/4605))
 - `wcf\system\search\elasticsearch\ElasticsearchException`
+- `wcf\system\search\ISearchableObjectType` (use `ISearchProvider` instead, see [WoltLab/WCF#4605](https://github.com/WoltLab/WCF/pull/4605))
 - `wcf\util\PasswordUtil`
 
 #### Methods
@@ -71,6 +75,16 @@ With version 5.5, we have deprecated certain components and removed several othe
 - `wcf1_package_update_compatibility` ([WoltLab/WCF#4385](https://github.com/WoltLab/WCF/pull/4385))
 - `wcf1_package_update_optional` ([WoltLab/WCF#4432](https://github.com/WoltLab/WCF/pull/4432))
 
+### Templates
+
+#### Template Events
+
+- `search::queryOptions`
+- `search::authorOptions`
+- `search::periodOptions`
+- `search::displayOptions`
+- `search::generalFields`
+
 ### Miscellaneous
 
 - The global option to set a specific style with a request parameter (`$_REQUEST['styleID']`) is deprecated ([WoltLab/WCF@0c0111e946](https://github.com/WoltLab/WCF/commit/0c0111e9466e951d867f43869f040ea4aa27c738))
@@ -156,6 +170,7 @@ With version 5.5, we have deprecated certain components and removed several othe
 - `MODULE_SYSTEM_RECAPTCHA` ([WoltLab/WCF#4305](https://github.com/WoltLab/WCF/pull/4305))
 - `PROFILE_MAIL_USE_CAPTCHA` ([WoltLab/WCF#4399](https://github.com/WoltLab/WCF/pull/4399))
 - The `may` value for `MAIL_SMTP_STARTTLS` ([WoltLab/WCF#4398](https://github.com/WoltLab/WCF/pull/4398))
+- `SEARCH_USE_CAPTCHA` (see [WoltLab/WCF#4605](https://github.com/WoltLab/WCF/pull/4605))
 
 #### Files
 
@@ -190,3 +205,26 @@ With version 5.5, we have deprecated certain components and removed several othe
 - `wbb.search.boards.all`
 - `wcf.global.form.error.greaterThan.javaScript` ([WoltLab/WCF#4306](https://github.com/WoltLab/WCF/pull/4306))
 - `wcf.global.form.error.lessThan.javaScript` ([WoltLab/WCF#4306](https://github.com/WoltLab/WCF/pull/4306))
+- `wcf.search.type.keywords`
+- `wcf.acp.option.search_use_captcha`
+- `wcf.search.query.description`
+- `wcf.search.results.change`
+- `wcf.search.results.description`
+- `wcf.search.general`
+- `wcf.search.query`
+- `wcf.search.error.noMatches`
+- `wcf.search.error.user.noMatches`
+
+
+### Templates
+
+#### Templates
+
+- `searchResult`
+
+#### Template Events
+
+- `search::tabMenuTabs`
+- `search::sections`
+- `tagSearch::tabMenuTabs`
+- `tagSearch::sections`

diff --git a/docs/migration/wsc54/php.md b/docs/migration/wsc54/php.md
index 8ac49ee6bde8c9990bfaeab73cd2e856c2d7b66e..fbc7f11305a57cdf8608650f7a4e877026f3e4bd 100644 (file)
--- a/docs/migration/wsc54/php.md
+++ b/docs/migration/wsc54/php.md
@@ -270,6 +270,17 @@ See [WoltLab/WCF#4398](https://github.com/WoltLab/WCF/pull/4398) for details.
 
 ## Search
 
+### Search Form
+
+After the overhaul of the search form, search providers are no longer bound to `SearchForm` and `SearchResultPage`. 
+The interface `ISearchObjectType` and the abstract implementation `AbstractSearchableObjectType` have been replaced by `ISearchProvider` and `AbstractSearchProvider`.
+
+Please use [`ArticleSearch`](https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/search/ArticleSearch.class.php) as a template for your own implementation
+
+See [WoltLab/WCF#4605](https://github.com/WoltLab/WCF/pull/4605) for details.
+
+### Exceptions
+
 A new [`wcf\system\search\exception\SearchFailed`](https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/search/exception/SearchFailed.class.php) exception was added.
 This exception should be thrown when executing the search query fails for (mostly) temporary reasons, such as a network partition to a remote service.
 It is not meant as a blanket exception to wrap everything.