Class CodeIgniter\HTTP\Negotiate


					
	public

__construct(?RequestInterface $request = null)

Constructor

#


					
	public

setRequest(RequestInterface $request): $this

Stores the request instance to grab the headers from.

#


					
	public

media(array $supported, bool $strictMatch = false): string

Determines the best content-type to use based on the $supported types the application says it supports, and the types…

Determines the best content-type to use based on the $supported types the application says it supports, and the types requested by the client.

If no match is found, the first, highest-ranking client requested type is returned.

Parameters

$strictMatch

If TRUE, will return an empty string when no match found. If FALSE, will return the first supported element.

#


					
	public

charset(array $supported): string

Determines the best charset to use based on the $supported types the application says it supports, and the types…

Determines the best charset to use based on the $supported types the application says it supports, and the types requested by the client.

If no match is found, the first, highest-ranking client requested type is returned.

#


					
	public

encoding(array $supported = []): string

Determines the best encoding type to use based on the $supported types the application says it supports, and the types…

Determines the best encoding type to use based on the $supported types the application says it supports, and the types requested by the client.

If no match is found, the first, highest-ranking client requested type is returned.

#


					
	public

language(array $supported): string

Determines the best language to use based on the $supported types the application says it supports, and the types…

Determines the best language to use based on the $supported types the application says it supports, and the types requested by the client.

If no match is found, the first, highest-ranking client requested type is returned.

#


					
	protected

getBestMatch(
	array $supported,
	string $header = null,
	bool $enforceTypes = false,
	bool $strictMatch = false,
	bool $matchLocales = false,
): string

Does the grunt work of comparing any of the app-supported values against a given Accept* header string.

Portions of this code base on Aura.Accept library.

Parameters

`$supported`	App-supported values
`$header`	header string
`$enforceTypes`	If TRUE, will compare media types and sub-types.
`$strictMatch`	If TRUE, will return empty string on no match. If FALSE, will return the first supported element.
`$matchLocales`	If TRUE, will match locale sub-types to a broad type (fr-FR = fr)

Returns

Best match

#


					
	public

parseHeader(string $header): array

Parses an Accept* header into it's multiple values.

This is based on code from Aura.Accept library.

#


					
	protected

match(array $acceptable, string $supported, bool $enforceTypes = false, bool $matchLocales = false): bool

Match-maker

#


					
	protected

matchParameters(array $acceptable, array $supported): bool

Checks two Accept values with matching 'values' to see if their 'params' are the same.

#


					
	public

matchTypes(array $acceptable, array $supported): bool

Compares the types/subtypes of an acceptable Media type and the supported string.

#


					
	public

matchLocales(array $acceptable, array $supported): bool

Will match locales against their broader pairs, so that fr-FR would match a supported localed of fr

#

Namespaces

Classes

Interfaces

Traits

Class CodeIgniter\HTTP\Negotiate

Parameters

Parameters

Returns