PHPFUI/InstaDoc
 
Copied!

Parses a single group of addresses (as a named-group part of an address
header).

Finds addresses using its AddressConsumer sub-consumer separated by commas,
and ends processing once a semi-colon is found.

Prior to returning to its calling client, AddressGroupConsumer constructs a
single Part\AddressGroupPart object filling it with all located addresses,
and returns it.

The AddressGroupConsumer extends AddressBaseConsumer to define start/end
tokens, token separators, and construct a Part\AddressGroupPart to return.

CloneableInstantiable
Methods
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.

public getTokenSeparators() : array
 

Overridden to return patterns matching the beginning and end markers of a
group address: colon and semi-colon (":" and ";") characters.

  • return string[] the patterns
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
Methods
protected ZBateson\MailMimeParser\Header\Consumer\AddressBaseConsumer::advanceToNextToken(Iterator $tokens, bool $isStartToken)
 

Disables advancing for start tokens.

The start token for AddressBaseConsumer is part of an AddressPart (or a
sub-consumer) and so must be passed on.

  • 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\AddressBaseConsumer::getPartForToken(string $token, bool $isLiteral)
 

Never reached by AddressBaseConsumer. Overridden to satisfy
AbstractConsumer.

  • codeCoverageIgnore
  • 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\Part\HeaderPart the constructed
    header part or null if the token should be ignored
protected ZBateson\MailMimeParser\Header\Consumer\AddressBaseConsumer::getSubConsumers() : array
 

Returns \ZBateson\MailMimeParser\Header\Consumer\AddressConsumer as a
sub-consumer.

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

Overridden so tokens aren't handled at this level, and instead are passed
on to AddressConsumer.

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

AddressGroupConsumer returns true if the passed token is a semi-colon.

protected isStartToken(string $token) : bool
 

AddressGroupConsumer returns true if the passed token is a colon.

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
 

Performs post-processing on parsed parts.

AddressGroupConsumer returns an array with a single Part\AddressGroupPart
element with all email addresses from this and any sub-groups.

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