MediaWiki  master
MediaWiki\Rest\Handler\SearchHandler Class Reference

Handler class for Core REST API endpoint that handles basic search. More...

Inheritance diagram for MediaWiki\Rest\Handler\SearchHandler:
Collaboration diagram for MediaWiki\Rest\Handler\SearchHandler:

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. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyCacheControl (ResponseInterface $response)
 Apply cache control to enforce privacy. More...
 
 applyConditionalResponseHeaders (ResponseInterface $response)
 Apply verifier headers to the response, per RFC 7231 ยง7.2. More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 checkSession ()
 Check the session (and session provider) More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getSession ()
 Get the Session. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Public Attributes

const COMPLETION_MODE = 'completion'
 Search title completion matches. More...
 
const FULLTEXT_MODE = 'fulltext'
 Search page body and titles. More...
 
- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter. More...
 

Protected Member Functions

 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current state of the requested resource. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp of the requested resource. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. More...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

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 103 of file SearchHandler.php.

References 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 385 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().

Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 427 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 148 of file SearchHandler.php.

◆ postInitSetup()

MediaWiki\Rest\Handler\SearchHandler::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 125 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 64 of file SearchHandler.php.

◆ FULLTEXT_MODE

const MediaWiki\Rest\Handler\SearchHandler::FULLTEXT_MODE = 'fulltext'

Search page body and titles.

Definition at line 59 of file SearchHandler.php.

Referenced by MediaWiki\Rest\Handler\SearchHandler\postInitSetup().


The documentation for this class was generated from the following file: