ConsumerService
in package
Simple service provider for consumer singletons.
Tags
Table of Contents
- $mimeLiteralPartFactory : MimeLiteralPartFactory
- $partFactory : HeaderPartFactory
- $receivedConsumers : array<string|int, DomainConsumer>|array<string|int, GenericReceivedConsumer>|array<string|int, ReceivedDateConsumer>
- __construct() : mixed
- getAddressBaseConsumer() : AddressBaseConsumer
- Returns the AddressBaseConsumer singleton instance.
- getAddressConsumer() : AddressConsumer
- Returns the AddressConsumer singleton instance.
- getAddressEmailConsumer() : AddressEmailConsumer
- Returns the AddressEmailConsumer singleton instance.
- getAddressGroupConsumer() : AddressGroupConsumer
- Returns the AddressGroupConsumer singleton instance.
- getCommentConsumer() : CommentConsumer
- Returns the CommentConsumer singleton instance.
- getDateConsumer() : DateConsumer
- Returns the DateConsumer singleton instance.
- getGenericConsumer() : GenericConsumer
- Returns the GenericConsumer singleton instance.
- getIdBaseConsumer() : IdBaseConsumer
- Returns the IdBaseConsumer singleton instance.
- getIdConsumer() : IdConsumer
- Returns the IdConsumer singleton instance.
- getParameterConsumer() : ParameterConsumer
- Returns the ParameterConsumer singleton instance.
- getQuotedStringConsumer() : QuotedStringConsumer
- Returns the QuotedStringConsumer singleton instance.
- getReceivedConsumer() : ReceivedConsumer
- Returns the ReceivedConsumer singleton instance.
- getSubjectConsumer() : SubjectConsumer
- Returns the SubjectConsumer singleton instance.
- getSubReceivedConsumer() : AbstractConsumer
- Returns the consumer instance corresponding to the passed part name of a Received header.
Properties
$mimeLiteralPartFactory
protected
MimeLiteralPartFactory
$mimeLiteralPartFactory
used for GenericConsumer instances.
$partFactory
protected
HeaderPartFactory
$partFactory
the HeaderPartFactory instance used to create HeaderParts.
$receivedConsumers
protected
array<string|int, DomainConsumer>|array<string|int, GenericReceivedConsumer>|array<string|int, ReceivedDateConsumer>
$receivedConsumers
= ['from' => null, 'by' => null, 'via' => null, 'with' => null, 'id' => null, 'for' => null, 'date' => null]
an array of sub-received header consumer instances.
Methods
__construct()
public
__construct(HeaderPartFactory $partFactory, MimeLiteralPartFactory $mimeLiteralPartFactory) : mixed
Parameters
- $partFactory : HeaderPartFactory
- $mimeLiteralPartFactory : MimeLiteralPartFactory
Return values
mixed —getAddressBaseConsumer()
Returns the AddressBaseConsumer singleton instance.
public
getAddressBaseConsumer() : AddressBaseConsumer
Return values
AddressBaseConsumer —getAddressConsumer()
Returns the AddressConsumer singleton instance.
public
getAddressConsumer() : AddressConsumer
Return values
AddressConsumer —getAddressEmailConsumer()
Returns the AddressEmailConsumer singleton instance.
public
getAddressEmailConsumer() : AddressEmailConsumer
Return values
AddressEmailConsumer —getAddressGroupConsumer()
Returns the AddressGroupConsumer singleton instance.
public
getAddressGroupConsumer() : AddressGroupConsumer
Return values
AddressGroupConsumer —getCommentConsumer()
Returns the CommentConsumer singleton instance.
public
getCommentConsumer() : CommentConsumer
Return values
CommentConsumer —getDateConsumer()
Returns the DateConsumer singleton instance.
public
getDateConsumer() : DateConsumer
Return values
DateConsumer —getGenericConsumer()
Returns the GenericConsumer singleton instance.
public
getGenericConsumer() : GenericConsumer
Return values
GenericConsumer —getIdBaseConsumer()
Returns the IdBaseConsumer singleton instance.
public
getIdBaseConsumer() : IdBaseConsumer
Return values
IdBaseConsumer —getIdConsumer()
Returns the IdConsumer singleton instance.
public
getIdConsumer() : IdConsumer
Return values
IdConsumer —getParameterConsumer()
Returns the ParameterConsumer singleton instance.
public
getParameterConsumer() : ParameterConsumer
Return values
ParameterConsumer —getQuotedStringConsumer()
Returns the QuotedStringConsumer singleton instance.
public
getQuotedStringConsumer() : QuotedStringConsumer
Return values
QuotedStringConsumer —getReceivedConsumer()
Returns the ReceivedConsumer singleton instance.
public
getReceivedConsumer() : ReceivedConsumer
Return values
ReceivedConsumer —getSubjectConsumer()
Returns the SubjectConsumer singleton instance.
public
getSubjectConsumer() : SubjectConsumer
Return values
SubjectConsumer —getSubReceivedConsumer()
Returns the consumer instance corresponding to the passed part name of a Received header.
public
getSubReceivedConsumer(string $partName) : AbstractConsumer
Parameters
- $partName : string