TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface:

Public Member Functions
	setIdentifier (string $identifier)
	getIdentifier ()
	getName ()
	updateName (string $name)
	addChild (ChildNodeInterface $node)
	getChildByName (string $name)
	removeChildByName (string $name)
	hasChildren ()
iterable< ChildNodeInterface >	getNextChild ()
	sortChildren ()
	setValue (?string $value)
	appendValue (string $value)
	getValue ()
	isValueNull ()
	setPreviousValue (?string $value)
	getPreviousValue ()
	setOriginalValueTokenStream (?TokenStreamInterface $tokenStream)
	getOriginalValueTokenStream ()
	addComment (TokenStreamInterface $tokenStream)
TokenStreamInterface[]	getComments ()
	toArray ()
	flatten (string $prefix='')

Detailed Description

The created AST consists of a NodeRoot object with nested NodeObject children. This is the main interface to any node type.

Example TypoScript: "foo = fooValue" "foo.bar = barValue" This creates a RootNode with one ChildNode name "foo" and value "fooValue", that has a child ChildNode name "bar" and value "barValue".

: Internal AST structure.

Definition at line 34 of file NodeInterface.php.

Member Function Documentation

addChild()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::addChild

(

ChildNodeInterface

$node

)

Helper methods to operate on children.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Merger\SetupConfigMerger\mergeRecursive().

addComment()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::addComment

(

TokenStreamInterface

$tokenStream

)

Helper methods to attach TypoScript tokens to a node. This is used in ext:tstemplate "Constant Editor" and "Object Browser" and handled by CommentAwareAstBuilder.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

appendValue()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::appendValue

(

string

$value

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode, and TYPO3\CMS\Core\TypoScript\AST\Node\RootNode.

flatten()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::flatten

(

string

$prefix = ''

)

Flatten the tree. A RootNode with a ChildNode "foo" and value "fooValue", with this ChildNode again having a ChildNode "bar" and value "barValue" becomes: [ 'foo' => 'fooValue', 'foo.bar' => 'barValue', ]

Flattening a TypoScript tree is especially used for constants to quickly look up constants when parsing setup node value streams that use T_CONSTANT tokens.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\RootNode, and TYPO3\CMS\Core\TypoScript\AST\Node\AbstractChildNode.

getChildByName()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getChildByName

(

string

$name

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Merger\SetupConfigMerger\mergeRecursive().

getComments()

TokenStreamInterface [] TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getComments

(

)

Returns

‪TokenStreamInterface[]

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

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

getIdentifier()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getIdentifier

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Visitor\AstNodeFinderVisitor\visitBeforeChildren().

getName()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getName

(

)

Helper methods for node name.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\RootNode, TYPO3\CMS\Core\TypoScript\AST\Node\RootNode, and TYPO3\CMS\Core\TypoScript\AST\Node\AbstractChildNode.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode\addChild(), and TYPO3\CMS\Core\TypoScript\AST\Visitor\AstConstantCommentVisitor\visitBeforeChildren().

getNextChild()

iterable<ChildNodeInterface> TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getNextChild

(

)

Returns

‪iterable<ChildNodeInterface>

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Merger\SetupConfigMerger\merge(), TYPO3\CMS\Core\TypoScript\AST\Merger\SetupConfigMerger\mergeRecursive(), and TYPO3\CMS\Core\TypoScript\AST\Traverser\AstTraverser\traverseRecursive().

getOriginalValueTokenStream()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getOriginalValueTokenStream

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

getPreviousValue()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getPreviousValue

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

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

getValue()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::getValue

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode, and TYPO3\CMS\Core\TypoScript\AST\Node\RootNode.

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

hasChildren()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::hasChildren

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

isValueNull()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::isValueNull

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode, and TYPO3\CMS\Core\TypoScript\AST\Node\RootNode.

removeChildByName()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::removeChildByName

(

string

$name

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

setIdentifier()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::setIdentifier

(

string

$identifier

)

An identifier for this node. Typically, a hash of some kind. This identifier is unique within the tree, by being created from the parent identifier plus the name. This identifier is used in the backend, when referencing single nodes. Calculating identifiers is initiated by calling setIdentifier() on RootNode, which will recurse the tree. Call this on the final tree, after AST calculation finished, so AST building itself does not need to fiddle with identifier updates when for instance tree parts are cloned using '<' operator. Note this value is skipped when persisting to caches since it's a Backend related thing that does not use cached context: When retrieving nodes from cache (e.g. in Frontend), the identifier is null and calling the getter will throw an exception.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

setOriginalValueTokenStream()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::setOriginalValueTokenStream

(

?TokenStreamInterface

$tokenStream

)

Helper method mostly for backend object browser to retrieve the original stream when a constant substitution happened.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

setPreviousValue()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::setPreviousValue

(

?string

$value

)

Previous value is only set by comment aware ast builder. It is used in constant editor to see if a value has been changed.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

setValue()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::setValue

(

?string

$value

)

Helper methods for value.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode, and TYPO3\CMS\Core\TypoScript\AST\Node\RootNode.

sortChildren()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::sortChildren

(

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode.

Referenced by TYPO3\CMS\Core\TypoScript\AST\Visitor\AstSortChildrenVisitor\visitBeforeChildren().

toArray()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::toArray

(

)

b/w compat method to turn AST into an array. Note we're NOT using magic __toArray() here to avoid calling array-cast of AST by accident: toArray() should be called explicitly if needed, which makes it much easier to drop this b/w compat method when we later want to drop that layer.

Note RootNode always returns an array, while ObjectNode's may return null.

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractChildNode.

updateName()

TYPO3\CMS\Core\TypoScript\AST\Node\NodeInterface::updateName

(

string

$name

)

Implemented in TYPO3\CMS\Core\TypoScript\AST\Node\AbstractNode, and TYPO3\CMS\Core\TypoScript\AST\Node\RootNode.