• Accueil
• Neos
• ContentRepository
• Domain
• Model
• NodeData

PHP Class Neos\ContentRepository\Domain\Model\NodeData

NOTE: This is internal only and should not be used or extended by userland code. Afficher le fichier Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Свойство	Type	Description
$contentObjectProxy	ContentObjectProxy	Optional proxy for a content object which acts as an alternative property container
$depth	integer	Level number within the global node tree
$dimensionValues	array
$dimensions	Doctrine\Common\Collections\Collection<\Neos\ContentRepository\Domain\Model\NodeDimension>
$dimensionsHash	string	MD5 hash of the content dimensions The hash is generated in buildDimensionValues().
$hiddenAfterDateTime	DateTime
$hiddenBeforeDateTime	DateTime
$identifier	string	Identifier of this node which is unique within its workspace
$index	integer	Index within the nodes with the same parent
$lastModificationDateTime	DateTime
$lastPublicationDateTime	DateTime
$movedTo	NodeData	If a node data is moved a "shadow" node data is inserted that references the new node data
$name	string	Node name, derived from its node path
$nodeService	Neos\ContentRepository\Domain\Service\NodeServiceInterface
$parentPath	string	Absolute path of the parent path
$parentPathHash	string	The hash is generated in calculateParentPathHash().
$path	string	Absolute path of this node
$pathHash	string	The hash is generated in calculatePathHash().
$removed	boolean	If this is a removed node. This flag can and is only used in workspaces which do have a base workspace. In a bottom level workspace nodes are really removed, in other workspaces, removal is realized by this flag.
$securityContext	Neos\Flow\Security\Context
$version	integer	Auto-incrementing version of this node data, used for optimistic locking
$workspace	Workspace	Workspace this node is contained in

Méthodes publiques

Méthode	Description
__clone ( ) : void	Create a fresh collection instance and clone dimensions
__construct ( string $path, Workspace $workspace, string $identifier = null, array $dimensions = null )	Constructs this node data container
createNodeData ( string $name, NodeType $nodeType = null, string $identifier = null, Workspace $workspace = null, array $dimensions = null ) : NodeData	Creates, adds and returns a child node of this node. Also sets default properties and creates default subnodes.
createNodeDataFromTemplate ( NodeTemplate $nodeTemplate, string $nodeName = null, Workspace $workspace = null, array $dimensions = null ) : NodeData	Creates and persists a node from the given $nodeTemplate as child node
createShadow ( string $path ) : NodeData	Create a shadow NodeData at the given path with the same workspace and dimensions as this
createSingleNodeData ( string $name, NodeType $nodeType = null, string $identifier = null, Workspace $workspace = null, array $dimensions = null ) : NodeData	Creates, adds and returns a child node of this node, without setting default properties or creating subnodes.
getContextPath ( ) : string	Returns the absolute path of this node with additional context information (such as the workspace name).
getDepth ( ) : integer	Returns the level at which this node is located.
getDimensionValues ( ) : array	Returns the dimensions and their values.
getDimensions ( ) : array	Internal use, do not retrieve collection directly
getDimensionsHash ( ) : string	Get a unique string for all dimension values
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.
getMovedTo ( ) : NodeData
getName ( ) : string	Returns the name of this node
getNumberOfChildNodes ( string $nodeTypeFilter = null, Workspace $workspace, array $dimensions ) : integer	Returns the number of child nodes a similar getChildNodes() call would return.
getParent ( ) : NodeData	Returns the parent node of this node
getParentPath ( ) : string	Returns the parent node path
getPath ( ) : string	Returns the path 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.
isAccessible ( ) : boolean	Tells if this node may be accessed according to the current security context.
isInternal ( ) : boolean	Check if this NodeData object is a purely internal technical object (like a shadow node).
isRemoved ( ) : boolean	If this node is a removed node.
isVisible ( ) : boolean	Tells if this node is "visible".
matchesWorkspaceAndDimensions ( Workspace $workspace, array $dimensions = null ) : boolean	Checks if this instance matches the given workspace and dimensions.
move ( string $path, Workspace $workspace ) : NodeData	Move this NodeData to the given path and workspace.
remove ( ) : void	Removes this node and all its child nodes. This is an alias for setRemoved(TRUE)
setDimensions ( array $dimensionsToBeSet ) : void	Internal use, do not manipulate collection directly
setIdentifier ( string $identifier ) : void	Change the identifier of this node data
setIndex ( integer $index ) : void	Sets the index of this node
setMovedTo ( NodeData $nodeData = null ) : void
setPath ( string $path, boolean $recursive = true ) : void	Sets the absolute path of this node
setRemoved ( boolean $removed ) : void	Enables using the remove method when only setters are available
setWorkspace ( Workspace $workspace = null ) : void	Sets the workspace of this node.
similarize ( AbstractNodeData $sourceNode, boolean $isCopy = false ) : void	Make the node "similar" to the given source node. That means, - all properties - index - node type - content object will be set to the same values as in the source node.

Méthodes protégées

Méthode	Description
addOrUpdate ( NodeData $nodeData = null )	Adds this node to the Node Repository or updates it if it has been added earlier
buildDimensionValues ( ) : void	Build a cached array of dimension values and a hash to search for it.
calculateParentPathHash ( ) : void	Calculates the hash corresponding to the dimensions and their values for this instance.
calculatePathHash ( ) : void	Calculates the hash corresponding to the path of this instance.
emitNodePathChanged ( NodeData $nodeData ) : void	Signals that a node has changed its path.
findExistingDimensionMatching ( NodeDimension $dimensionToBeSet ) : NodeDimension | null	Internal method used in setDimensions to reuse dimension objects with the same name/value pair.
getChildNodeData ( ) : array<\Neos\ContentRepository\Domain\Model\NodeData>	Returns all direct child node data of this node data without reducing the result (multiple variants can be returned)
getExistingShadowNodeData ( string $path, Workspace $workspace, array $dimensionValues ) : NodeData | null	Find an existing shadow node data on the given path for the current node data of the node (used by setPath)
materializeToWorkspace ( Workspace $workspace ) : NodeData	Materializes the original node data (of a different workspace) into the current workspace, excluding content dimensions
setAsShadowOf ( NodeData $nodeData = null ) : void	This becomes a shdow of the given NodeData object.
updateContentObject ( object $contentObject ) : void	Updates the attached content object

Method Details

Property Details