interface NodeInterface implements CacheAwareInterface (View source)

This is a NEW interface, introduced in Neos 4.3.

The new Event-Sourced core NodeInterface used for READING. It contains only information local to a node; i.e. all properties in this interface can be accessed extremely fast.

Most likely, you want to use {\Neos\ContentRepository\Domain\Projection\Content\TraversableNodeInterface} instead, as it is more convenient to use for end-users, as it also contains node traversal operations.

The NodeInterface is immutable, meaning its contents never change after creation. It is only used for reading.

Starting with version 5.0 (when backed by the Event Sourced CR), it is completely detached from storage; so it will not auto-update after a property changed in storage.

Methods

bool
isRoot()

Whether or not this node is the root of the graph, i.e. has no parent node

bool
isTethered()

Whether or not this node is tethered to its parent, fka auto created child node

getNodeTypeName()

No description

getNodeType()

No description

NodeName|null
getNodeName()

No description

OriginDimensionSpacePoint
getOriginDimensionSpacePoint()

returns the DimensionSpacePoint the node is at home in. Usually needed to address a Node in a NodeAggregate in order to update it.

getProperties()

Returns all properties of this node. References are NOT part of this API; there you need to check getReference() and getReferences()

mixed
getProperty(string $propertyName)

Returns the specified property.

bool
hasProperty(string $propertyName)

If this node has a property with the given name. Does NOT check the NodeType; but checks for a non-NULL property value.

string
getLabel()

Returns the node label as generated by the configured node label generator

Details

bool isRoot()

Whether or not this node is the root of the graph, i.e. has no parent node

Return Value

bool

bool isTethered()

Whether or not this node is tethered to its parent, fka auto created child node

Return Value

bool

ContentStreamIdentifier getContentStreamIdentifier()

No description

NodeAggregateIdentifier getNodeAggregateIdentifier()

No description

NodeTypeName getNodeTypeName()

No description

Return Value

NodeTypeName

NodeType getNodeType()

No description

Return Value

NodeType

NodeName|null getNodeName()

No description

Return Value

NodeName|null

OriginDimensionSpacePoint getOriginDimensionSpacePoint()

returns the DimensionSpacePoint the node is at home in. Usually needed to address a Node in a NodeAggregate in order to update it.

Return Value

OriginDimensionSpacePoint

PropertyCollectionInterface getProperties()

Returns all properties of this node. References are NOT part of this API; there you need to check getReference() and getReferences()

Return Value

PropertyCollectionInterface

Property values, indexed by their name

mixed getProperty(string $propertyName)

Returns the specified property.

If the node has a content object attached, the property will be fetched there if it is gettable.

Parameters

string $propertyName

Name of the property

Return Value

mixed

value of the property

bool hasProperty(string $propertyName)

If this node has a property with the given name. Does NOT check the NodeType; but checks for a non-NULL property value.

Parameters

string $propertyName

Return Value

bool

string getLabel()

Returns the node label as generated by the configured node label generator

Return Value

string