• Home
• Neos
• ContentRepository
• Domain
• Model
• Node

PHP Class Neos\ContentRepository\Domain\Model\Node

Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$context	Neos\ContentRepository\Domain\Service\Context
$contextFactory	Neos\ContentRepository\Domain\Service\ContextFactoryInterface
$nodeData	NodeData	The NodeData entity this version is for.
$nodeDataIsMatchingContext	boolean	Defines if the NodeData represented by this Node is already in the same context or if it is currently just "shining through".
$nodeDataRepository	Neos\ContentRepository\Domain\Repository\NodeDataRepository
$nodeFactory	Neos\ContentRepository\Domain\Factory\NodeFactory
$nodeService	Neos\ContentRepository\Domain\Service\NodeServiceInterface
$propertyMapper	Neos\Flow\Property\PropertyMapper

Public Methods

Method	Description
__construct ( NodeData $nodeData, Context $context )
__toString ( ) : string	For debugging purposes, the node can be converted to a string.
copyAfter ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $nodeName ) : Neos\ContentRepository\Domain\Model\NodeInterface	Copies this node after the given node
copyBefore ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $nodeName ) : Neos\ContentRepository\Domain\Model\NodeInterface	Copies this node before the given node
copyInto ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $nodeName ) : Neos\ContentRepository\Domain\Model\NodeInterface	Copies this node into the given node
createNode ( string $name, NodeType $nodeType = null, string $identifier = null ) : Neos\ContentRepository\Domain\Model\NodeInterface	Creates, adds and returns a child node of this node. Also sets default properties and creates default subnodes.
createNodeFromTemplate ( NodeTemplate $nodeTemplate, string $nodeName = null ) : Neos\ContentRepository\Domain\Model\NodeInterface	Creates and persists a node from the given $nodeTemplate as child node
createSingleNode ( string $name, NodeType $nodeType = null, string $identifier = null ) : Node	Creates, adds and returns a child node of this node, without setting default properties or creating subnodes. Only used internally.
createVariantForContext ( Context $context ) : Neos\ContentRepository\Domain\Model\NodeInterface	Given a context a new node is returned that is like this node, but lives in the new context.
dimensionsAreMatchingTargetDimensionValues ( ) : boolean	Internal method
getAccessRoles ( ) : array	Returns the names of defined access roles
getCacheEntryIdentifier ( ) : string	Returns a string which distinctly identifies this object and thus can be used as an identifier for cache entries related to this object.
getChildNodes ( string $nodeTypeFilter = null, integer $limit = null, integer $offset = null ) : array<\Neos\ContentRepository\Domain\Model\NodeInterface>	Returns all direct child nodes of this node.
getContentObject ( ) : object	Returns the content object of this node (if any).
getContext ( ) : Context	Returns the context this node operates in.
getContextPath ( ) : string	Returns the absolute path of this node with additional context information (such as the workspace name).
getCreationDateTime ( ) : DateTimeInterface
getDepth ( ) : integer	Returns the level at which this node is located.
getDimensions ( ) : array	Return the assigned content dimensions of the node.
getFullLabel ( ) : string	Returns a full length plain text description of this node
getHiddenAfterDateTime ( ) : DateTime	Returns the date and time after which this node will be automatically hidden.
getHiddenBeforeDateTime ( ) : DateTime	Returns the date and time before which this node will be automatically hidden.
getIdentifier ( ) : string	Returns the identifier of this node
getIndex ( ) : integer	Returns the index of this node which determines the order among siblings with the same parent node.
getLabel ( ) : string	Returns the node label as generated by the configured node label generator
getLastModificationDateTime ( ) : DateTimeInterface
getLastPublicationDateTime ( ) : DateTime
getName ( ) : string	Returns the name of this node
getNode ( string $path ) : Neos\ContentRepository\Domain\Model\NodeInterface	Returns a node specified by the given relative path.
getNodeData ( ) : NodeData
getNodeType ( ) : NodeType	Returns the node type of this node.
getNumberOfChildNodes ( string $nodeTypeFilter = null ) : integer	Returns the number of child nodes a similar getChildNodes() call would return.
getOtherNodeVariants ( )
getParent ( ) : Neos\ContentRepository\Domain\Model\NodeInterface	Returns the parent node of this node
getParentPath ( ) : string	Returns the parent node path
getPath ( ) : string	Returns the path of this node
getPrimaryChildNode ( ) : Node	Returns the primary child node of this node.
getProperties ( boolean $returnNodesAsIdentifiers = false ) : array	Returns all properties of this node.
getProperty ( string $propertyName, boolean $returnNodesAsIdentifiers = false ) : mixed	Returns the specified property.
getPropertyNames ( ) : array	Returns the names of all properties of this node.
getWorkspace ( ) : Workspace	Returns the workspace this node is contained in
hasAccessRestrictions ( ) : boolean	Tells if a node, in general, has access restrictions, independent of the current security context.
hasChildNodes ( string $nodeTypeFilter = null ) : boolean	Checks if this node has any child nodes.
hasProperty ( string $propertyName ) : boolean	If this node has a property with the given name.
isAccessible ( ) : boolean	Tells if this node may be accessed according to the current security context.
isAutoCreated ( ) : boolean	Determine if this node is configured as auto-created childNode of the parent node. If that is the case, it should not be deleted.
isHidden ( ) : boolean	Returns the current state of the hidden flag
isHiddenInIndex ( ) : boolean	If this node should be hidden in indexes
isNodeTypeAllowedAsChildNode ( NodeType $nodeType ) : boolean	Checks if the given $nodeType would be allowed as a child node of this node according to the configured constraints.
isRemoved ( ) : boolean	If this node is a removed node.
isVisible ( ) : boolean	Tells if this node is "visible".
moveAfter ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $newName = null )	Moves this node after the given node
moveBefore ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $newName = null )	Moves this node before the given node
moveInto ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $newName = null )	Moves this node into the given node
remove ( ) : void	Removes this node and all its child nodes. This is an alias for setRemoved(TRUE)
removeProperty ( string $propertyName ) : void	Removes the specified property.
setAccessRoles ( array $accessRoles ) : void	Sets the roles which are required to access this node
setContentObject ( object $contentObject ) : void	Sets a content object for this node.
setHidden ( boolean $hidden ) : void	Sets the "hidden" flag for this node.
setHiddenAfterDateTime ( DateTime $dateTime = null ) : void	Sets the date and time when this node should be automatically hidden
setHiddenBeforeDateTime ( DateTime $dateTime = null ) : void	Sets the date and time when this node becomes potentially visible.
setHiddenInIndex ( boolean $hidden ) : void	Sets if this node should be hidden in indexes, such as a site navigation.
setIndex ( integer $index ) : void	Sets the index of this node
setLastPublicationDateTime ( DateTimeInterface $lastModificationDateTime ) : void
setName ( string $newName ) : void	Set the name of the node to $newName, keeping its position as it is.
setNodeData ( NodeData $nodeData ) : void	Set the associated NodeData in regards to the Context.
setNodeDataIsMatchingContext ( boolean $status ) : void	Set the status of the associated NodeData in regards to the Context.
setNodeType ( NodeType $nodeType ) : void	Sets the node type of this node.
setProperty ( string $propertyName, mixed $value ) : mixed	Sets the specified property.
setRemoved ( boolean $removed ) : void	Enables using the remove method when only setters are available
setWorkspace ( Workspace $workspace ) : void	Sets the workspace of this node.
similarize ( Neos\ContentRepository\Domain\Model\NodeInterface $sourceNode, boolean $isCopy = false ) : void	For internal use in createRecursiveCopy.
unsetContentObject ( ) : void	Unsets the content object of this node.

Protected Methods

Method	Description
copyIntoInternal ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, $nodeName, boolean $detachedCopy ) : Neos\ContentRepository\Domain\Model\NodeInterface	Internal method to do the actual copying.
createNodeForVariant ( NodeData $nodeData ) : Node	Create a node for the given NodeData, given that it is a variant of the current node
createRecursiveCopy ( Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, string $nodeName, boolean $detachedCopy ) : Neos\ContentRepository\Domain\Model\NodeInterface	Create a recursive copy of this node below $referenceNode with $nodeName.
emitAfterNodeCopy ( Neos\ContentRepository\Domain\Model\NodeInterface $copiedNode, Neos\ContentRepository\Domain\Model\NodeInterface $targetParentNode ) : void
emitAfterNodeCreate ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : void	Signals that a node was created.
emitAfterNodeMove ( Neos\ContentRepository\Domain\Model\NodeInterface $movedNode, Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, integer $movePosition ) : void
emitBeforeNodeCopy ( Neos\ContentRepository\Domain\Model\NodeInterface $sourceNode, Neos\ContentRepository\Domain\Model\NodeInterface $targetParentNode ) : void
emitBeforeNodeCreate ( Neos\ContentRepository\Domain\Model\NodeInterface $node, string $name, string $nodeType, string $identifier ) : void	Signals that a node will be created.
emitBeforeNodeMove ( Neos\ContentRepository\Domain\Model\NodeInterface $movedNode, Neos\ContentRepository\Domain\Model\NodeInterface $referenceNode, integer $movePosition ) : void
emitBeforeNodePropertyChange ( Neos\ContentRepository\Domain\Model\NodeInterface $node, string $propertyName, mixed $oldValue, mixed $newValue ) : void	Signals that the property of a node will be changed.
emitNodeAdded ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : void	Signals that a node was added.
emitNodePathChanged ( Neos\ContentRepository\Domain\Model\NodeInterface $node, string $oldPath, string $newPath, boolean $recursion )	Signals that the node path has been changed.
emitNodePropertyChanged ( Neos\ContentRepository\Domain\Model\NodeInterface $node, string $propertyName, mixed $oldValue, mixed $newValue ) : void	Signals that the property of a node was changed.
emitNodeRemoved ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : void	Signals that a node was removed.
emitNodeUpdated ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : void	Signals that a node was updated.
isNodeDataMatchingContext ( ) : boolean	The NodeData matches the context if the workspace matches exactly.
isNodePathAvailable ( string $path ) : boolean	Checks if the given node path is available for this node, so either no node with this path exists or an existing node has the same identifier.
materializeNodeData ( ) : void	Materializes the original node data (of a different workspace) into the current workspace.
moveNodeData ( NodeData $nodeData, string $originalPath, string $destinationPath, boolean $recursiveCall ) : array | null	Moves a NodeData object that is either a variant or child node to the given destination path.
moveNodeToDestinationPath ( Neos\ContentRepository\Domain\Model\NodeInterface $node, string $destinationPath ) : void	Moves the given node to the destination path by modifying the underlaying NodeData object.
moveVariantOrChild ( string $aggregateOriginalPath, string $aggregateDestinationPath, Neos\ContentRepository\Domain\Model\NodeInterface $nodeToMove = null ) : array	Moves the given variant or child node to the destination defined by the given path which is the new path for the originally moved (parent|variant) node
resolvePropertyReferences ( array $value = [] ) : array	Maps the property value (an array of node identifiers) to the Node objects if needed.
setPath ( string $path, boolean $checkForExistence = true ) : void	Sets the absolute path of this node.
setPathInternal ( string $destinationPath, boolean $recursiveCall ) : array	Moves a node and sub nodes to the new path.
setPathInternalForAggregate ( string $destinationPath, boolean $recursiveCall ) : array	Moves a node and sub nodes to the new path given with special logic for aggregate node types.
willChildNodeBeAutoCreated ( string $name ) : boolean	Checks if the given Node $name is configured as auto-created childNode in the NodeType configuration.

Method Details

Property Details