MailMimeParser 2.4

AbstractConsumer
in package

Abstract base class for all header token consumers.

Defines the base parser that loops over tokens, consuming them and creating header parts.

Tags
author

Zaahid Bateson

Table of Contents

$consumerService  : ConsumerService
$partFactory  : HeaderPartFactory
__construct()  : mixed
__invoke()  : array<string|int, IHeaderPart>
Invokes parsing of a header's value into header parts.
getInstance()  : mixed
Returns the singleton instance for the class.
advanceToNextToken()  : static
Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
getAllConsumers()  : array<string|int, AbstractConsumer>
Returns this consumer and all unique sub consumers.
getAllTokenSeparators()  : array<string|int, string>
Returns a list of regular expression markers for this consumer and all sub-consumers by calling getTokenSeparators().
getConsumerTokenParts()  : array<string|int, IHeaderPart>
Iterates through this consumer's sub-consumers checking if the current token triggers a sub-consumer's start token and passes control onto that sub-consumer's parseTokenIntoParts().
getPartForToken()  : IHeaderPart|null
Constructs and returns an IHeaderPart for the passed string token.
getSubConsumers()  : array<string|int, AbstractConsumer>
Returns an array of sub-consumers.
getTokenParts()  : array<string|int, IHeaderPart>
Returns an array of IHeaderPart for the current token on the iterator.
getTokenSeparators()  : array<string|int, string>
Returns an array of regular expression separators specific to this consumer.
getTokenSplitPattern()  : string
Returns a regex pattern used to split the input header string.
isEndToken()  : bool
Returns true if the passed string token marks the end marker for the current consumer.
isStartToken()  : bool
Returns true if the passed string token marks the beginning marker for the current consumer.
parseTokensIntoParts()  : array<string|int, IHeaderPart>
Iterates over the passed token Iterator and returns an array of parsed IHeaderPart objects.
processParts()  : array<string|int, IHeaderPart>
Performs any final processing on the array of parsed parts before returning it to the consumer client.
splitRawValue()  : array<string|int, mixed>
Returns an array of split tokens from the input string.
parseRawValue()  : array<string|int, IHeaderPart>
Parses the raw header value into header parts.

Properties

Methods

__invoke()

Invokes parsing of a header's value into header parts.

public __invoke(string $value) : array<string|int, IHeaderPart>
Parameters
$value : string

the raw header value

Return values
array<string|int, IHeaderPart>

the array of parsed parts

advanceToNextToken()

Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.

protected advanceToNextToken(Iterator $tokens, bool $isStartToken) : static

The default implementation will advance for a start token, but not advance on the end token of the current consumer, allowing the end token to be passed up to a higher-level consumer.

Parameters
$tokens : Iterator

The token iterator.

$isStartToken : bool

true for the start token.

Return values
static

getAllConsumers()

Returns this consumer and all unique sub consumers.

protected getAllConsumers() : array<string|int, AbstractConsumer>

Loops into the sub-consumers (and their sub-consumers, etc...) finding all unique consumers, and returns them in an array.

Return values
array<string|int, AbstractConsumer>

Array of unique consumers.

getAllTokenSeparators()

Returns a list of regular expression markers for this consumer and all sub-consumers by calling getTokenSeparators().

protected getAllTokenSeparators() : array<string|int, string>
Return values
array<string|int, string>

Array of regular expression markers.

getConsumerTokenParts()

Iterates through this consumer's sub-consumers checking if the current token triggers a sub-consumer's start token and passes control onto that sub-consumer's parseTokenIntoParts().

protected getConsumerTokenParts(Iterator $tokens) : array<string|int, IHeaderPart>

If no sub-consumer is responsible for the current token, calls AbstractConsumer::getPartForToken() and returns it in an array.

Parameters
$tokens : Iterator
Return values
array<string|int, IHeaderPart>

getPartForToken()

Constructs and returns an IHeaderPart for the passed string token.

protected getPartForToken(string $token, bool $isLiteral) : IHeaderPart|null

If the token should be ignored, the function must return null.

The default created part uses the instance's partFactory->newInstance method.

Parameters
$token : string

the token

$isLiteral : bool

set to true if the token represents a literal - e.g. an escaped token

Return values
IHeaderPart|null

The constructed header part or null if the token should be ignored.

getSubConsumers()

Returns an array of sub-consumers.

protected abstract getSubConsumers() : array<string|int, AbstractConsumer>

Called during construction to set up the list of sub-consumers that will take control from this consumer should a token match a sub-consumer's start token.

Return values
array<string|int, AbstractConsumer>

Array of sub-consumers

getTokenParts()

Returns an array of IHeaderPart for the current token on the iterator.

protected getTokenParts(Iterator $tokens) : array<string|int, IHeaderPart>

If the current token is a start token from a sub-consumer, the sub- consumer's AbstractConsumer::parseTokensIntoParts() method is called.

Parameters
$tokens : Iterator

The token iterator.

Return values
array<string|int, IHeaderPart>

getTokenSeparators()

Returns an array of regular expression separators specific to this consumer.

protected abstract getTokenSeparators() : array<string|int, string>

The returned patterns are used to split the header value into tokens for the consumer to parse into parts.

Each array element makes part of a generated regular expression that is used in a call to preg_split(). RegEx patterns can be used, and care should be taken to escape special characters.

Return values
array<string|int, string>

Array of regex patterns.

getTokenSplitPattern()

Returns a regex pattern used to split the input header string.

protected getTokenSplitPattern() : string

The default implementation calls AbstractConsumer::getAllTokenSeparators() and implodes the returned array with the regex OR '|' character as its glue.

Return values
string

the regex pattern

isEndToken()

Returns true if the passed string token marks the end marker for the current consumer.

protected abstract isEndToken(string $token) : bool
Parameters
$token : string

The current token

Return values
bool

isStartToken()

Returns true if the passed string token marks the beginning marker for the current consumer.

protected abstract isStartToken(string $token) : bool
Parameters
$token : string

The current token

Return values
bool

parseTokensIntoParts()

Iterates over the passed token Iterator and returns an array of parsed IHeaderPart objects.

protected parseTokensIntoParts(Iterator $tokens) : array<string|int, IHeaderPart>

The method checks each token to see if the token matches a sub-consumer's start token, or if it matches the current consumer's end token to stop processing.

If a sub-consumer's start token is matched, the sub-consumer is invoked and its returned parts are merged to the current consumer's header parts.

After all tokens are read and an array of Header\Parts are constructed, the array is passed to AbstractConsumer::processParts for any final processing.

Parameters
$tokens : Iterator

An iterator over a string of tokens

Return values
array<string|int, IHeaderPart>

An array of parsed parts

processParts()

Performs any final processing on the array of parsed parts before returning it to the consumer client.

protected processParts(array<string|int, IHeaderPart$parts) : array<string|int, IHeaderPart>

The default implementation simply returns the passed array after filtering out null/empty parts.

Parameters
$parts : array<string|int, IHeaderPart>

The parsed parts.

Return values
array<string|int, IHeaderPart>

Array of resulting final parts.

splitRawValue()

Returns an array of split tokens from the input string.

protected splitRawValue(string $rawValue) : array<string|int, mixed>

The method calls preg_split using AbstractConsumer::getTokenSplitPattern(). The split array will not contain any empty parts and will contain the markers.

Parameters
$rawValue : string

the raw string

Return values
array<string|int, mixed>

the array of tokens

parseRawValue()

Parses the raw header value into header parts.

private parseRawValue(string $value) : array<string|int, IHeaderPart>

Calls splitTokens to split the value into token part strings, then calls parseParts to parse the returned array.

Parameters
$value : string
Return values
array<string|int, IHeaderPart>

the array of parsed parts

Search results