GenericReceivedConsumer
extends GenericConsumer
in package
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.
Tags
Table of Contents
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
- $partName : string
- __construct() : mixed
- Constructor overridden to include $partName parameter.
- __invoke() : array<string|int, IHeaderPart>
- Invokes parsing of a header's value into header parts.
- getInstance() : mixed
- Returns the singleton instance for the class.
- advanceToNextToken() : static
- Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
- filterIgnoredSpaces() : array<string|int, HeaderPart>
- Filters out ignorable spaces between parts in the passed array.
- 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, IHeaderPart>
- 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().
- getPartForToken() : IHeaderPart|null
- Constructs and returns an IHeaderPart for the passed string token.
- getPartName() : string
- Returns the name of the part being parsed.
- getSubConsumers() : array<string|int, AbstractConsumer>
- Overridden to return a CommentConsumer.
- getTokenParts() : array<string|int, IHeaderPart>
- Returns an array of IHeaderPart for the current token on the iterator.
- getTokenSeparators() : array<string|int, string>
- Returns a whitespace separator (for filtering ignorable whitespace between parts), and a separator matching the current part name as returned by $this->getPartName().
- getTokenSplitPattern() : string
- Returns a regex pattern used to split the input header string.
- isEndToken() : bool
- Returns true if the token matches (case-insensitively) any of the following, with optional surrounding whitespace:
- isStartToken() : bool
- Returns true if the passed token matches (case-insensitively) $this->getPartName() with optional whitespace surrounding it.
- parseTokensIntoParts() : array<string|int, IHeaderPart>
- Iterates over the passed token Iterator and returns an array of parsed IHeaderPart objects.
- processParts() : array<string|int, HeaderPart>|array<string|int, CommentPart>
- 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.
- splitRawValue() : array<string|int, mixed>
- Returns an array of split tokens from the input string.
- addSpaces() : self
- Checks if the passed space part should be added to the returned parts and adds it.
- addSpaceToRetParts() : self
- Loops over the $parts array from the current position, checks if the space should be added, then adds it to $retParts and returns.
- isSpaceToken() : bool
- Returns true if the passed HeaderPart is a Token instance and a space.
- parseRawValue() : array<string|int, IHeaderPart>
- Parses the raw header value into header parts.
- shouldAddSpace() : bool
- Returns true if a space should be added based on the passed last and next parts.
Properties
$consumerService
protected
ConsumerService
$consumerService
used to get consumer instances for sub-consumers.
$partFactory
protected
HeaderPartFactory
$partFactory
used to construct IHeaderPart objects
$partName
protected
string
$partName
the current part name being parsed.
Methods
__construct()
Constructor overridden to include $partName parameter.
public
__construct(ConsumerService $consumerService, HeaderPartFactory $partFactory, string $partName) : mixed
Parameters
- $consumerService : ConsumerService
- $partFactory : HeaderPartFactory
- $partName : string
Return values
mixed —__invoke()
Invokes parsing of a header's value into header parts.
public
__invoke(string $value) : array<string|int, IHeaderPart>
Parameters
- $value : string
-
the raw header value
Return values
array<string|int, IHeaderPart> —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 —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) : static
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
-
The token iterator.
- $isStartToken : bool
-
true for the start token.
Return values
static —filterIgnoredSpaces()
Filters out ignorable spaces between parts in the passed array.
protected
filterIgnoredSpaces(array<string|int, HeaderPart> $parts) : array<string|int, HeaderPart>
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.
Parameters
- $parts : array<string|int, HeaderPart>
Return values
array<string|int, HeaderPart> —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> —Array of unique consumers.
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> —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().
protected
getConsumerTokenParts(Iterator $tokens) : array<string|int, IHeaderPart>
If no sub-consumer is responsible for the current token, calls AbstractConsumer::getPartForToken() and returns it in an array.
Parameters
- $tokens : Iterator
Return values
array<string|int, IHeaderPart> —getPartForToken()
Constructs and returns an IHeaderPart for the passed string token.
protected
getPartForToken(string $token, bool $isLiteral) : IHeaderPart|null
If the token should be ignored, the function must return 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
IHeaderPart|null —The constructed header part or null if the token should be ignored.
getPartName()
Returns the name of the part being parsed.
protected
getPartName() : string
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.
Return values
string —getSubConsumers()
Overridden to return a CommentConsumer.
protected
getSubConsumers() : array<string|int, AbstractConsumer>
Return values
array<string|int, AbstractConsumer> —the sub-consumers
getTokenParts()
Returns an array of IHeaderPart for the current token on the iterator.
protected
getTokenParts(Iterator $tokens) : array<string|int, IHeaderPart>
If the current token is a start token from a sub-consumer, the sub- consumer's AbstractConsumer::parseTokensIntoParts() method is called.
Parameters
- $tokens : Iterator
-
The token iterator.
Return values
array<string|int, IHeaderPart> —getTokenSeparators()
Returns a whitespace separator (for filtering ignorable whitespace between parts), and a separator matching the current part name as returned by $this->getPartName().
protected
getTokenSeparators() : array<string|int, string>
Return values
array<string|int, string> —an array of regex pattern matchers
getTokenSplitPattern()
Returns a regex pattern used to split the input header string.
protected
getTokenSplitPattern() : string
The default implementation calls AbstractConsumer::getAllTokenSeparators() and implodes the returned array with the regex OR '|' character as its glue.
Return values
string —the regex pattern
isEndToken()
Returns true if the token matches (case-insensitively) any of the following, with optional surrounding whitespace:
protected
isEndToken(string $token) : bool
o by o via o with o id o for o ;
Parameters
- $token : string
-
The current token
Return values
bool —isStartToken()
Returns true if the passed token matches (case-insensitively) $this->getPartName() with optional whitespace surrounding it.
protected
isStartToken(string $token) : bool
Parameters
- $token : string
-
The current token
Return values
bool —parseTokensIntoParts()
Iterates over the passed token Iterator and returns an array of parsed IHeaderPart objects.
protected
parseTokensIntoParts(Iterator $tokens) : array<string|int, IHeaderPart>
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, IHeaderPart> —An array of parsed parts
processParts()
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.
protected
processParts(array<string|int, HeaderPart> $parts) : array<string|int, HeaderPart>|array<string|int, CommentPart>
Parameters
- $parts : array<string|int, HeaderPart>
Return values
array<string|int, HeaderPart>|array<string|int, CommentPart> —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 AbstractConsumer::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
addSpaces()
Checks if the passed space part should be added to the returned parts and adds it.
private
addSpaces(array<string|int, HeaderPart> $parts, array<string|int, HeaderPart> &$retParts, int $curIndex[, HeaderPart &$spacePart = null ]) : self
Never adds a space if it's the first part, otherwise only add it if either part isn't set to ignore the space
Parameters
- $parts : array<string|int, HeaderPart>
- $retParts : array<string|int, HeaderPart>
- $curIndex : int
- $spacePart : HeaderPart = null
Return values
self —addSpaceToRetParts()
Loops over the $parts array from the current position, checks if the space should be added, then adds it to $retParts and returns.
private
addSpaceToRetParts(array<string|int, HeaderPart> $parts, array<string|int, HeaderPart> &$retParts, int $curIndex, HeaderPart &$spacePart, HeaderPart $lastPart) : self
Parameters
- $parts : array<string|int, HeaderPart>
- $retParts : array<string|int, HeaderPart>
- $curIndex : int
- $spacePart : HeaderPart
- $lastPart : HeaderPart
Return values
self —isSpaceToken()
Returns true if the passed HeaderPart is a Token instance and a space.
private
isSpaceToken(HeaderPart $part) : bool
Parameters
- $part : HeaderPart
Return values
bool —parseRawValue()
Parses the raw header value into header parts.
private
parseRawValue(string $value) : array<string|int, IHeaderPart>
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, IHeaderPart> —the array of parsed parts
shouldAddSpace()
Returns true if a space should be added based on the passed last and next parts.
private
shouldAddSpace(HeaderPart $nextPart, HeaderPart $lastPart) : bool
Parameters
- $nextPart : HeaderPart
- $lastPart : HeaderPart