Reads headers separated into parameters consisting of an optional main value,
and subsequent name/value pairs - for example text/html; charset=utf-8.

A ParameterConsumer's parts are separated by a semi-colon. Its name/value
pairs are separated with an '=' character.

Parts may be mime-encoded entities. Additionally, a value can be quoted and
comments may exist.

public ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::__construct(ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory)
public ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::__invoke(string $value) : array

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

  • param string $value the raw header value
  • return \ZBateson\MailMimeParser\Header\IHeaderPart[] the array of parsed
public static ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getInstance(ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory)

Returns the singleton instance for the class.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::$consumerService = NULL
  • var \ConsumerService used to get consumer instances for sub-consumers.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::$partFactory = NULL
  • var \HeaderPartFactory used to construct IHeaderPart objects
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::advanceToNextToken(Iterator $tokens, bool $isStartToken)

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

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.

  • param \Iterator $tokens The token iterator.
  • param bool $isStartToken true for the start token.
  • return static
protected ZBateson\MailMimeParser\Header\Consumer\GenericConsumer::filterIgnoredSpaces(array $parts)

Filters out ignorable spaces between parts in the passed array.

Spaces with parts on either side of it that specify they can be ignored
are filtered out. filterIgnoredSpaces is called from within
processParts, and if needed by an implementing class that overrides
processParts, must be specifically called.

  • param \HeaderPart[] $parts
  • return \HeaderPart[]
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getAllConsumers() : array

Returns this consumer and all unique sub consumers.

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

  • return \AbstractConsumer[] Array of unique consumers.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getAllTokenSeparators() : array

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

  • return string[] Array of regular expression markers.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getConsumerTokenParts(Iterator $tokens) : array

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
{@see \AbstractConsumer::getPartForToken()} and returns it in an array.

  • return \ZBateson\MailMimeParser\Header\IHeaderPart[]
protected getPartForToken(string $token, bool $isLiteral)

Creates and returns a \ZBateson\MailMimeParser\Header\Part\Token out of
the passed string token and returns it, unless the token is an escaped
literal, in which case a LiteralPart is returned.

  • return \ZBateson\MailMimeParser\Header\IHeaderPart
protected ZBateson\MailMimeParser\Header\Consumer\GenericConsumer::getSubConsumers() : array

Returns \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer and
\ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer as

  • return \AbstractConsumer[] the sub-consumers
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getTokenParts(Iterator $tokens) : array

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

If the current token is a start token from a sub-consumer, the sub-
consumer's {@see \AbstractConsumer::parseTokensIntoParts()} method is

  • param \Iterator $tokens The token iterator.
  • return \ZBateson\MailMimeParser\Header\IHeaderPart[]
protected getTokenSeparators() : array

Returns semi-colon and equals char as token separators.

  • return string[]
protected getTokenSplitPattern() : string

Overridden to use a specialized regex for finding mime-encoded parts
(RFC 2047).

Some implementations seem to place mime-encoded parts within quoted
parameters, and split the mime-encoded parts across multiple split
parameters. The specialized regex doesn't allow double quotes inside a
mime encoded part, so it can be "continued" in another parameter.

  • return string the regex pattern
protected ZBateson\MailMimeParser\Header\Consumer\GenericConsumer::isEndToken(string $token) : bool

GenericConsumer doesn't have start/end tokens, and so always returns

protected ZBateson\MailMimeParser\Header\Consumer\GenericConsumer::isStartToken(string $token) : bool

GenericConsumer doesn't have start/end tokens, and so always returns

  • codeCoverageIgnore
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::parseTokensIntoParts(Iterator $tokens) : array

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

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

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

  • param \Iterator $tokens An iterator over a string of tokens
  • return \ZBateson\MailMimeParser\Header\IHeaderPart[] An array of
    parsed parts
protected processParts(array $parts) : array

Post processing involves creating Part\LiteralPart or Part\ParameterPart
objects out of created Token and LiteralParts.

  • param \IHeaderPart[] $parts The parsed parts.
  • return \IHeaderPart[] Array of resulting final parts.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::splitRawValue( $rawValue) : array

Returns an array of split tokens from the input string.

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

  • param string $rawValue the raw string
  • return array the array of tokens
private addToSplitPart(ArrayObject $splitParts, string $name, string $value, int $index, bool $isEncoded)

Adds the passed parameter with the given name and value to a
SplitParameterToken, at the passed index. If one with the given name
doesn't exist, it is created.

  • return \SplitParameterToken
private finalizeParameterParts(ArrayObject $combined) : array

Loops over parts in the passed array, creating ParameterParts out of any
parsed SplitParameterTokens, replacing them in the array.

The method then calls filterIgnoreSpaces to filter out empty elements in
the combined array and returns an array.

  • return \IHeaderPart[]|array
private getPartFor(string $strName, string $strValue, ArrayObject $splitParts)

Instantiates and returns either a MimeLiteralPart if $strName is empty,
a SplitParameterToken if the parameter is a split parameter and is the
first in a series, null if it's a split parameter but is not the first
part in its series, or a ParameterPart is returned otherwise.

If the part is a SplitParameterToken, it's added to the passed
$splitParts as well with its name as a key.

  • return \MimeLiteralPart|\SplitParameterToken|\ZBateson\MailMimeParser\Header\Part\ParameterPart
private processTokenPart(string $tokenValue, ArrayObject $combined, ArrayObject $splitParts, string $strName, string $strCat) : bool

Handles parameter separator tokens during final processing.

If the end token is found, a new IHeaderPart is assigned to the passed
$combined array. If an '=' character is found, $strCat is assigned to
$strName and emptied.

Returns true if the token was processed, and false otherwise.

public static ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getInstance(ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory)

Returns the singleton instance for the class.

© 2023 Bruce Wells
Search Namespaces \ Classes