Twig_TokenParserBroker Class Reference

Default implementation of a token parser broker. More...

Inheritance diagram for Twig_TokenParserBroker:

Collaboration diagram for Twig_TokenParserBroker:

Public Member Functions
	__construct ($parsers=array(), $brokers=array(), $triggerDeprecationError=true)
	addTokenParser (Twig_TokenParserInterface $parser)
	removeTokenParser (Twig_TokenParserInterface $parser)
	addTokenParserBroker (self $broker)
	removeTokenParserBroker (self $broker)
	getTokenParser ($tag)
	Gets a suitable TokenParser for a tag. More...
	getParsers ()
	getParser ()
	Gets the Twig_ParserInterface. More...
	setParser (Twig_ParserInterface $parser)
	Calls Twig_TokenParserInterface::setParser on all parsers the implementation knows of. More...

Protected Attributes
	$parser
	$parsers = array()
	$brokers = array()

Detailed Description

Default implementation of a token parser broker.

Author

Arnaud Le Blanc arnau.nosp@m.d.lb.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Deprecated:

since 1.12 (to be removed in 2.0)

Definition at line 20 of file TokenParserBroker.php.

Constructor & Destructor Documentation

__construct()

Twig_TokenParserBroker::__construct	(		$parsers = array(),
			$brokers = array(),
			$triggerDeprecationError = true
	)

Parameters

array | Traversable	$parsers	A Traversable of Twig_TokenParserInterface instances
array | Traversable	$brokers	A Traversable of Twig_TokenParserBrokerInterface instances
bool	$triggerDeprecationError

Definition at line 31 of file TokenParserBroker.php.

References $brokers, $parser, and $parsers.

    {
        if ($triggerDeprecationError) {
            @trigger_error('The '.__CLASS__.' class is deprecated since version 1.12 and will be removed in 2.0.', E_USER_DEPRECATED);
        }

        foreach ($parsers as $parser) {
            if (!$parser instanceof Twig_TokenParserInterface) {
                throw new LogicException('$parsers must a an array of Twig_TokenParserInterface.');
            }
            $this->parsers[$parser->getTag()] = $parser;
        }
        foreach ($brokers as $broker) {
            if (!$broker instanceof Twig_TokenParserBrokerInterface) {
                throw new LogicException('$brokers must a an array of Twig_TokenParserBrokerInterface.');
            }
            $this->brokers[] = $broker;
        }
    }

Member Function Documentation

addTokenParser()

Twig_TokenParserBroker::addTokenParser

(

Twig_TokenParserInterface

$parser

)

Definition at line 51 of file TokenParserBroker.php.

References $parser, and Twig_TokenParserInterface\getTag().

    {
        $this->parsers[$parser->getTag()] = $parser;
    }

Here is the call graph for this function:

addTokenParserBroker()

Twig_TokenParserBroker::addTokenParserBroker

(

self

$broker

)

Definition at line 64 of file TokenParserBroker.php.

    {
        $this->brokers[] = $broker;
    }

getParser()

Twig_TokenParserBroker::getParser

(

)

Gets the Twig_ParserInterface.

Returns

null|Twig_ParserInterface A Twig_ParserInterface instance or null

Implements Twig_TokenParserBrokerInterface.

Definition at line 105 of file TokenParserBroker.php.

References $parser.

    {
        return $this->parser;
    }

getParsers()

Twig_TokenParserBroker::getParsers

(

)

Definition at line 100 of file TokenParserBroker.php.

References $parsers.

    {
        return $this->parsers;
    }

getTokenParser()

Twig_TokenParserBroker::getTokenParser

(

$tag

)

Gets a suitable TokenParser for a tag.

First looks in parsers, then in brokers.

Parameters

string

$tag

A tag name

Returns

null|Twig_TokenParserInterface A Twig_TokenParserInterface or null if no suitable TokenParser was found

Implements Twig_TokenParserBrokerInterface.

Definition at line 85 of file TokenParserBroker.php.

References $parser, and $tag.

    {
        if (isset($this->parsers[$tag])) {
            return $this->parsers[$tag];
        }
        $broker = end($this->brokers);
        while (false !== $broker) {
            $parser = $broker->getTokenParser($tag);
            if (null !== $parser) {
                return $parser;
            }
            $broker = prev($this->brokers);
        }
    }

removeTokenParser()

Twig_TokenParserBroker::removeTokenParser

(

Twig_TokenParserInterface

$parser

)

Definition at line 56 of file TokenParserBroker.php.

References $name, and Twig_TokenParserInterface\getTag().

    {
        $name = $parser->getTag();
        if (isset($this->parsers[$name]) && $parser === $this->parsers[$name]) {
            unset($this->parsers[$name]);
        }
    }

Here is the call graph for this function:

removeTokenParserBroker()

Twig_TokenParserBroker::removeTokenParserBroker

(

self

$broker

)

Definition at line 69 of file TokenParserBroker.php.

    {
        if (false !== $pos = array_search($broker, $this->brokers)) {
            unset($this->brokers[$pos]);
        }
    }

setParser()

Twig_TokenParserBroker::setParser

(

Twig_ParserInterface

$parser

)

Calls Twig_TokenParserInterface::setParser on all parsers the implementation knows of.

Implements Twig_TokenParserBrokerInterface.

Definition at line 110 of file TokenParserBroker.php.

References $parser.

    {
        $this->parser = $parser;
        foreach ($this->parsers as $tokenParser) {
            $tokenParser->setParser($parser);
        }
        foreach ($this->brokers as $broker) {
            $broker->setParser($parser);
        }
    }

Field Documentation

$brokers

Twig_TokenParserBroker::$brokers = array()

protected

Definition at line 24 of file TokenParserBroker.php.

Referenced by __construct().

$parser

Twig_TokenParserBroker::$parser

protected

Definition at line 22 of file TokenParserBroker.php.

Referenced by __construct(), addTokenParser(), getParser(), getTokenParser(), and setParser().

$parsers

Twig_TokenParserBroker::$parsers = array()

protected

Definition at line 23 of file TokenParserBroker.php.

Referenced by __construct(), and getParsers().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/twig/twig/lib/Twig/TokenParserBroker.php