Twig_TokenStream Class Reference

Represents a token stream. More...

Collaboration diagram for Twig_TokenStream:

Public Member Functions
	__construct (array $tokens, $name=null, $source=null)
	__toString ()
	injectTokens (array $tokens)
	next ()
	Sets the pointer to the next token and returns the old one. More...
	nextIf ($primary, $secondary=null)
	Tests a token, sets the pointer to the next one and returns it or throws a syntax error. More...
	expect ($type, $value=null, $message=null)
	Tests a token and returns it or throws a syntax error. More...
	look ($number=1)
	Looks at the next token. More...
	test ($primary, $secondary=null)
	Tests the current token. More...
	isEOF ()
	Checks if end of stream was reached. More...
	getCurrent ()
	getFilename ()
	Gets the name associated with this stream (null if not defined). More...
	getSource ()
	Gets the source code associated with this stream. More...
	getSourceContext ()
	Gets the source associated with this stream. More...

Protected Attributes
	$tokens
	$current = 0
	$filename

Private Attributes
	$source

Detailed Description

Represents a token stream.

Author

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

Definition at line 20 of file TokenStream.php.

Constructor & Destructor Documentation

__construct()

Twig_TokenStream::__construct	(	array	$tokens,
			$name = null,
			$source = null
	)

Parameters

array	$tokens	An array of tokens
string | null	$name	The name of the template which tokens are associated with
string | null	$source	The source code associated with the tokens

Definition at line 33 of file TokenStream.php.

References $name, $source, and $tokens.

    {
        if (!$name instanceof Twig_Source) {
            if (null !== $name || null !== $source) {
                @trigger_error(sprintf('Passing a string as the $name argument of %s() is deprecated since version 1.27. Pass a Twig_Source instance instead.', __METHOD__), E_USER_DEPRECATED);
            }
            $this->source = new Twig_Source($source, $name);
        } else {
            $this->source = $name;
        }

        $this->tokens = $tokens;

        // deprecated, not used anymore, to be removed in 2.0
        $this->filename = $this->source->getName();
    }

Member Function Documentation

__toString()

Twig_TokenStream::__toString

(

)

Definition at line 50 of file TokenStream.php.

    {
        return implode("\n", $this->tokens);
    }

expect()

Twig_TokenStream::expect	(		$type,
			$value = null,
			$message = null
	)

Tests a token and returns it or throws a syntax error.

Returns

Twig_Token

Definition at line 91 of file TokenStream.php.

References $current, $message, $type, next(), and Twig_Token\typeToEnglish().

    {
        $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->source
            );
        }
        $this->next();

        return $token;
    }

Here is the call graph for this function:

getCurrent()

Twig_TokenStream::getCurrent

(

)

Returns

Twig_Token

Definition at line 148 of file TokenStream.php.

References $current.

    {
        return $this->tokens[$this->current];
    }

getFilename()

Twig_TokenStream::getFilename

(

)

Gets the name associated with this stream (null if not defined).

Returns

string|null

Deprecated:

since 1.27 (to be removed in 2.0)

Definition at line 160 of file TokenStream.php.

    {
        @trigger_error(sprintf('The %s() method is deprecated since version 1.27 and will be removed in 2.0. Use getSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);

        return $this->source->getName();
    }

getSource()

Twig_TokenStream::getSource

(

)

Gets the source code associated with this stream.

Returns

string

Definition at line 176 of file TokenStream.php.

    {
        @trigger_error(sprintf('The %s() method is deprecated since version 1.27 and will be removed in 2.0. Use getSourceContext() instead.', __METHOD__), E_USER_DEPRECATED);

        return $this->source->getCode();
    }

getSourceContext()

Twig_TokenStream::getSourceContext

(

)

Gets the source associated with this stream.

Returns

Twig_Source

Definition at line 190 of file TokenStream.php.

References $source.

Referenced by Twig_TokenParser_For\checkLoopUsageBody(), Twig_TokenParser_For\checkLoopUsageCondition(), and Twig_Parser\parse().

    {
        return $this->source;
    }

Here is the caller graph for this function:

injectTokens()

Twig_TokenStream::injectTokens

(

array

$tokens

)

Definition at line 55 of file TokenStream.php.

    {
        $this->tokens = array_merge(array_slice($this->tokens, 0, $this->current), $tokens, array_slice($this->tokens, $this->current));
    }

isEOF()

Twig_TokenStream::isEOF

(

)

Checks if end of stream was reached.

Returns

bool

Definition at line 140 of file TokenStream.php.

References $current, and Twig_Token\EOF_TYPE.

    {
        return Twig_Token::EOF_TYPE === $this->tokens[$this->current]->getType();
    }

look()

Twig_TokenStream::look

(

$number = 1

)

Looks at the next token.

Parameters

int

$number

Returns

Twig_Token

Definition at line 116 of file TokenStream.php.

    {
        if (!isset($this->tokens[$this->current + $number])) {
            throw new Twig_Error_Syntax('Unexpected end of template.', $this->tokens[$this->current + $number - 1]->getLine(), $this->source);
        }

        return $this->tokens[$this->current + $number];
    }

next()

Twig_TokenStream::next

(

)

Sets the pointer to the next token and returns the old one.

Returns

Twig_Token

Definition at line 65 of file TokenStream.php.

Referenced by expect(), and nextIf().

    {
        if (!isset($this->tokens[++$this->current])) {
            throw new Twig_Error_Syntax('Unexpected end of template.', $this->tokens[$this->current - 1]->getLine(), $this->source);
        }

        return $this->tokens[$this->current - 1];
    }

Here is the caller graph for this function:

nextIf()

Twig_TokenStream::nextIf	(		$primary,
			$secondary = null
	)

Tests a token, sets the pointer to the next one and returns it or throws a syntax error.

Returns

Twig_Token|null The next token if the condition is true, null otherwise

Definition at line 79 of file TokenStream.php.

References next(), and test().

    {
        if ($this->tokens[$this->current]->test($primary, $secondary)) {
            return $this->next();
        }
    }

Here is the call graph for this function:

test()

Twig_TokenStream::test	(		$primary,
			$secondary = null
	)

Tests the current token.

Returns

bool

Definition at line 130 of file TokenStream.php.

References $current.

Referenced by nextIf().

    {
        return $this->tokens[$this->current]->test($primary, $secondary);
    }

Here is the caller graph for this function:

Field Documentation

$current

Twig_TokenStream::$current = 0

protected

Definition at line 23 of file TokenStream.php.

Referenced by expect(), getCurrent(), isEOF(), and test().

$filename

Twig_TokenStream::$filename

protected

Definition at line 24 of file TokenStream.php.

$source

Twig_TokenStream::$source

private

Definition at line 26 of file TokenStream.php.

Referenced by __construct(), and getSourceContext().

$tokens

Twig_TokenStream::$tokens

protected

Definition at line 22 of file TokenStream.php.

Referenced by __construct().

---

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

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