TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface Interface Reference

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

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

Detailed Description

A generic stream of tokens used in single LineInterface lines.

The tokenizers create these streams for various lists of tokens, the generic implementation is class TokenStream. For lists of identifier tokens the special class TokenStreamIdentifier is created.

: Internal tokenizer structure.

Definition at line 29 of file TokenStreamInterface.php.

Member Function Documentation

__toString()

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

(

)

Create a source string from given tokens.

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

append()

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

(

TokenInterface

$token

)

Stream creation.

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\IdentifierTokenStream, and TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\LosslessTokenizer\parseOperatorMultilineAssignment().

getAll()

TokenInterface [] TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface::getAll

(

)

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

Returns

‪TokenInterface[]

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.

getNext()

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

(

)

Get next token and raise pointer.

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Visitor\AstConstantCommentVisitor\parseNodeComment().

isEmpty()

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

(

)

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

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.

Referenced by TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierBlockOpenLine\setIdentifierTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierUnsetLine\setIdentifierTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierFunctionLine\setIdentifierTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierReferenceLine\setIdentifierTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierCopyLine\setIdentifierTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierAssignmentLine\setIdentifierTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierReferenceLine\setValueTokenStream(), TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierCopyLine\setValueTokenStream(), and TYPO3\CMS\Core\TypoScript\Tokenizer\Line\IdentifierAssignmentLine\setValueTokenStream().

peekNext()

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

(

)

Get next token but do not raise pointer.

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Visitor\AstConstantCommentVisitor\parseCustomCategoryAndSubCategories().

reset()

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

(

)

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

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Visitor\AstConstantCommentVisitor\parseNodeComment().

setAll()

TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenStreamInterface::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

Implemented in TYPO3\CMS\Core\TypoScript\Tokenizer\Token\AbstractTokenStream.