PHPFUI/InstaDoc
 
Copied!

Extends AbstractGenericConsumerService to use a MimeTokenPartFactory, and to preserve all whitespace and escape sequences as-is (unlike other headers subject headers don't have escape chars such as '\' for a backslash).

SubjectConsumerService doesn't define any sub-consumers.

CloneableInstantiable
Methods
public __construct(Psr\Log\LoggerInterface $logger, ZBateson\MailMimeParser\Header\Part\MimeTokenPartFactory $partFactory)
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 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 getPartForToken(string $token, bool $isLiteral) : ?ZBateson\MailMimeParser\Header\IHeaderPart
 

Overridden to preserve whitespace.

Whitespace between two words is preserved unless the whitespace begins with a newline (\n or \r\n), in which case the entire string of whitespace is discarded, and a single space ' ' character is used in its place.

protected getTokenParts(Iterator $tokens) : array
 

Returns an array of \ZBateson\MailMimeParser\Header\Part\HeaderPart for the current token on the iterator.

Overridden from AbstractConsumerService to remove special filtering for backslash escaping, which also seems to not apply to Subject headers at least in ThunderBird's implementation.

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

Returns the regex '\s+' (whitespace) pattern matcher as a token marker so the header value is split along whitespace characters.

  • 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 ZBateson\MailMimeParser\Header\Consumer\AbstractGenericConsumerService::isEndToken(string $token) : bool
 

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

protected ZBateson\MailMimeParser\Header\Consumer\AbstractGenericConsumerService::isStartToken(string $token) : bool
 

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

  • codeCoverageIgnore
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\AbstractGenericConsumerService::processParts(array $parts) : array
 

Overridden to combine all part values into a single string and return it as an array with a single element.

The returned IHeaderPart array consists of a single ContainerPart created out of all passed IHeaderParts.

  • param \ZBateson\MailMimeParser\Header\IHeaderPart[] $parts
  • return \ZBateson\MailMimeParser\Header\IHeaderPart[]
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