The base GenericConsumerService is a consumer with CommentConsumerService and QuotedStringConsumerService as sub-consumers, and splitting tokens by whitespace.
- author Zaahid Bateson
- All
- self
- ZBateson\MailMimeParser\Header\Consumer\AbstractGenericConsumerService
- ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService
| Methods |
| public __construct(Psr\Log\LoggerInterface $logger, ZBateson |
| public ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::__invoke(string $value) : array |
| Properties |
| protected Psr\Log\LoggerInterface ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::$logger |
protected ZBateson
|
protected array ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::$subConsumers = []
|
| 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.
|
| 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.
|
| 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().
|
| 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.
|
| protected ZBateson\MailMimeParser\Header\Consumer\AbstractConsumerService::getPartForToken(string $token, bool $isLiteral) : ?ZBateson 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|