MailMimeParser 2.3

AbstractParser
in package
implements IParser

Provides basic implementations for: - IParser::setParserManager - IParser::getParserMessageProxyFactory (returns $this->parserMessageProxyFactory which can be set via the default constructor) - IParser::getParserPartProxyFactory (returns $this->parserPartProxyFactory which can be set via the default constructor)

Tags
author

Zaahid Bateson

Interfaces, Classes, Traits and Enums

IParser
Interface defining a message part parser.

Table of Contents

$parserManager  : ParserManager
$parserMessageProxyFactory  : ParserPartProxyFactory
$parserPartProxyFactory  : ParserPartProxyFactory
$partBuilderFactory  : PartBuilderFactory
__construct()  : mixed
getParserMessageProxyFactory()  : ParserPartProxyFactory
Returns the ParserPartProxyFactory responsible for creating IMessage parts for this parser.
getParserPartProxyFactory()  : ParserPartProxyFactory
Returns the ParserPartProxyFactory responsible for creating IMessagePart parts for this parser.
setParserManager()  : static
Sets up the passed ParserManager as the ParserManager for this part, which should be used when a new part is created (after its headers are read and a PartBuilder is created from it.)

Properties

$parserManager

protected ParserManager $parserManager

the ParserManager, which should call setParserManager when the parser is added.

$parserMessageProxyFactory

protected ParserPartProxyFactory $parserMessageProxyFactory

the parser's message proxy factory service responsible for creating an IMessage part wrapped in a ParserPartProxy.

$parserPartProxyFactory

protected ParserPartProxyFactory $parserPartProxyFactory

the parser's part proxy factory service responsible for creating IMessagePart parts wrapped in a ParserPartProxy.

Methods

getParserMessageProxyFactory()

Returns the ParserPartProxyFactory responsible for creating IMessage parts for this parser.

public getParserMessageProxyFactory() : ParserPartProxyFactory

This is called by ParserManager after 'canParse' if it returns true so a ParserPartProxy can be created out of the PartBuilder.

Return values
ParserPartProxyFactory

getParserPartProxyFactory()

Returns the ParserPartProxyFactory responsible for creating IMessagePart parts for this parser.

public getParserPartProxyFactory() : ParserPartProxyFactory

This is called by ParserManager after 'canParse' if it returns true so a ParserPartProxy can be created out of the PartBuilder.

Return values
ParserPartProxyFactory

setParserManager()

Sets up the passed ParserManager as the ParserManager for this part, which should be used when a new part is created (after its headers are read and a PartBuilder is created from it.)

public setParserManager(ParserManager $pm) : static
Parameters
$pm : ParserManager

The ParserManager to set.

Return values
static

Search results