MediaWiki REL1_39
MediaWiki\Rest\CorsUtils Class Reference
Inheritance diagram for MediaWiki\Rest\CorsUtils:
Collaboration diagram for MediaWiki\Rest\CorsUtils:

Public Member Functions

 __construct (ServiceOptions $options, ResponseFactory $responseFactory, UserIdentity $user)
 
 authorize (RequestInterface $request, Handler $handler)
 Only allow registered users to make unsafe cross-origin requests.
 
 createPreflightResponse (array $allowedMethods)
 Create a CORS preflight response.
 
 modifyResponse (RequestInterface $request, ResponseInterface $response)
 Modify response to allow for CORS.
 

Detailed Description

Access: internal

Definition at line 14 of file CorsUtils.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\CorsUtils::__construct ( ServiceOptions $options,
ResponseFactory $responseFactory,
UserIdentity $user )
Parameters
ServiceOptions$options
ResponseFactory$responseFactory
UserIdentity$user

Definition at line 39 of file CorsUtils.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ authorize()

MediaWiki\Rest\CorsUtils::authorize ( RequestInterface $request,
Handler $handler )

Only allow registered users to make unsafe cross-origin requests.

Parameters
RequestInterface$request
Handler$handler
Returns
string|null If the request is denied, the string error code. If the request is allowed, null.

Implements MediaWiki\Rest\BasicAccess\BasicAuthorizerInterface.

Definition at line 58 of file CorsUtils.php.

References MediaWiki\Rest\RequestInterface\getHeader(), MediaWiki\Rest\RequestInterface\hasHeader(), and MediaWiki\Rest\Handler\needsWriteAccess().

◆ createPreflightResponse()

MediaWiki\Rest\CorsUtils::createPreflightResponse ( array $allowedMethods)

Create a CORS preflight response.

Parameters
array$allowedMethods
Returns
ResponseInterface

Definition at line 164 of file CorsUtils.php.

◆ modifyResponse()

MediaWiki\Rest\CorsUtils::modifyResponse ( RequestInterface $request,
ResponseInterface $response )

Modify response to allow for CORS.

This method should be executed for every response from the REST API including errors.

Parameters
RequestInterface$request
ResponseInterface$response
Returns
ResponseInterface

Definition at line 109 of file CorsUtils.php.


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