class Twig_Token in Zircon Profile 8

Represents a Token.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_Token

File

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

class Twig_Token {
  protected $value;
  protected $type;
  protected $lineno;
  const EOF_TYPE = -1;
  const TEXT_TYPE = 0;
  const BLOCK_START_TYPE = 1;
  const VAR_START_TYPE = 2;
  const BLOCK_END_TYPE = 3;
  const VAR_END_TYPE = 4;
  const NAME_TYPE = 5;
  const NUMBER_TYPE = 6;
  const STRING_TYPE = 7;
  const OPERATOR_TYPE = 8;
  const PUNCTUATION_TYPE = 9;
  const INTERPOLATION_START_TYPE = 10;
  const INTERPOLATION_END_TYPE = 11;

  /**
   * Constructor.
   *
   * @param int    $type   The type of the token
   * @param string $value  The token value
   * @param int    $lineno The line position in the source
   */
  public function __construct($type, $value, $lineno) {
    $this->type = $type;
    $this->value = $value;
    $this->lineno = $lineno;
  }

  /**
   * Returns a string representation of the token.
   *
   * @return string A string representation of the token
   */
  public function __toString() {
    return sprintf('%s(%s)', self::typeToString($this->type, true), $this->value);
  }

  /**
   * Tests the current token for a type and/or a value.
   *
   * Parameters may be:
   * * just type
   * * type and value (or array of possible values)
   * * just value (or array of possible values) (NAME_TYPE is used as type)
   *
   * @param array|int         $type   The type to test
   * @param array|string|null $values The token value
   *
   * @return bool
   */
  public function test($type, $values = null) {
    if (null === $values && !is_int($type)) {
      $values = $type;
      $type = self::NAME_TYPE;
    }
    return $this->type === $type && (null === $values || is_array($values) && in_array($this->value, $values) || $this->value == $values);
  }

  /**
   * Gets the line.
   *
   * @return int The source line
   */
  public function getLine() {
    return $this->lineno;
  }

  /**
   * Gets the token type.
   *
   * @return int The token type
   */
  public function getType() {
    return $this->type;
  }

  /**
   * Gets the token value.
   *
   * @return string The token value
   */
  public function getValue() {
    return $this->value;
  }

  /**
   * Returns the constant representation (internal) of a given type.
   *
   * @param int  $type  The type as an integer
   * @param bool $short Whether to return a short representation or not
   *
   * @return string The string representation
   */
  public static function typeToString($type, $short = false) {
    switch ($type) {
      case self::EOF_TYPE:
        $name = 'EOF_TYPE';
        break;
      case self::TEXT_TYPE:
        $name = 'TEXT_TYPE';
        break;
      case self::BLOCK_START_TYPE:
        $name = 'BLOCK_START_TYPE';
        break;
      case self::VAR_START_TYPE:
        $name = 'VAR_START_TYPE';
        break;
      case self::BLOCK_END_TYPE:
        $name = 'BLOCK_END_TYPE';
        break;
      case self::VAR_END_TYPE:
        $name = 'VAR_END_TYPE';
        break;
      case self::NAME_TYPE:
        $name = 'NAME_TYPE';
        break;
      case self::NUMBER_TYPE:
        $name = 'NUMBER_TYPE';
        break;
      case self::STRING_TYPE:
        $name = 'STRING_TYPE';
        break;
      case self::OPERATOR_TYPE:
        $name = 'OPERATOR_TYPE';
        break;
      case self::PUNCTUATION_TYPE:
        $name = 'PUNCTUATION_TYPE';
        break;
      case self::INTERPOLATION_START_TYPE:
        $name = 'INTERPOLATION_START_TYPE';
        break;
      case self::INTERPOLATION_END_TYPE:
        $name = 'INTERPOLATION_END_TYPE';
        break;
      default:
        throw new LogicException(sprintf('Token of type "%s" does not exist.', $type));
    }
    return $short ? $name : 'Twig_Token::' . $name;
  }

  /**
   * Returns the english representation of a given type.
   *
   * @param int $type The type as an integer
   *
   * @return string The string representation
   */
  public static function typeToEnglish($type) {
    switch ($type) {
      case self::EOF_TYPE:
        return 'end of template';
      case self::TEXT_TYPE:
        return 'text';
      case self::BLOCK_START_TYPE:
        return 'begin of statement block';
      case self::VAR_START_TYPE:
        return 'begin of print statement';
      case self::BLOCK_END_TYPE:
        return 'end of statement block';
      case self::VAR_END_TYPE:
        return 'end of print statement';
      case self::NAME_TYPE:
        return 'name';
      case self::NUMBER_TYPE:
        return 'number';
      case self::STRING_TYPE:
        return 'string';
      case self::OPERATOR_TYPE:
        return 'operator';
      case self::PUNCTUATION_TYPE:
        return 'punctuation';
      case self::INTERPOLATION_START_TYPE:
        return 'begin of string interpolation';
      case self::INTERPOLATION_END_TYPE:
        return 'end of string interpolation';
      default:
        throw new LogicException(sprintf('Token of type "%s" does not exist.', $type));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_Token::$lineno	protected	property
Twig_Token::$type	protected	property
Twig_Token::$value	protected	property
Twig_Token::BLOCK_END_TYPE		constant
Twig_Token::BLOCK_START_TYPE		constant
Twig_Token::EOF_TYPE		constant
Twig_Token::getLine	public	function	Gets the line.
Twig_Token::getType	public	function	Gets the token type.
Twig_Token::getValue	public	function	Gets the token value.
Twig_Token::INTERPOLATION_END_TYPE		constant
Twig_Token::INTERPOLATION_START_TYPE		constant
Twig_Token::NAME_TYPE		constant
Twig_Token::NUMBER_TYPE		constant
Twig_Token::OPERATOR_TYPE		constant
Twig_Token::PUNCTUATION_TYPE		constant
Twig_Token::STRING_TYPE		constant
Twig_Token::test	public	function	Tests the current token for a type and/or a value.
Twig_Token::TEXT_TYPE		constant
Twig_Token::typeToEnglish	public static	function	Returns the english representation of a given type.
Twig_Token::typeToString	public static	function	Returns the constant representation (internal) of a given type.
Twig_Token::VAR_END_TYPE		constant
Twig_Token::VAR_START_TYPE		constant
Twig_Token::__construct	public	function	Constructor.
Twig_Token::__toString	public	function	Returns a string representation of the token.