Consumes all tokens within parentheses as comments.

Parenthetical comments in mime-headers can be nested within one another. The
outer-level continues after an inner-comment ends. Additionally,
quoted-literals may exist with comments as well meaning a parenthesis inside
a quoted string would not begin or end a comment section.

In order to satisfy these specifications, CommentConsumer inherits from
GenericConsumer which defines CommentConsumer and QuotedStringConsumer as

X-Mime-Header: Some value (comment)
X-Mime-Header: Some value (comment (nested comment) still in comment)
X-Mime-Header: Some value (comment "and part of original ) comment" -

 still a comment)
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 advanceToNextToken(Iterator $tokens, bool $isStartToken)

Calls $tokens->next() and returns.

The default implementation checks if the current token is an end token,
and will not advance past it. Because a comment part of a header can be
nested, its implementation must advance past its own 'end' 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)

Instantiates and returns Part\Token objects.

Tokens from this and sub-consumers are combined into a Part\CommentPart
in processParts.

  • return \ZBateson\MailMimeParser\Header\IHeaderPart|null
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 patterns matching open and close parenthesis characters
as separators.

  • return string[] the patterns
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getTokenSplitPattern() : string

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

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

  • return string the regex pattern
protected isEndToken(string $token) : bool

Returns true if the token is a close parenthesis character, ')'.

protected isStartToken(string $token) : bool

Returns true if the token is an open parenthesis character, '('.

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 a single Part\CommentPart out of
generated parts from tokens. The Part\CommentPart is returned in an

  • param \ZBateson\MailMimeParser\Header\IHeaderPart[] $parts
  • return \ZBateson\MailMimeParser\Header\IHeaderPart[]|array
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
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