Twig_Token Class Reference

Represents a Token. More...

Collaboration diagram for Twig_Token:

Public Member Functions
	__construct ($type, $value, $lineno)
	__toString ()
	test ($type, $values=null)
	Tests the current token for a type and/or a value. More...
	getLine ()
	getType ()
	getValue ()

Static Public Member Functions
static	typeToString ($type, $short=false)
	Returns the constant representation (internal) of a given type. More...
static	typeToEnglish ($type)
	Returns the English representation of a given type. More...

Data Fields
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

Protected Attributes
	$value
	$type
	$lineno

Detailed Description

Represents a Token.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

@final

Definition at line 20 of file Token.php.

Constructor & Destructor Documentation

__construct()

Twig_Token::__construct	(		$type,
			$value,
			$lineno
	)

Parameters

int	$type	The type of the token
string	$value	The token value
int	$lineno	The line position in the source

Definition at line 45 of file Token.php.

    {
        $this->type = $type;
        $this->value = $value;
        $this->lineno = $lineno;
    }

References $lineno, $type, and $value.

Member Function Documentation

__toString()

Twig_Token::__toString

(

)

Definition at line 52 of file Token.php.

    {
        return sprintf('%s(%s)', self::typeToString($this->type, true), $this->value);
    }

References sprintf.

getLine()

Twig_Token::getLine

(

)

Returns

int

Definition at line 87 of file Token.php.

    {
        return $this->lineno;
    }

References $lineno.

Referenced by Twig_Extensions_Grammar_Boolean\parse(), Twig_Extensions_Grammar_Number\parse(), Twig_Extensions_Grammar_Switch\parse(), Twig_Extensions_SimpleTokenParser\parse(), Twig_Extensions_TokenParser_Trans\parse(), Twig_TokenParser_AutoEscape\parse(), Twig_TokenParser_Block\parse(), Twig_TokenParser_Do\parse(), Twig_TokenParser_Embed\parse(), Twig_TokenParser_Extends\parse(), Twig_TokenParser_Filter\parse(), Twig_TokenParser_Flush\parse(), Twig_TokenParser_For\parse(), Twig_TokenParser_From\parse(), Twig_TokenParser_If\parse(), Twig_TokenParser_Import\parse(), Twig_TokenParser_Include\parse(), Twig_TokenParser_Macro\parse(), Twig_TokenParser_Sandbox\parse(), Twig_TokenParser_Set\parse(), Twig_TokenParser_Spaceless\parse(), and Twig_TokenParser_With\parse().

Here is the caller graph for this function:

getType()

Twig_Token::getType

(

)

Returns

int

Definition at line 95 of file Token.php.

    {
        return $this->type;
    }

References $type.

getValue()

Twig_Token::getValue

(

)

Returns

string

Definition at line 103 of file Token.php.

    {
        return $this->value;
    }

References $value.

Referenced by Twig_ExpressionParser\isBinary(), Twig_ExpressionParser\isUnary(), Twig_Extensions_Grammar_Boolean\parse(), Twig_Extensions_Grammar_Number\parse(), Twig_TokenParser_Block\parse(), and Twig_TokenParser_Macro\parse().

Here is the caller graph for this function:

test()

Twig_Token::test	(		$type,
			$values = null
	)

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)

Parameters

array | int	$type	The type to test
array | string | null	$values	The token value

Returns

bool

Definition at line 70 of file Token.php.

    {
        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
        );
    }

References $type, and NAME_TYPE.

Referenced by Twig_Extensions_Grammar_Body\decideBlockEnd(), Twig_TokenParser_AutoEscape\decideBlockEnd(), Twig_TokenParser_Block\decideBlockEnd(), Twig_TokenParser_Embed\decideBlockEnd(), Twig_TokenParser_Filter\decideBlockEnd(), Twig_TokenParser_Macro\decideBlockEnd(), Twig_TokenParser_Sandbox\decideBlockEnd(), Twig_TokenParser_Set\decideBlockEnd(), Twig_Extensions_TokenParser_Trans\decideForEnd(), Twig_TokenParser_For\decideForEnd(), Twig_Extensions_TokenParser_Trans\decideForFork(), Twig_TokenParser_For\decideForFork(), Twig_TokenParser_If\decideIfEnd(), Twig_TokenParser_If\decideIfFork(), Twig_TokenParser_Spaceless\decideSpacelessEnd(), Twig_TokenParser_With\decideWithEnd(), Twig_ExpressionParser\isBinary(), and Twig_ExpressionParser\isUnary().

Here is the caller graph for this function:

typeToEnglish()

static Twig_Token::typeToEnglish (   $type )

static

Returns the English representation of a given type.

Parameters

int

$type

The type as an integer

Returns

string The string representation

Definition at line 172 of file Token.php.

    {
        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));
        }
    }

References $type, BLOCK_END_TYPE, BLOCK_START_TYPE, EOF_TYPE, INTERPOLATION_END_TYPE, INTERPOLATION_START_TYPE, NAME_TYPE, NUMBER_TYPE, OPERATOR_TYPE, PUNCTUATION_TYPE, sprintf, STRING_TYPE, TEXT_TYPE, VAR_END_TYPE, and VAR_START_TYPE.

Referenced by Twig_TokenStream\expect(), Twig_ExpressionParser\parseHashExpression(), and Twig_ExpressionParser\parsePrimaryExpression().

Here is the caller graph for this function:

typeToString()

static Twig_Token::typeToString (   $type,   $short = false  )

static

Returns the constant representation (internal) of a given type.

Parameters

int	$type	The type as an integer
bool	$short	Whether to return a short representation or not

Returns

string The string representation

Definition at line 116 of file Token.php.

    {
        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;
    }

References $name, $type, BLOCK_END_TYPE, BLOCK_START_TYPE, EOF_TYPE, INTERPOLATION_END_TYPE, INTERPOLATION_START_TYPE, NAME_TYPE, NUMBER_TYPE, OPERATOR_TYPE, PUNCTUATION_TYPE, sprintf, STRING_TYPE, TEXT_TYPE, VAR_END_TYPE, and VAR_START_TYPE.

Field Documentation

$lineno

Twig_Token::$lineno

protected

Definition at line 24 of file Token.php.

Referenced by __construct(), and getLine().

$type

Twig_Token::$type

protected

Definition at line 23 of file Token.php.

Referenced by __construct(), getType(), test(), typeToEnglish(), and typeToString().

$value

Twig_Token::$value

protected

Definition at line 22 of file Token.php.

Referenced by __construct(), and getValue().

BLOCK_END_TYPE

const Twig_Token::BLOCK_END_TYPE = 3

Definition at line 30 of file Token.php.

Referenced by Twig_Lexer\lexBlock(), Twig_Extensions_Grammar_Body\parse(), Twig_Extensions_Grammar_Optional\parse(), Twig_Extensions_Grammar_Tag\parse(), Twig_Extensions_TokenParser_Trans\parse(), Twig_TokenParser_AutoEscape\parse(), Twig_TokenParser_Block\parse(), Twig_TokenParser_Do\parse(), Twig_TokenParser_Embed\parse(), Twig_TokenParser_Extends\parse(), Twig_TokenParser_Filter\parse(), Twig_TokenParser_Flush\parse(), Twig_TokenParser_For\parse(), Twig_TokenParser_From\parse(), Twig_TokenParser_If\parse(), Twig_TokenParser_Import\parse(), Twig_TokenParser_Macro\parse(), Twig_TokenParser_Sandbox\parse(), Twig_TokenParser_Set\parse(), Twig_TokenParser_Spaceless\parse(), Twig_TokenParser_Use\parse(), Twig_TokenParser_With\parse(), TwigTestTokenParser_§\parse(), TestTokenParser\parse(), Twig_TokenParser_Include\parseArguments(), Twig_Tests_ParserTest\testParseIsReentrant(), Twig_Tests_LexerTest\testStringWithNestedInterpolationsInBlock(), Twig_Tests_ParserTest\testUnknownTag(), Twig_Tests_ParserTest\testUnknownTagWithoutSuggestions(), typeToEnglish(), and typeToString().

BLOCK_START_TYPE

const Twig_Token::BLOCK_START_TYPE = 1

Definition at line 28 of file Token.php.

Referenced by Twig_Lexer\lexData(), Twig_TokenParser_Embed\parse(), TestTokenParser\parse(), Twig_Parser\subparse(), Twig_Tests_TokenStreamTest\testEndOfTemplateLook(), Twig_Tests_TokenStreamTest\testEndOfTemplateNext(), Twig_Tests_LexerTest\testNameLabelForTag(), Twig_Tests_ParserTest\testParseIsReentrant(), Twig_Tests_LexerTest\testStringWithNestedInterpolationsInBlock(), Twig_Tests_ParserTest\testUnknownTag(), Twig_Tests_ParserTest\testUnknownTagWithoutSuggestions(), typeToEnglish(), and typeToString().

EOF_TYPE

const Twig_Token::EOF_TYPE = -1

Definition at line 26 of file Token.php.

Referenced by Twig_TokenStream\isEOF(), TestTokenParser\parse(), Twig_Tests_TokenStreamTest\setUp(), Twig_Tests_ParserTest\testParseIsReentrant(), Twig_Tests_ParserTest\testUnknownTag(), Twig_Tests_ParserTest\testUnknownTagWithoutSuggestions(), Twig_Lexer\tokenize(), typeToEnglish(), and typeToString().

INTERPOLATION_END_TYPE

const Twig_Token::INTERPOLATION_END_TYPE = 11

Definition at line 38 of file Token.php.

Referenced by Twig_Lexer\lexInterpolation(), Twig_ExpressionParser\parseStringExpression(), Twig_Tests_LexerTest\testStringWithInterpolation(), Twig_Tests_LexerTest\testStringWithNestedInterpolations(), Twig_Tests_LexerTest\testStringWithNestedInterpolationsInBlock(), typeToEnglish(), and typeToString().

INTERPOLATION_START_TYPE

const Twig_Token::INTERPOLATION_START_TYPE = 10

Definition at line 37 of file Token.php.

Referenced by Twig_Lexer\lexString(), Twig_ExpressionParser\parsePrimaryExpression(), Twig_ExpressionParser\parseStringExpression(), Twig_Tests_LexerTest\testStringWithInterpolation(), Twig_Tests_LexerTest\testStringWithNestedInterpolations(), Twig_Tests_LexerTest\testStringWithNestedInterpolationsInBlock(), typeToEnglish(), and typeToString().

NAME_TYPE

const Twig_Token::NAME_TYPE = 5

Definition at line 32 of file Token.php.

Referenced by Twig_Extensions_Grammar_Constant\__construct(), Twig_ExpressionParser\getTest(), Twig_Lexer\lexExpression(), Twig_Extensions_Grammar_Boolean\parse(), Twig_Extensions_Grammar_Optional\parse(), Twig_Extensions_Grammar_Switch\parse(), Twig_TokenParser_AutoEscape\parse(), Twig_TokenParser_Block\parse(), Twig_TokenParser_Embed\parse(), Twig_TokenParser_For\parse(), Twig_TokenParser_From\parse(), Twig_TokenParser_Import\parse(), Twig_TokenParser_Macro\parse(), Twig_TokenParser_Use\parse(), Twig_TokenParser_With\parse(), TestTokenParser\parse(), Twig_ExpressionParser\parseArguments(), Twig_TokenParser_Include\parseArguments(), Twig_ExpressionParser\parseAssignmentExpression(), Twig_ExpressionParser\parseFilterExpressionRaw(), Twig_ExpressionParser\parseHashExpression(), Twig_ExpressionParser\parsePrimaryExpression(), Twig_ExpressionParser\parseSubscriptExpression(), Twig_Parser\subparse(), test(), Twig_Tests_LexerTest\testLineDirective(), Twig_Tests_LexerTest\testLineDirectiveInline(), Twig_Tests_LexerTest\testNameLabelForFunction(), Twig_Tests_LexerTest\testNameLabelForTag(), Twig_Tests_ParserTest\testParseIsReentrant(), Twig_Tests_LexerTest\testStringWithInterpolation(), Twig_Tests_LexerTest\testStringWithNestedInterpolations(), Twig_Tests_LexerTest\testStringWithNestedInterpolationsInBlock(), Twig_Tests_ParserTest\testUnknownTag(), Twig_Tests_ParserTest\testUnknownTagWithoutSuggestions(), typeToEnglish(), and typeToString().

NUMBER_TYPE

const Twig_Token::NUMBER_TYPE = 6

Definition at line 33 of file Token.php.

Referenced by Twig_Lexer\lexExpression(), Twig_Extensions_Grammar_Number\parse(), Twig_ExpressionParser\parseHashExpression(), Twig_ExpressionParser\parsePrimaryExpression(), Twig_ExpressionParser\parseSubscriptExpression(), Twig_Tests_LexerTest\testOperatorEndingWithALetterAtTheEndOfALine(), Twig_Tests_LexerTest\testStringWithInterpolation(), typeToEnglish(), and typeToString().

OPERATOR_TYPE

const Twig_Token::OPERATOR_TYPE = 8

Definition at line 35 of file Token.php.

Referenced by Twig_ExpressionParser\isBinary(), Twig_ExpressionParser\isUnary(), Twig_Lexer\lexExpression(), Twig_TokenParser_For\parse(), Twig_TokenParser_Set\parse(), Twig_ExpressionParser\parseArguments(), Twig_ExpressionParser\parsePrimaryExpression(), Twig_ExpressionParser\parseSubscriptExpression(), Twig_Tests_LexerTest\testOperatorEndingWithALetterAtTheEndOfALine(), Twig_Tests_LexerTest\testStringWithInterpolation(), typeToEnglish(), and typeToString().

PUNCTUATION_TYPE

const Twig_Token::PUNCTUATION_TYPE = 9

Definition at line 36 of file Token.php.

Referenced by Twig_ExpressionParser\getPrimary(), Twig_Tests_SimpleTokenParserTest\getTests(), Twig_Lexer\lexExpression(), Twig_TokenParser_From\parse(), Twig_TokenParser_Use\parse(), Twig_ExpressionParser\parseArguments(), Twig_ExpressionParser\parseArrayExpression(), Twig_ExpressionParser\parseAssignmentExpression(), Twig_ExpressionParser\parseConditionalExpression(), Twig_ExpressionParser\parseFilterExpressionRaw(), Twig_Extensions_SimpleTokenParser\parseGrammar(), Twig_ExpressionParser\parseHashExpression(), Twig_ExpressionParser\parseMultitargetExpression(), Twig_ExpressionParser\parsePostfixExpression(), Twig_ExpressionParser\parsePrimaryExpression(), Twig_ExpressionParser\parseSubscriptExpression(), Twig_ExpressionParser\parseTestExpression(), Twig_Tests_LexerTest\testBracketsNesting(), typeToEnglish(), and typeToString().

STRING_TYPE

const Twig_Token::STRING_TYPE = 7

Definition at line 34 of file Token.php.

Referenced by Twig_Lexer\lexExpression(), Twig_Lexer\lexString(), Twig_TokenParser_Embed\parse(), TestTokenParser\parse(), Twig_ExpressionParser\parseHashExpression(), Twig_ExpressionParser\parsePrimaryExpression(), Twig_ExpressionParser\parseStringExpression(), Twig_Tests_LexerTest\testStringWithEscapedDelimiter(), Twig_Tests_LexerTest\testStringWithEscapedInterpolation(), Twig_Tests_LexerTest\testStringWithHash(), Twig_Tests_LexerTest\testStringWithInterpolation(), Twig_Tests_LexerTest\testStringWithNestedInterpolations(), Twig_Tests_LexerTest\testStringWithNestedInterpolationsInBlock(), typeToEnglish(), and typeToString().

TEXT_TYPE

const Twig_Token::TEXT_TYPE = 0

Definition at line 27 of file Token.php.

Referenced by Twig_Lexer\lexData(), Twig_Lexer\lexRawData(), Twig_Lexer\pushToken(), Twig_Tests_TokenStreamTest\setUp(), Twig_Parser\subparse(), Twig_Tests_LexerTest\testLineDirective(), Twig_Tests_LexerTest\testLineDirectiveInline(), Twig_Tests_LexerTest\testStringWithInterpolation(), typeToEnglish(), and typeToString().

VAR_END_TYPE

const Twig_Token::VAR_END_TYPE = 4

Definition at line 31 of file Token.php.

Referenced by Twig_Lexer\lexVar(), Twig_Parser\subparse(), Twig_Tests_ParserTest\testParseIsReentrant(), Twig_Tests_LexerTest\testStringWithEscapedInterpolation(), Twig_Tests_LexerTest\testStringWithHash(), Twig_Tests_LexerTest\testStringWithInterpolation(), Twig_Tests_LexerTest\testStringWithNestedInterpolations(), typeToEnglish(), and typeToString().

VAR_START_TYPE

const Twig_Token::VAR_START_TYPE = 2

Definition at line 29 of file Token.php.

Referenced by Twig_Lexer\lexData(), Twig_Parser\subparse(), Twig_Tests_LexerTest\testLineDirective(), Twig_Tests_LexerTest\testLineDirectiveInline(), Twig_Tests_LexerTest\testNameLabelForFunction(), Twig_Tests_LexerTest\testOperatorEndingWithALetterAtTheEndOfALine(), Twig_Tests_ParserTest\testParseIsReentrant(), Twig_Tests_LexerTest\testStringWithEscapedDelimiter(), Twig_Tests_LexerTest\testStringWithEscapedInterpolation(), Twig_Tests_LexerTest\testStringWithHash(), Twig_Tests_LexerTest\testStringWithInterpolation(), Twig_Tests_LexerTest\testStringWithNestedInterpolations(), typeToEnglish(), and typeToString().

---

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

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