MailMimeParser 1.1

AddressGroupConsumer extends AddressBaseConsumer

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 for returning to clients.

Tags
author

Zaahid Bateson

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 and end markers of a group address: colon and semi-colon (":" and ";") characters.
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>
Called during construction to set up the list of sub-consumers that will take control from this consumer should a token match a sub-consumer's start token.
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
AddressGroupConsumer returns true if the passed token is a semi-colon.
isStartToken()  : bool
AddressGroupConsumer returns true if the passed token is a colon.
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, AddressGroupPart>|array<string|int, mixed>
Performs post-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.

Properties

Methods

__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 and end markers of a group address: colon and semi-colon (":" and ";") characters.

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

Called during construction to set up the list of sub-consumers that will take control from this consumer should a token match a sub-consumer's start token.

protected abstract getSubConsumers() : array<string|int, AbstractConsumer>
Return values
array<string|int, AbstractConsumer> —

the array of 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()

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

protected isEndToken(string $token) : bool
Parameters
$token : string
Return values
bool —

false

isStartToken()

AddressGroupConsumer returns true if the passed token is a colon.

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 post-processing on parsed parts.

protected processParts(array<string|int, HeaderPart> $parts) : array<string|int, AddressGroupPart>|array<string|int, mixed>

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

Parameters
$parts : array<string|int, HeaderPart>
Return values
array<string|int, AddressGroupPart>|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

Search results