Abstract base class for all header token consumers.

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

author Zaahid Bateson
package MailMimeParser

 Methods

Initializes the instance.

__construct(\ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, \ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory) 

Parameters

$consumerService

\ZBateson\MailMimeParser\Header\Consumer\ConsumerService

$partFactory

\ZBateson\MailMimeParser\Header\Part\HeaderPartFactory

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

__invoke(string $value) : array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>

Parameters

$value

string

the raw header value

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>the array of parsed parts

Returns the singleton instance for the class.

getInstance(\ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, \ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory) 
Static

Parameters

$consumerService

\ZBateson\MailMimeParser\Header\Consumer\ConsumerService

$partFactory

\ZBateson\MailMimeParser\Header\Part\HeaderPartFactory

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

advanceToNextToken(\Iterator $tokens, boolean $isStartToken) 

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

$isStartToken

boolean

Returns this consumer and all unique sub consumers.

getAllConsumers() : array<mixed,\ZBateson\MailMimeParser\Header\AbstractConsumer>

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

Returns

array<mixed,\ZBateson\MailMimeParser\Header\AbstractConsumer>

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

getAllTokenSeparators() : array<mixed,string>

.

Returns

array<mixed,string>an array of regular expression markers

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. If no sub-consumer is responsible for the current token, calls getPartForToken and returns it in an array.

getConsumerTokenParts(\Iterator $tokens) : array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart> | array

Parameters

$tokens

\Iterator

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>array

Constructs and returns a \ZBateson\MailMimeParser\Header\Part\HeaderPart for the passed string token. If the token should be ignored, the function must return null.

getPartForToken(string $token, boolean $isLiteral) : \ZBateson\MailMimeParser\Header\Part\HeaderPart | null

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

Parameters

$token

string

the token

$isLiteral

boolean

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

Returns

\ZBateson\MailMimeParser\Header\Part\HeaderPartnullthe constructed header part or null if the token should be ignored

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.

getSubConsumers() : array<mixed,\ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer>

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer>the array of consumers

Returns an array of \ZBateson\MailMimeParser\Header\Part\HeaderPart for the current token on the iterator.

getTokenParts(\Iterator $tokens) : array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart> | array

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

Parameters

$tokens

\Iterator

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>array

Returns an array of regular expression separators specific to this consumer. The returned patterns are used to split the header value into tokens for the consumer to parse into parts.

getTokenSeparators() : array<mixed,string>

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.

Returns

array<mixed,string>the array of patterns

Returns a regex pattern used to split the input header string. The default implementation calls getAllTokenSeparators and implodes the returned array with the regex OR '|' character as its glue.

getTokenSplitPattern() : string

Returns

stringthe regex pattern

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

isEndToken(string $token) : boolean

Parameters

$token

string

the current token

Returns

boolean

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

isStartToken(string $token) : boolean

Parameters

$token

string

the current token

Returns

boolean

Iterates over the passed token Iterator and returns an array of parsed \ZBateson\MailMimeParser\Header\Part\HeaderPart objects.

parseTokensIntoParts(\Iterator $tokens) : array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>

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

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>an array of parsed parts

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

processParts(array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart> $parts) : array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>

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

Parameters

$parts

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>

Returns an array of split tokens from the input string.

splitRawValue(string $rawValue) : array

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

Parameters

$rawValue

string

the raw string

Returns

arraythe array of tokens

Called by __invoke to parse the raw header value into header parts.

parseRawValue(string $value) : array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>

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

Parameters

$value

string

Returns

array<mixed,\ZBateson\MailMimeParser\Header\Part\HeaderPart>the array of parsed parts

 Properties

 

used to get consumer instances for sub-consumers

$consumerService : \ZBateson\MailMimeParser\Header\Consumer\ConsumerService

Default

 

used to construct HeaderPart objects

$partFactory : \ZBateson\MailMimeParser\Header\Part\HeaderPartFactory

Default