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.

Private Member Functions
	allowOrigin (Origin $origin)
	getCanonicalDomain ()

Private Attributes
ServiceOptions	$options
ResponseFactory	$responseFactory
UserIdentity	$user

Detailed Description

Access: internal

Definition at line 13 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 38 of file CorsUtils.php.

References MediaWiki\Rest\CorsUtils\$options, MediaWiki\Rest\CorsUtils\$responseFactory, MediaWiki\Rest\CorsUtils\$user, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

allowOrigin()

MediaWiki\Rest\CorsUtils::allowOrigin ( Origin  $origin )

private

Parameters

Origin

$origin

Returns

bool

Definition at line 79 of file CorsUtils.php.

Referenced by MediaWiki\Rest\CorsUtils\authorize().

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 57 of file CorsUtils.php.

References MediaWiki\Rest\CorsUtils\allowOrigin(), 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 162 of file CorsUtils.php.

getCanonicalDomain()

MediaWiki\Rest\CorsUtils::getCanonicalDomain ( )

private

Returns

string

Definition at line 89 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 107 of file CorsUtils.php.

Member Data Documentation

$options

ServiceOptions MediaWiki\Rest\CorsUtils::$options

private

Initial value:

=[,,,,,,]
    public const CONSTRUCTOR_OPTIONS  
        'AllowedCorsHeaders'
        'AllowCrossOrigin'
        'RestAllowCrossOriginCookieAuth'
        'CanonicalServer'
        'CrossSiteAJAXdomains'
        'CrossSiteAJAXdomainExceptions'

Definition at line 25 of file CorsUtils.php.

Referenced by MediaWiki\Rest\CorsUtils\__construct().

$responseFactory

ResponseFactory MediaWiki\Rest\CorsUtils::$responseFactory

private

Definition at line 28 of file CorsUtils.php.

Referenced by MediaWiki\Rest\CorsUtils\__construct().

$user

UserIdentity MediaWiki\Rest\CorsUtils::$user

private

Definition at line 31 of file CorsUtils.php.

Referenced by MediaWiki\Rest\CorsUtils\__construct().

---

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

• includes/Rest/CorsUtils.php