Handler class for Core REST API endpoint that handles basic search. More...
Inherits MediaWiki\Rest\Handler.
Public Member Functions | |
| __construct (Config $config, SearchEngineFactory $searchEngineFactory, SearchEngineConfig $searchEngineConfig, SearchResultThumbnailProvider $searchResultThumbnailProvider, PermissionManager $permissionManager, RedirectLookup $redirectLookup, PageStore $pageStore, TitleFormatter $titleFormatter) | |
| execute () | |
| getParamSettings () | |
| Fetch ParamValidator settings for parameters. | |
| needsWriteAccess () | |
| Indicates whether this route requires write access. | |
 Public Member Functions inherited from MediaWiki\Rest\Handler | |
| applyCacheControl (ResponseInterface $response) | |
| Apply cache control to enforce privacy. | |
| applyConditionalResponseHeaders (ResponseInterface $response) | |
| Apply verifier headers to the response, per RFC 7231 ยง7.2. | |
| checkPreconditions () | |
| Check the conditional request headers and generate a response if appropriate. | |
| checkSession () | |
| Check the session (and session provider) | |
| getAuthority () | |
| Get the current acting authority. | |
| getBodyValidator ( $contentType) | |
| Fetch the BodyValidator. | |
| getConfig () | |
| Get the configuration array for the current route. | |
| getOpenApiSpec (string $method) | |
| Returns an OpenAPI Operation Object specification structure as an associative array. | |
| getPath () | |
| Returns the path this handler is bound to, including path variables. | |
| getRequest () | |
| Get the current request. | |
| getResponseFactory () | |
| Get the ResponseFactory which can be used to generate Response objects. | |
| getSession () | |
| Get the Session. | |
| getSupportedPathParams () | |
| Get a list of parameter placeholders present in the route's path as returned by getPath(). | |
| getValidatedBody () | |
| Fetch the validated body. | |
| getValidatedParams () | |
| Fetch the validated parameters. | |
| init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session) | |
| Initialise with dependencies from the Router. | |
| initContext (Router $router, array $routeConfig) | |
| Injects information about the handler's context in the Router. | |
| needsReadAccess () | |
| Indicates whether this route requires read rights. | |
| parseBodyData (RequestInterface $request) | |
| Returns the parsed body of the request. | |
| requireSafeAgainstCsrf () | |
| Indicates whether this route can be accessed only by session providers safe vs csrf. | |
| validate (Validator $restValidator) | |
| Validate the request parameters/attributes and body. | |
Public Attributes | |
| const | COMPLETION_MODE = 'completion' |
| Search title completion matches. | |
| const | FULLTEXT_MODE = 'fulltext' |
| Search page body and titles. | |
| Public Attributes inherited from MediaWiki\Rest\Handler | |
| const | KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES |
| const | PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION |
| const | PARAM_SOURCE = Validator::PARAM_SOURCE |
Protected Member Functions | |
| postInitSetup () | |
| The handler can override this to do any necessary setup after init() is called to inject the dependencies. | |
| Protected Member Functions inherited from MediaWiki\Rest\Handler | |
| detectExtraneousBodyFields (Validator $restValidator) | |
| Subclasses may override this to disable or modify checks for extraneous body fields. | |
| getConditionalHeaderUtil () | |
| Get a ConditionalHeaderUtil object. | |
| getETag () | |
| The subclass should override this to provide an ETag for the current state of the requested resource. | |
| getHookContainer () | |
| Get a HookContainer, for running extension hooks or for hook metadata. | |
| getHookRunner () | |
| Get a HookRunner for running core hooks. | |
| getLastModified () | |
| The subclass should override this to provide the maximum last modified timestamp of the requested resource. | |
| getRequestSpec () | |
| Returns an OpenAPI Request Body Object specification structure as an associative array. | |
| getResponseBodySchema () | |
| Returns an OpenAPI Schema Object specification structure as an associative array. | |
| getResponseSpec () | |
| Returns an OpenAPI Responses Object specification structure as an associative array. | |
| getRouter () | |
| Get the Router. | |
| getRouteUrl ( $pathParams=[], $queryParams=[]) | |
| Get the URL of this handler's endpoint. | |
| hasRepresentation () | |
| The subclass should override this to indicate whether the resource exists. | |
| postValidationSetup () | |
| The handler can override this to do any necessary setup after validate() has been called. | |
| urlEncodeTitle ( $title) | |
| URL-encode titles in a "pretty" way. | |
Detailed Description
Handler class for Core REST API endpoint that handles basic search.
Definition at line 33 of file SearchHandler.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Rest\Handler\SearchHandler::__construct | ( | Config | $config, |
| SearchEngineFactory | $searchEngineFactory, | ||
| SearchEngineConfig | $searchEngineConfig, | ||
| SearchResultThumbnailProvider | $searchResultThumbnailProvider, | ||
| PermissionManager | $permissionManager, | ||
| RedirectLookup | $redirectLookup, | ||
| PageStore | $pageStore, | ||
| TitleFormatter | $titleFormatter ) |
- Parameters
-
Config $config SearchEngineFactory $searchEngineFactory SearchEngineConfig $searchEngineConfig SearchResultThumbnailProvider $searchResultThumbnailProvider PermissionManager $permissionManager RedirectLookup $redirectLookup PageStore $pageStore TitleFormatter $titleFormatter
Definition at line 104 of file SearchHandler.php.
References MediaWiki\Config\Config\get(), and MediaWiki\MainConfigNames\SearchSuggestCacheExpiry.
Member Function Documentation
◆ execute()
| MediaWiki\Rest\Handler\SearchHandler::execute | ( | ) |
- Returns
- Response
- Exceptions
-
LocalizedHttpException
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 382 of file SearchHandler.php.
References MediaWiki\Page\PageIdentity\exists().
◆ getParamSettings()
| MediaWiki\Rest\Handler\SearchHandler::getParamSettings | ( | ) |
Fetch ParamValidator settings for parameters.
Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.
Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().
For "query" and "body" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.
- Stability: stable
- to override
- Returns
- array[] Associative array mapping parameter names to ParamValidator settings arrays
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 424 of file SearchHandler.php.
◆ needsWriteAccess()
| MediaWiki\Rest\Handler\SearchHandler::needsWriteAccess | ( | ) |
Indicates whether this route requires write access.
The handler should override this if the route does not need to write to the database.
This should return true for routes that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure.
- Stability: stable
- to override
- Returns
- bool
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 149 of file SearchHandler.php.
◆ postInitSetup()
|
protected |
The handler can override this to do any necessary setup after init() is called to inject the dependencies.
- Stability: stable
- to override
Reimplemented from MediaWiki\Rest\Handler.
Definition at line 126 of file SearchHandler.php.
References MediaWiki\Rest\Handler\SearchHandler\FULLTEXT_MODE, and MediaWiki\Rest\Handler\getConfig().
Member Data Documentation
◆ COMPLETION_MODE
| const MediaWiki\Rest\Handler\SearchHandler::COMPLETION_MODE = 'completion' |
Search title completion matches.
Definition at line 65 of file SearchHandler.php.
◆ FULLTEXT_MODE
| const MediaWiki\Rest\Handler\SearchHandler::FULLTEXT_MODE = 'fulltext' |
Search page body and titles.
Definition at line 60 of file SearchHandler.php.
Referenced by MediaWiki\Rest\Handler\SearchHandler\postInitSetup().
The documentation for this class was generated from the following file:
- includes/Rest/Handler/SearchHandler.php
