AddressConsumer extends AbstractConsumer
Parses a single part of an address header.
Represents a single part of a list of addresses. A part could be one email address, or one 'group' containing multiple addresses. The consumer ends on finding either a comma token, representing a separation between addresses, or a semi-colon token representing the end of a group.
A single email address may consist of just an email, or a name and an email address. Both of these are valid examples of a From header:
- From: jonsnow@winterfell.com
- From: Jon Snow jonsnow@winterfell.com
Groups must be named, for example:
- To: Winterfell: jonsnow@winterfell.com, Arya Stark arya@winterfell.com;
Addresses may contain quoted parts and comments, and names may be mime-header encoded.
Tags
Table of Contents
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
- __construct() : mixed
- Initializes the instance.
- __invoke() : array<string|int, HeaderPart>
- Invokes parsing of a header's value into header parts.
- getInstance() : mixed
- Returns the singleton instance for the class.
- getTokenSeparators() : array<string|int, string>
- Overridden to return patterns matching the beginning part of an address in a name/address part ("<" and ">" chars), end tokens ("," and ";"), and whitespace.
- advanceToNextToken() : mixed
- Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
- getAllConsumers() : array<string|int, AbstractConsumer>
- Returns this consumer and all unique sub consumers.
- getAllTokenSeparators() : array<string|int, string>
- Returns a list of regular expression markers for this consumer and all sub-consumers by calling 'getTokenSeparators'.
- getConsumerTokenParts() : array<string|int, HeaderPart>|array<string|int, mixed>
- 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 getPartForToken and returns it in an array.
- getPartForToken() : HeaderPart|null
- Constructs and returns a \ZBateson\MailMimeParser\Header\Part\HeaderPart for the passed string token. If the token should be ignored, the function must return null.
- getSubConsumers() : array<string|int, AbstractConsumer>
- Returns the following as sub-consumers: - \ZBateson\MailMimeParser\Header\Consumer\AddressGroupConsumer - \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer - \ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer
- getTokenParts() : array<string|int, HeaderPart>|array<string|int, mixed>
- Returns an array of \ZBateson\MailMimeParser\Header\Part\HeaderPart for the current token on the iterator.
- getTokenSplitPattern() : string
- Returns a regex pattern used to split the input header string. The default implementation calls getAllTokenSeparators and implodes the returned array with the regex OR '|' character as its glue.
- isEndToken() : bool
- Returns true for commas and semi-colons.
- isStartToken() : bool
- AddressConsumer is "greedy", so this always returns true.
- parseTokensIntoParts() : array<string|int, HeaderPart>
- Iterates over the passed token Iterator and returns an array of parsed \ZBateson\MailMimeParser\Header\Part\HeaderPart objects.
- processParts() : array<string|int, HeaderPart>|array<string|int, mixed>
- Performs final processing on parsed parts.
- splitRawValue() : array<string|int, mixed>
- Returns an array of split tokens from the input string.
- parseRawValue() : array<string|int, HeaderPart>
- Called by __invoke to parse the raw header value into header parts.
- processSinglePart() : mixed
- Checks if the passed part represents the beginning or end of an address part (less than/greater than characters) and either appends the value of the part to the passed $strValue, or sets up $strName
Properties
$consumerService
protected
ConsumerService
$consumerService
$partFactory
protected
HeaderPartFactory
$partFactory
Methods
__construct()
Initializes the instance.
public
__construct(ConsumerService $consumerService, HeaderPartFactory $partFactory) : mixed
Parameters
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
Return values
mixed —__invoke()
Invokes parsing of a header's value into header parts.
public
__invoke(string $value) : array<string|int, HeaderPart>
Parameters
- $value : string
-
the raw header value
Return values
array<string|int, HeaderPart> —the array of parsed parts
getInstance()
Returns the singleton instance for the class.
public
static getInstance(ConsumerService $consumerService, HeaderPartFactory $partFactory) : mixed
Parameters
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
Return values
mixed —getTokenSeparators()
Overridden to return patterns matching the beginning part of an address in a name/address part ("<" and ">" chars), end tokens ("," and ";"), and whitespace.
public
getTokenSeparators() : array<string|int, string>
Return values
array<string|int, string> —the patterns
advanceToNextToken()
Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
protected
advanceToNextToken(Iterator $tokens, bool $isStartToken) : mixed
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.
Parameters
- $tokens : Iterator
- $isStartToken : bool
Return values
mixed —getAllConsumers()
Returns this consumer and all unique sub consumers.
protected
getAllConsumers() : array<string|int, AbstractConsumer>
Loops into the sub-consumers (and their sub-consumers, etc...) finding all unique consumers, and returns them in an array.
Return values
array<string|int, AbstractConsumer> —getAllTokenSeparators()
Returns a list of regular expression markers for this consumer and all sub-consumers by calling 'getTokenSeparators'.
protected
getAllTokenSeparators() : array<string|int, string>
.
Return values
array<string|int, string> —an array of regular expression markers
getConsumerTokenParts()
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 getPartForToken and returns it in an array.
protected
getConsumerTokenParts(Iterator $tokens) : array<string|int, HeaderPart>|array<string|int, mixed>
Parameters
- $tokens : Iterator
Return values
array<string|int, HeaderPart>|array<string|int, mixed> —getPartForToken()
Constructs and returns a \ZBateson\MailMimeParser\Header\Part\HeaderPart for the passed string token. If the token should be ignored, the function must return null.
protected
getPartForToken(string $token, bool $isLiteral) : HeaderPart|null
The default created part uses the instance's partFactory->newInstance method.
Parameters
- $token : string
-
the token
- $isLiteral : bool
-
set to true if the token represents a literal - e.g. an escaped token
Return values
HeaderPart|null —the constructed header part or null if the token should be ignored
getSubConsumers()
Returns the following as sub-consumers: - \ZBateson\MailMimeParser\Header\Consumer\AddressGroupConsumer - \ZBateson\MailMimeParser\Header\Consumer\CommentConsumer - \ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumer
protected
getSubConsumers() : array<string|int, AbstractConsumer>
Return values
array<string|int, AbstractConsumer> —the sub-consumers
getTokenParts()
Returns an array of \ZBateson\MailMimeParser\Header\Part\HeaderPart for the current token on the iterator.
protected
getTokenParts(Iterator $tokens) : array<string|int, HeaderPart>|array<string|int, mixed>
If the current token is a start token from a sub-consumer, the sub- consumer's parseTokensIntoParts method is called.
Parameters
- $tokens : Iterator
Return values
array<string|int, HeaderPart>|array<string|int, mixed> —getTokenSplitPattern()
Returns a regex pattern used to split the input header string. The default implementation calls getAllTokenSeparators and implodes the returned array with the regex OR '|' character as its glue.
protected
getTokenSplitPattern() : string
Return values
string —the regex pattern
isEndToken()
Returns true for commas and semi-colons.
protected
isEndToken(string $token) : bool
Although the semi-colon is not strictly the end token of an AddressConsumer, it could end a parent AddressGroupConsumer. I can't think of a valid scenario where this would be an issue, but additional thought may be needed (and documented here).
Parameters
- $token : string
Return values
bool —false
isStartToken()
AddressConsumer is "greedy", so this always returns true.
protected
isStartToken(string $token) : bool
Parameters
- $token : string
Return values
bool —false
parseTokensIntoParts()
Iterates over the passed token Iterator and returns an array of parsed \ZBateson\MailMimeParser\Header\Part\HeaderPart objects.
protected
parseTokensIntoParts(Iterator $tokens) : array<string|int, HeaderPart>
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.
Parameters
- $tokens : Iterator
-
an iterator over a string of tokens
Return values
array<string|int, HeaderPart> —an array of parsed parts
processParts()
Performs final processing on parsed parts.
protected
processParts(array<string|int, HeaderPart> $parts) : array<string|int, HeaderPart>|array<string|int, mixed>
AddressConsumer's implementation looks for tokens representing the beginning of an address part, to create a Part\AddressPart out of a name/address pair, or assign the name part to a parsed Part\AddressGroupPart returned from its AddressGroupConsumer sub-consumer.
The returned array consists of a single element - either a Part\AddressPart or a Part\AddressGroupPart.
Parameters
- $parts : array<string|int, HeaderPart>
Return values
array<string|int, HeaderPart>|array<string|int, mixed> —splitRawValue()
Returns an array of split tokens from the input string.
protected
splitRawValue(string $rawValue) : array<string|int, mixed>
The method calls preg_split using getTokenSplitPattern. The split array will not contain any empty parts and will contain the markers.
Parameters
- $rawValue : string
-
the raw string
Return values
array<string|int, mixed> —the array of tokens
parseRawValue()
Called by __invoke to parse the raw header value into header parts.
private
parseRawValue(string $value) : array<string|int, HeaderPart>
Calls splitTokens to split the value into token part strings, then calls parseParts to parse the returned array.
Parameters
- $value : string
Return values
array<string|int, HeaderPart> —the array of parsed parts
processSinglePart()
Checks if the passed part represents the beginning or end of an address part (less than/greater than characters) and either appends the value of the part to the passed $strValue, or sets up $strName
private
processSinglePart(HeaderPart $part, string &$strName, string &$strValue) : mixed
Parameters
- $part : HeaderPart
- $strName : string
- $strValue : string