PHPFUI/InstaDoc
 
Copied!

Serves as a base-consumer for recipient/sender email address headers (like From and To).

AddressBaseConsumerService passes on token processing to its sub-consumer, an AddressConsumerService, and collects Part\AddressPart objects processed and returned by AddressConsumerService.

CloneableInstantiable
Methods
public __construct(Psr\Log\LoggerInterface $logger, ZBateson\MailMimeParser\Header\Part\HeaderPartFactory $partFactory, ZBateson\MailMimeParser\Header\Consumer\AddressConsumerService $addressConsumerService)
public ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::__invoke(string $value) : array
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 advanceToNextToken(Iterator $tokens, bool $isStartToken) : static
 

Disables advancing for start tokens.

The start token for AddressBaseConsumerService is part of an {@see \AddressPart} (or a sub-consumer) and so must be passed on.

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 getPartForToken(string $token, bool $isLiteral) : ?ZBateson\MailMimeParser\Header\IHeaderPart
 

Never reached by AddressBaseConsumerService. Overridden to satisfy AbstractConsumerService.

  • codeCoverageIgnore
protected getTokenParts(Iterator $tokens) : array
 

Overridden so tokens aren't handled at this level, and instead are passed on to AddressConsumerService.

  • return \ZBateson\MailMimeParser\Header\IHeaderPart[]|array
protected getTokenSeparators() : array
 

Returns an empty array.

  • return string[] an array of regex pattern matchers
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
 

AddressBaseConsumerService doesn't have start/end tokens, and so always returns false.

  • return false
protected isStartToken(string $token) : bool
 

AddressBaseConsumerService doesn't have start/end tokens, and so always returns false.

  • codeCoverageIgnore
  • return false
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 ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::processParts(array $parts) : array
 

Performs any final processing on the array of parsed parts before returning it to the consumer client. The passed $parts array is guaranteed to not be empty.

The default implementation simply returns the passed array after filtering out null/empty parts.

  • param \IHeaderPart[] $parts The parsed parts.
  • return \IHeaderPart[] Array of resulting final parts.
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
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration