Parses a Received header into ReceivedParts, ReceivedDomainParts, a DatePart, and CommentParts.

Parts that don't correspond to any of the above are discarded.

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 parts
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)

Overridden to /not/ advance when the end token matches a start token for a sub-consumer.

  • return static
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 ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getPartForToken(string $token, bool $isLiteral)

Constructs and returns an IHeaderPart for the passed string token.

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

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

  • param string $token the token
  • param bool $isLiteral set to true if the token represents a literal - e.g. an escaped token
  • return \ZBateson\MailMimeParser\Header\IHeaderPart|null The constructed header part or null if the token should be ignored.
protected getSubConsumers() : array

Returns sub-consumers for a received consumer.

  • 2 {@see Received/DomainConsumer} instances, with FROM and BY as part names.
  • 4 {@see Received/GenericReceivedConsumer} instances for VIA, WITH, ID, and FOR part names.
  • 1 {@see Received/ReceivedDateConsumer} for the date/time stamp.
  • 1 {@see \CommentConsumer} to consume any comments.
  • 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 called.

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

ReceivedConsumer doesn't have any token separators of its own.

Sub-Consumers will return separators matching 'part' word separators, for example 'from' and 'by', and ';' for date, etc...

  • return string[] an array of regex pattern matchers
protected getTokenSplitPattern() : string

Overridden to exclude the MimeLiteralPart pattern that comes by default in AbstractConsumer.

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

ReceivedConsumer doesn't have an end token, and so this just returns false.

protected isStartToken(string $token) : bool

ReceivedConsumer doesn't start consuming at a specific token, it's the base handler for the Received header, and so this always returns false.

  • 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 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.

  • 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

Overridden to combine all part values into a single string and return it as an array with a single element.

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

© 2024 Bruce Wells
Search Namespaces \ Classes