PHPFUI/InstaDoc
 
Copied!

Consumes simple literal strings for parts of a Received header.

Starts consuming when the initialized $partName string is located, for
instance when initialized with "FROM", will start consuming on " FROM" or
"FROM ".

The consumer ends when any possible "Received" header part is found, namely
on one of the following tokens: from, by, via, with, id, for, or when the
start token for the date stamp is found, ';'.

The consumer allows comments in and around the consumer... although the
Received header specification only allows them before a part, for example,
technically speaking this is valid:

"FROM machine (host) (comment) BY machine"

However, this is not:

"FROM machine (host) BY machine WITH (comment) ESMTP"

The consumer will allow both.

CloneableInstantiable
Methods
public __construct(ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory, string $partName)
 

Constructor overridden to include $partName parameter.

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.

Properties
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 $partName = NULL
 
  • var string the current part name being parsed.
Methods
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 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 getPartName() : string
 

Returns the name of the part being parsed.

This is always the lower-case name provided to the constructor, not the
actual string that started the consumer, which could be in any case.

protected getSubConsumers() : array
 

Overridden to return a CommentConsumer.

  • return \ZBateson\MailMimeParser\Header\Consumer\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
 

Returns a whitespace separator (for filtering ignorable whitespace
between parts), and a separator matching the current part name as
returned by $this->getPartName().

  • return string[] an array of regex pattern matchers
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 matches (case-insensitively) any of the
following, with optional surrounding whitespace:

o by
o via
o with
o id
o for
o ;

protected isStartToken(string $token) : bool
 

Returns true if the passed token matches (case-insensitively)
$this->getPartName() with optional whitespace surrounding it.

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 the first element, followed by any comment elements as subsequent
elements.

  • param \ZBateson\MailMimeParser\Header\Part\HeaderPart[] $parts
  • return \ZBateson\MailMimeParser\Header\Part\HeaderPart[]|\ZBateson\MailMimeParser\Header\Part\CommentPart[]
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
Methods
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
Configuration