class Twig_TokenParserBroker in Zircon Profile 8

Default implementation of a token parser broker.

@author Arnaud Le Blanc <[e-mail]>

Hierarchy

• class \Twig_TokenParserBroker implements Twig_TokenParserBrokerInterface

Deprecated

since 1.12 (to be removed in 2.0)

File

vendor/twig/twig/lib/Twig/TokenParserBroker.php, line 20

class Twig_TokenParserBroker implements Twig_TokenParserBrokerInterface {
  protected $parser;
  protected $parsers = array();
  protected $brokers = array();

  /**
   * Constructor.
   *
   * @param array|Traversable $parsers                 A Traversable of Twig_TokenParserInterface instances
   * @param array|Traversable $brokers                 A Traversable of Twig_TokenParserBrokerInterface instances
   * @param bool              $triggerDeprecationError
   */
  public function __construct($parsers = array(), $brokers = array(), $triggerDeprecationError = true) {
    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;
    }
  }

  /**
   * Adds a TokenParser.
   *
   * @param Twig_TokenParserInterface $parser A Twig_TokenParserInterface instance
   */
  public function addTokenParser(Twig_TokenParserInterface $parser) {
    $this->parsers[$parser
      ->getTag()] = $parser;
  }

  /**
   * Removes a TokenParser.
   *
   * @param Twig_TokenParserInterface $parser A Twig_TokenParserInterface instance
   */
  public function removeTokenParser(Twig_TokenParserInterface $parser) {
    $name = $parser
      ->getTag();
    if (isset($this->parsers[$name]) && $parser === $this->parsers[$name]) {
      unset($this->parsers[$name]);
    }
  }

  /**
   * Adds a TokenParserBroker.
   *
   * @param Twig_TokenParserBroker $broker A Twig_TokenParserBroker instance
   */
  public function addTokenParserBroker(Twig_TokenParserBroker $broker) {
    $this->brokers[] = $broker;
  }

  /**
   * Removes a TokenParserBroker.
   *
   * @param Twig_TokenParserBroker $broker A Twig_TokenParserBroker instance
   */
  public function removeTokenParserBroker(Twig_TokenParserBroker $broker) {
    if (false !== ($pos = array_search($broker, $this->brokers))) {
      unset($this->brokers[$pos]);
    }
  }

  /**
   * Gets a suitable TokenParser for a tag.
   *
   * First looks in parsers, then in brokers.
   *
   * @param string $tag A tag name
   *
   * @return null|Twig_TokenParserInterface A Twig_TokenParserInterface or null if no suitable TokenParser was found
   */
  public function getTokenParser($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);
    }
  }
  public function getParsers() {
    return $this->parsers;
  }
  public function getParser() {
    return $this->parser;
  }
  public function setParser(Twig_ParserInterface $parser) {
    $this->parser = $parser;
    foreach ($this->parsers as $tokenParser) {
      $tokenParser
        ->setParser($parser);
    }
    foreach ($this->brokers as $broker) {
      $broker
        ->setParser($parser);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_TokenParserBroker::$brokers	protected	property
Twig_TokenParserBroker::$parser	protected	property
Twig_TokenParserBroker::$parsers	protected	property
Twig_TokenParserBroker::addTokenParser	public	function	Adds a TokenParser.
Twig_TokenParserBroker::addTokenParserBroker	public	function	Adds a TokenParserBroker.
Twig_TokenParserBroker::getParser	public	function	Gets the Twig_ParserInterface. Overrides Twig_TokenParserBrokerInterface::getParser
Twig_TokenParserBroker::getParsers	public	function
Twig_TokenParserBroker::getTokenParser	public	function	Gets a suitable TokenParser for a tag. Overrides Twig_TokenParserBrokerInterface::getTokenParser
Twig_TokenParserBroker::removeTokenParser	public	function	Removes a TokenParser.
Twig_TokenParserBroker::removeTokenParserBroker	public	function	Removes a TokenParserBroker.
Twig_TokenParserBroker::setParser	public	function	Calls Twig_TokenParserInterface::setParser on all parsers the implementation knows of. Overrides Twig_TokenParserBrokerInterface::setParser
Twig_TokenParserBroker::__construct	public	function	Constructor.