MediaWiki\Rest\HeaderParser\Origin Class Reference

A class to assist with the parsing of Origin header according to the RFC 6454 https://tools.ietf.org/html/rfc6454#section-7. More...

Inheritance diagram for MediaWiki\Rest\HeaderParser\Origin:

Collaboration diagram for MediaWiki\Rest\HeaderParser\Origin:

Public Member Functions
	getOriginList ()
	Get the list of origins.
	getSingleOrigin ()
	isMultiOrigin ()
	Whether the Origin header contains multiple origins.
	isNullOrigin ()
	Whether the Origin header was explicitly set to null.
	match (array $allowList, array $excludeList)
	Check whether all the origins match at least one of the rules in $allowList.

Static Public Member Functions
static	parseHeaderList (array $headerList)
	Parse an Origin header list as returned by RequestInterface::getHeader().

Public Attributes
const	HEADER_NAME = 'Origin'

Private Member Functions
	__construct (array $input)
	Private constructor.
	execute ()

Static Private Member Functions
static	matchSingleOrigin (string $origin, array $allowList, array $excludeList)
	Checks whether the origin matches at list one of the provided rules in $allowList.
static	wildcardToRegex ( $wildcard)
	Helper function to convert wildcard string into a regex '*' => '.

Private Attributes
bool	$isNullOrigin
	whether the origin was set to null
array	$origins = []
	List of specified origins.

Additional Inherited Members
Protected Member Functions inherited from MediaWiki\Rest\HeaderParser\HeaderParserBase
	assertEnd ()
	If the position is not at the end of the input string, raise an error, complaining of trailing characters.
	consumeFixedDigits ( $numDigits)
	Consume a specified number of digits, or throw an exception.
	consumeString ( $s)
	Consume a specified string, or throw an exception.
	error ( $message)
	Throw an exception to indicate a parse error.
	setInput ( $input)
	Set the input, and derived convenience properties.
	skipWhitespace ()
	Skip whitespace at the input position (OWS)
Protected Attributes inherited from MediaWiki\Rest\HeaderParser\HeaderParserBase
string	$input
	The input string being processed.
int	$inputLength
	The length of $input.
int	$pos
	The position within $input.

Detailed Description

A class to assist with the parsing of Origin header according to the RFC 6454 https://tools.ietf.org/html/rfc6454#section-7.

Since

1.36

Definition at line 12 of file Origin.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Rest\HeaderParser\Origin::__construct ( array  $input )

private

Private constructor.

Use the public static functions for public access.

Parameters

string[]

$input

Definition at line 120 of file Origin.php.

Member Function Documentation

execute()

MediaWiki\Rest\HeaderParser\Origin::execute ( )

private

Definition at line 127 of file Origin.php.

getOriginList()

MediaWiki\Rest\HeaderParser\Origin::getOriginList

(

)

Get the list of origins.

Returns

string[]

Definition at line 57 of file Origin.php.

getSingleOrigin()

MediaWiki\Rest\HeaderParser\Origin::getSingleOrigin

(

)

Returns

string

Definition at line 64 of file Origin.php.

isMultiOrigin()

MediaWiki\Rest\HeaderParser\Origin::isMultiOrigin

(

)

Whether the Origin header contains multiple origins.

Returns

bool

Definition at line 48 of file Origin.php.

isNullOrigin()

MediaWiki\Rest\HeaderParser\Origin::isNullOrigin

(

)

Whether the Origin header was explicitly set to null.

Returns

bool

Definition at line 39 of file Origin.php.

match()

MediaWiki\Rest\HeaderParser\Origin::match	(	array	$allowList,
		array	$excludeList
	)

Check whether all the origins match at least one of the rules in $allowList.

Parameters

string[]	$allowList
string[]	$excludeList

Returns

bool

Definition at line 77 of file Origin.php.

matchSingleOrigin()

static MediaWiki\Rest\HeaderParser\Origin::matchSingleOrigin ( string  $origin, array  $allowList, array  $excludeList  )

staticprivate

Checks whether the origin matches at list one of the provided rules in $allowList.

Parameters

string	$origin
array	$allowList
array	$excludeList

Returns

bool

Definition at line 98 of file Origin.php.

parseHeaderList()

static MediaWiki\Rest\HeaderParser\Origin::parseHeaderList ( array  $headerList )

static

Parse an Origin header list as returned by RequestInterface::getHeader().

Parameters

string[]

$headerList

Returns

self

Definition at line 28 of file Origin.php.

wildcardToRegex()

static MediaWiki\Rest\HeaderParser\Origin::wildcardToRegex (   $wildcard )

staticprivate

Helper function to convert wildcard string into a regex '*' => '.

*?' '?' => '.'

Parameters

string

$wildcard

String with wildcards

Returns

string Regular expression

Definition at line 147 of file Origin.php.

Member Data Documentation

$isNullOrigin

bool MediaWiki\Rest\HeaderParser\Origin::$isNullOrigin

private

whether the origin was set to null

Definition at line 17 of file Origin.php.

$origins

array MediaWiki\Rest\HeaderParser\Origin::$origins = []

private

List of specified origins.

Definition at line 20 of file Origin.php.

HEADER_NAME

const MediaWiki\Rest\HeaderParser\Origin::HEADER_NAME = 'Origin'

Definition at line 14 of file Origin.php.

---

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

• includes/Rest/HeaderParser/Origin.php