1. class
  2. NoreSources
  3. \
  4. MediaType
  5. \
  6. MediaRange

MediaRange

class MediaRange implements MediaTypeInterface (View source)

Traits

MediaTypeStructuredTextTrait
MediaTypeParameterMapTrait
MediaTypeSerializableTrait
MediaRangeMatchingTrait
Default implementation of the MediaTypeInterface::match() method
MediaTypeCompareTrait
StructuredSyntaxMatchingTrait
ParameterMapProviderTrait

Methods

string|NULL
getStructuredSyntax(boolean $registeredOnly = false)

No description

from MediaTypeStructuredTextTrait
setParameters($parameters)

No description

from MediaTypeParameterMapTrait
jsonSerialize()

No description

from MediaTypeSerializableTrait
string
serializeToString()

No description

from MediaTypeSerializableTrait
static string
serializeMediaTypeInterfaceToString(MediaTypeInterface $mediaType)

No description

from MediaTypeSerializableTrait
static MediaTypeInterface
unserializeMediaTypeInterfaceInterface(string $className, string $pattern, string $mediaTypeString, boolean $withParameters)

No description

from MediaTypeSerializableTrait
serialize()

No description

from MediaTypeSerializableTrait
unserialize($serialized)

No description

from MediaTypeSerializableTrait
static 
isMediaTypeMatchMediaRange($mediaType, $mediaRange)

No description

from MediaRangeMatchingTrait
compare(MediaTypeInterface|MediaSubType|string $b)

Compare media range precision

from MediaTypeCompareTrait
static 
matchStructuredSyntax($a, $b)

No description

from StructuredSyntaxMatchingTrait
__construct(string $type = self::ANY, string $subType = self::ANY)

No description

string
getType()

No description

MediaSubType|string
getSubType()

No description

__toString()

No description

__clone()

No description

true
match(MediaTypeInterface|string $mediaRange)

Check if the MediaType instance match the given MediaRange

static MediaRange
createFromString(string $mediaTypeString, boolean $withParameters = false)

No description

static number
compareMediaRanges(MediaTypeInterface $a, MediaTypeInterface $b)

Compare media range precision

Details

in MediaTypeStructuredTextTrait at line 23
string|NULL getStructuredSyntax(boolean $registeredOnly = false)

Parameters

boolean $registeredOnly Return type only if it is a registered type

Return Value

string|NULL Structured syntax type if any. NULL otherwise

in MediaTypeParameterMapTrait at line 17
protected setParameters($parameters)

Parameters

$parameters

in MediaTypeSerializableTrait at line 25
jsonSerialize()

in MediaTypeSerializableTrait at line 34
string serializeToString()

Return Value

string Media type and parameter string representation

in MediaTypeSerializableTrait at line 43
static string serializeMediaTypeInterfaceToString(MediaTypeInterface $mediaType)

Parameters

MediaTypeInterface $mediaType

Return Value

string Media Type / Range and parameters

in MediaTypeSerializableTrait at line 67
static MediaTypeInterface unserializeMediaTypeInterfaceInterface(string $className, string $pattern, string $mediaTypeString, boolean $withParameters)

Parameters

string $className MediaTypeInterface class
string $pattern Media type string
string $mediaTypeString Media type string
boolean $withParameters Also parse parameters

Return Value

MediaTypeInterface

Exceptions

MediaTypeException

in MediaTypeSerializableTrait at line 120
serialize()

in MediaTypeSerializableTrait at line 130
unserialize($serialized)

Parameters

$serialized

in MediaRangeMatchingTrait at line 16
static protected isMediaTypeMatchMediaRange($mediaType, $mediaRange)

Parameters

$mediaType
$mediaRange

in MediaTypeCompareTrait at line 30
compare(MediaTypeInterface|MediaSubType|string $b)

Compare media range precision

Parameters

MediaTypeInterface|MediaSubType|string $b Media range to compare

Return Value

if media range are identical, < 0 if $b is more precise,

0 if $b is less precise

Exceptions

NotComparableException

in StructuredSyntaxMatchingTrait at line 7
static matchStructuredSyntax($a, $b)

Parameters

$a
$b

at line 33
__construct(string $type = self::ANY, string $subType = self::ANY)

Parameters

string $type Main type or '*'
string $subType Sub type or '*'

at line 43
string getType()

Return Value

string

at line 52
MediaSubType|string getSubType()

Return Value

MediaSubType|string

at line 63
__toString()

at line 68
__clone()

at line 79
true match(MediaTypeInterface|string $mediaRange)

Check if the MediaType instance match the given MediaRange

Parameters

MediaTypeInterface|string $mediaRange

Return Value

true if $mediaRange is identical or less restrictive than $this

See also

MediaTypeInterface::match

at line 93
static MediaRange createFromString(string $mediaTypeString, boolean $withParameters = false)

Parameters

string $mediaTypeString Media type string
boolean $withParameters Also parse parameters

Return Value

MediaRange

Exceptions

MediaTypeException

at line 108
static number compareMediaRanges(MediaTypeInterface $a, MediaTypeInterface $b)

Compare media range precision

Parameters

MediaTypeInterface $a
MediaTypeInterface $b

Return Value

number -1 if $a < $b, 1 if $a > $b, 0 if equal or not comparable