Document the removal of AbstractSearchEngine::parseSearchQuery() (#112)
authorTim Düsterhus <duesterhus@woltlab.com>
Tue, 22 Dec 2020 13:30:55 +0000 (14:30 +0100)
committerGitHub <noreply@github.com>
Tue, 22 Dec 2020 13:30:55 +0000 (14:30 +0100)
Resolves #109

Co-authored-by: Matthias Schmidt <gravatronics@live.com>
pages/migration/wsc-53/migration_wsc-53_php.md

index cbe5f9576f293db3233a44c6c351c4a47bd41c55..3ed2cbd95989fa8895b15d417be8f682a68ad7a4 100644 (file)
@@ -75,3 +75,13 @@ The reCAPTCHA v1 endpoints have already been turned off by Google and always ret
 Thus the implementation was completely non-functional even before this change.
 
 See [WoltLab/WCF#3781](https://github.com/WoltLab/WCF/pull/3781) for details.
+
+## Search
+
+The generic implementation in the `AbstractSearchEngine::parseSearchQuery()` method was dangerous, because it did not have knowledge about the search engine’s specifics.
+The implementation was completely removed: `AbstractSearchEngine::parseSearchQuery()` now always throws a `\BadMethodCallException`.
+
+If you implemented a custom search engine and relied on this method, you can inline the previous implementation to preserve existing behavior.
+You should take the time to verify the rewritten queries against the manual of the search engine to make sure it cannot generate malformed queries or security issues.
+
+See [WoltLab/WCF#3815](https://github.com/WoltLab/WCF/issues/3815) for details.