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 __construct(Psr\Log\LoggerInterface $logger, ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory, ZBateson\MailMimeParser\Header\Consumer\CommentConsumerService $commentConsumerService, ZBateson\MailMimeParser\Header\Consumer\QuotedStringConsumerService $quotedStringConsumerService)
public ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::__invoke(string $value) : array
public getTokenSeparators() : array
 

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

  • return string[] the patterns
Properties
protected Psr\Log\LoggerInterface ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::$logger
protected ZBateson\MailMimeParser\Header\Part\HeaderPartFactory ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::$partFactory
 
  • var \HeaderPartFactory used to construct IHeaderPart objects
protected array ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::$subConsumers = []
 
  • var \AbstractConsumerService[] array of sub-consumers used by this consumer if any, or an empty array if none exist.
Methods
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::advanceToNextToken(Iterator $tokens, bool $isStartToken) : static
 

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.

  • param \Iterator $tokens The token iterator.
  • param bool $isStartToken true for the start token.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::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 \AbstractConsumerService[] Array of unique consumers.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::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\AbstractConsumerService::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 \AbstractConsumerService::getPartForToken()} and returns it in an array.

  • param \Iterator<string> $tokens
  • return \IHeaderPart[]
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::getPartForToken(string $token, bool $isLiteral) : ?ZBateson\MailMimeParser\Header\IHeaderPart
 

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.

  • param string $token the token
  • param bool $isLiteral set to true if the token represents a literal - e.g. an escaped token
  • return ?\IHeaderPart The constructed header part or null if the token should be ignored.
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::getTokenParts(Iterator $tokens) : array
 

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 \AbstractConsumerService::parseTokensIntoParts()} method is called.

  • param \Iterator<string> $tokens The token iterator.
  • return \IHeaderPart[]
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::getTokenSplitPattern() : string
 

Returns a regex pattern used to split the input header string.

The default implementation calls {@see \AbstractConsumerService::getAllTokenSeparators()} and implodes the returned array with the regex OR '|' character as its glue.

  • return string the regex pattern
protected isEndToken(string $token) : bool
 

Returns true for the '>' char.

protected isStartToken(string $token) : bool
 

Returns true for the '<' char.

protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::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 {@see \AbstractConsumerService::processParts} for any final processing if there are any parts.

  • param \Iterator<string> $tokens An iterator over a string of tokens
  • return \IHeaderPart[] An array of parsed parts
protected processParts(array $parts) : array
 

Returns a single {@see ZBateson\MailMimeParser\Header\Part\AddressPart} with its 'email' portion set, so an {@see AddressConsumerService} can identify it and create an {@see ZBateson\MailMimeParser\Header\Part\AddressPart} Address with both a name and email set.

  • param \ZBateson\MailMimeParser\Header\IHeaderPart[] $parts
  • return \ZBateson\MailMimeParser\Header\IHeaderPart[]|array
protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::splitRawValue( $rawValue) : array
 

Returns an array of split tokens from the input string.

The method calls preg_split using {@see \AbstractConsumerService::getTokenSplitPattern()}. The split array will not contain any empty parts and will contain the markers.

  • param string $rawValue the raw string
  • return string[] the array of tokens
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration