PHPFUI/InstaDoc
 
Copied!

Parses the Address portion of an email address header, for an address part
that contains both a name and an email address, e.g. "name" email@tld.com.

The address portion found within the '<' and '>' chars may contain comments
and quoted portions.

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( $value)
 

Invokes parsing of a header's value into header 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()
 

Overridden to return patterns matching the beginning/end part of an
address in a name/address part ("<" and ">" chars).

Properties
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::$consumerService
 
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::$partFactory
 
Methods
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::advanceToNextToken(Iterator $tokens, $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.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getAllConsumers()
 

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.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getAllTokenSeparators()
 

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

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getConsumerTokenParts(Iterator $tokens)
 

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.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getPartForToken( $token, $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.

protected getSubConsumers()
 

Returns the following as sub-consumers:

  • {@see AddressGroupConsumer}
  • {@see CommentConsumer}
  • {@see QuotedStringConsumer}
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getTokenParts(Iterator $tokens)
 

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.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::getTokenSplitPattern()
 

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.

protected isEndToken( $token)
 

Returns true for the '>' char.

protected isStartToken( $token)
 

Returns true for the '<' char.

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

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.

protected processParts(array $parts)
 

Returns a single AddressPart with its 'email' portion set, so an
AddressConsumer can identify it and create an AddressPart with both a
name and email set.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer::splitRawValue( $rawValue)
 

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.

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