TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream Class Reference

Inheritance diagram for TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream:

Public Member Functions
	__toString ()
	__serialize ()
	append (TokenInterface $token)
	isEmpty ()
	reset ()
	getNext ()
	peekNext ()
	getAll ()
	setAll (array $tokens)

Protected Member Functions
	serialize ()

Protected Attributes
array	$tokens = []
int	$currentIndex = -1

Detailed Description

A generic implementation of TokenStreamInterface.

: Internal tokenizer structure.

Definition at line 25 of file AbstractTokenStream.php.

Member Function Documentation

__serialize()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::__serialize ( )

final

When storing to cache, we only store FE relevant properties and skip irrelevant things. For instance $currentIndex should always initialize to -1 and does not need to be stored.

Definition at line 51 of file AbstractTokenStream.php.

References TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\serialize().

__toString()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::__toString

(

)

Create a source string from given tokens.

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Reimplemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\IdentifierTokenStream, and TYPO3\CMS\Core\TypoScript\Tokenizer\Token\ConstantAwareTokenStream.

Definition at line 36 of file AbstractTokenStream.php.

References TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\getNext(), and TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\reset().

append()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::append

(

TokenInterface

$token

)

Stream creation.

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Reimplemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\IdentifierTokenStream.

Definition at line 65 of file AbstractTokenStream.php.

getAll()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::getAll

(

)

Only used internally when one Stream is transferred to another, in particular when a TokenStream is turned into TokenStreamConstantAware.

Returns

‪TokenInterface[]

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Definition at line 103 of file AbstractTokenStream.php.

References TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\$tokens.

getNext()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::getNext

(

)

Get next token and raise pointer.

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Definition at line 92 of file AbstractTokenStream.php.

References TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\$currentIndex.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\__toString(), TYPO3\CMS\Core\TypoScript\Tokenizer\Token\ConstantAwareTokenStream\__toString(), and TYPO3\CMS\Core\TypoScript\Tokenizer\Token\IdentifierTokenStream\__toString().

isEmpty()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::isEmpty

(

)

We sometimes create a stream but don't add tokens. This method returns true if tokens have been added.

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Definition at line 75 of file AbstractTokenStream.php.

peekNext()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::peekNext

(

)

Get next token but do not raise pointer.

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Definition at line 98 of file AbstractTokenStream.php.

reset()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::reset

(

)

Reset current pointer. Typically, call this before iterating with getNext().

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Definition at line 83 of file AbstractTokenStream.php.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\__toString(), TYPO3\CMS\Core\TypoScript\Tokenizer\Token\ConstantAwareTokenStream\__toString(), TYPO3\CMS\Core\TypoScript\Tokenizer\Token\IdentifierTokenStream\__toString(), and TYPO3\CMS\Core\TypoScript\AST\AbstractAstBuilder\getOrAddNodeFromIdentifierStream().

serialize()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::serialize ( )

protected

Reimplemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\IdentifierTokenStream.

Definition at line 56 of file AbstractTokenStream.php.

References TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\$tokens.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\__serialize().

setAll()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::setAll

(

array

$tokens

)

Only used internally when one Stream is transferred to another, in particular when a TokenStream is turned into TokenStreamConstantAware.

Parameters

TokenInterface[]

$tokens

Implements TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface.

Definition at line 108 of file AbstractTokenStream.php.

References TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\$tokens.

Member Data Documentation

$currentIndex

int TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::$currentIndex = -1

protected

Definition at line 31 of file AbstractTokenStream.php.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\getNext().

$tokens

array TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream::$tokens = []

protected

Definition at line 30 of file AbstractTokenStream.php.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\getAll(), TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\serialize(), and TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream\setAll().