class Twig_TokenStream in Zircon Profile 8

Represents a token stream.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_TokenStream

File

vendor/twig/twig/lib/Twig/TokenStream.php, line 18

class Twig_TokenStream {
  protected $tokens;
  protected $current = 0;
  protected $filename;

  /**
   * Constructor.
   *
   * @param array  $tokens   An array of tokens
   * @param string $filename The name of the filename which tokens are associated with
   */
  public function __construct(array $tokens, $filename = null) {
    $this->tokens = $tokens;
    $this->filename = $filename;
  }

  /**
   * Returns a string representation of the token stream.
   *
   * @return string
   */
  public function __toString() {
    return implode("\n", $this->tokens);
  }
  public function injectTokens(array $tokens) {
    $this->tokens = array_merge(array_slice($this->tokens, 0, $this->current), $tokens, array_slice($this->tokens, $this->current));
  }

  /**
   * Sets the pointer to the next token and returns the old one.
   *
   * @return Twig_Token
   */
  public function next() {
    if (!isset($this->tokens[++$this->current])) {
      throw new Twig_Error_Syntax('Unexpected end of template.', $this->tokens[$this->current - 1]
        ->getLine(), $this->filename);
    }
    return $this->tokens[$this->current - 1];
  }

  /**
   * Tests a token, sets the pointer to the next one and returns it or throws a syntax error.
   *
   * @return Twig_Token|null The next token if the condition is true, null otherwise
   */
  public function nextIf($primary, $secondary = null) {
    if ($this->tokens[$this->current]
      ->test($primary, $secondary)) {
      return $this
        ->next();
    }
  }

  /**
   * Tests a token and returns it or throws a syntax error.
   *
   * @return Twig_Token
   */
  public function expect($type, $value = null, $message = null) {
    $token = $this->tokens[$this->current];
    if (!$token
      ->test($type, $value)) {
      $line = $token
        ->getLine();
      throw new Twig_Error_Syntax(sprintf('%sUnexpected token "%s" of value "%s" ("%s" expected%s).', $message ? $message . '. ' : '', Twig_Token::typeToEnglish($token
        ->getType()), $token
        ->getValue(), Twig_Token::typeToEnglish($type), $value ? sprintf(' with value "%s"', $value) : ''), $line, $this->filename);
    }
    $this
      ->next();
    return $token;
  }

  /**
   * Looks at the next token.
   *
   * @param int $number
   *
   * @return Twig_Token
   */
  public function look($number = 1) {
    if (!isset($this->tokens[$this->current + $number])) {
      throw new Twig_Error_Syntax('Unexpected end of template.', $this->tokens[$this->current + $number - 1]
        ->getLine(), $this->filename);
    }
    return $this->tokens[$this->current + $number];
  }

  /**
   * Tests the current token.
   *
   * @return bool
   */
  public function test($primary, $secondary = null) {
    return $this->tokens[$this->current]
      ->test($primary, $secondary);
  }

  /**
   * Checks if end of stream was reached.
   *
   * @return bool
   */
  public function isEOF() {
    return $this->tokens[$this->current]
      ->getType() === Twig_Token::EOF_TYPE;
  }

  /**
   * Gets the current token.
   *
   * @return Twig_Token
   */
  public function getCurrent() {
    return $this->tokens[$this->current];
  }

  /**
   * Gets the filename associated with this stream.
   *
   * @return string
   */
  public function getFilename() {
    return $this->filename;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_TokenStream::$current	protected	property
Twig_TokenStream::$filename	protected	property
Twig_TokenStream::$tokens	protected	property
Twig_TokenStream::expect	public	function	Tests a token and returns it or throws a syntax error.
Twig_TokenStream::getCurrent	public	function	Gets the current token.
Twig_TokenStream::getFilename	public	function	Gets the filename associated with this stream.
Twig_TokenStream::injectTokens	public	function
Twig_TokenStream::isEOF	public	function	Checks if end of stream was reached.
Twig_TokenStream::look	public	function	Looks at the next token.
Twig_TokenStream::next	public	function	Sets the pointer to the next token and returns the old one.
Twig_TokenStream::nextIf	public	function	Tests a token, sets the pointer to the next one and returns it or throws a syntax error.
Twig_TokenStream::test	public	function	Tests the current token.
Twig_TokenStream::__construct	public	function	Constructor.
Twig_TokenStream::__toString	public	function	Returns a string representation of the token stream.