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

Inherits MediaWiki\Rest\HeaderParser\HeaderParserBase.

Collaboration diagram for MediaWiki\Rest\HeaderParser\Origin:

[legend]

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'

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.

Member Function Documentation

◆ 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.

◆ 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.

Member Data Documentation

◆ 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

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members