interface ContentGraphInterface implements ProjectionStateInterface (View source)

This is the MAIN ENTRY POINT for the Content Repository. This class exists only once per Content Repository.

The most important API method is {\Neos\ContentRepository\Core\Projection\ContentGraph\ContentGraphInterface::getSubgraph()}, where you can access the most important read model, the {\Neos\ContentRepository\Core\Projection\ContentGraph\ContentSubgraphInterface}.

Methods

getWorkspaceName()

The workspace this content graph is operating on

getSubgraph(DimensionSpacePoint $dimensionSpacePoint, VisibilityConstraints $visibilityConstraints)

No description

findRootNodeAggregateByType(NodeTypeName $nodeTypeName)

No description

findNodeAggregatesByType(NodeTypeName $nodeTypeName)

No description

findNodeAggregateById(NodeAggregateId $nodeAggregateId)

No description

findNodeAggregatesByIds(NodeAggregateIds $nodeAggregateIds)

No description

findUsedNodeTypeNames()

Returns all node types in use, from the graph projection

findParentNodeAggregateByChildOriginDimensionSpacePoint(NodeAggregateId $childNodeAggregateId, OriginDimensionSpacePoint $childOriginDimensionSpacePoint)

No description

findParentNodeAggregates(NodeAggregateId $childNodeAggregateId)

No description

findAncestorNodeAggregateIds(NodeAggregateId $entryNodeAggregateId)

No description

findChildNodeAggregates(NodeAggregateId $parentNodeAggregateId)

No description

findChildNodeAggregateByName(NodeAggregateId $parentNodeAggregateId, NodeName $name)

A node aggregate can have no or exactly one child node aggregate with a given name as enforced by constraint checks

findTetheredChildNodeAggregates(NodeAggregateId $parentNodeAggregateId)

No description

getDimensionSpacePointsOccupiedByChildNodeName(NodeName $nodeName, NodeAggregateId $parentNodeAggregateId, OriginDimensionSpacePoint $parentNodeOriginDimensionSpacePoint, DimensionSpacePointSet $dimensionSpacePointsToCheck)

No description

Details

ContentRepositoryId getContentRepositoryId()

No description

Return Value

ContentRepositoryId

WorkspaceName getWorkspaceName()

The workspace this content graph is operating on

Return Value

WorkspaceName

ContentSubgraphInterface getSubgraph(DimensionSpacePoint $dimensionSpacePoint, VisibilityConstraints $visibilityConstraints)

No description

Parameters

DimensionSpacePoint $dimensionSpacePoint
VisibilityConstraints $visibilityConstraints

Return Value

ContentSubgraphInterface

NodeAggregate|null findRootNodeAggregateByType(NodeTypeName $nodeTypeName)

No description

Parameters

NodeTypeName $nodeTypeName

Return Value

NodeAggregate|null

NodeAggregates findRootNodeAggregates(FindRootNodeAggregatesFilter $filter)

No description

Parameters

FindRootNodeAggregatesFilter $filter

Return Value

NodeAggregates

NodeAggregates findNodeAggregatesByType(NodeTypeName $nodeTypeName)

No description

Parameters

NodeTypeName $nodeTypeName

Return Value

NodeAggregates

NodeAggregate|null findNodeAggregateById(NodeAggregateId $nodeAggregateId)

No description

Parameters

NodeAggregateId $nodeAggregateId

Return Value

NodeAggregate|null

NodeAggregates findNodeAggregatesByIds(NodeAggregateIds $nodeAggregateIds)

No description

Parameters

NodeAggregateIds $nodeAggregateIds

Return Value

NodeAggregates

the node aggregates that exist in this graph. The order is not defined.

NodeTypeNames findUsedNodeTypeNames()

Returns all node types in use, from the graph projection

Return Value

NodeTypeNames

NodeAggregate|null findParentNodeAggregateByChildOriginDimensionSpacePoint(NodeAggregateId $childNodeAggregateId, OriginDimensionSpacePoint $childOriginDimensionSpacePoint)

internal  only for consumption inside the Command Handler
 

No description

Parameters

NodeAggregateId $childNodeAggregateId
OriginDimensionSpacePoint $childOriginDimensionSpacePoint

Return Value

NodeAggregate|null

NodeAggregates findParentNodeAggregates(NodeAggregateId $childNodeAggregateId)

internal  only for consumption inside the Command Handler
 

No description

Parameters

NodeAggregateId $childNodeAggregateId

Return Value

NodeAggregates

NodeAggregateIds findAncestorNodeAggregateIds(NodeAggregateId $entryNodeAggregateId)

internal  the returned order of node aggregate ids is undefined and not to be relied upon
 

No description

Parameters

NodeAggregateId $entryNodeAggregateId

Return Value

NodeAggregateIds

NodeAggregates findChildNodeAggregates(NodeAggregateId $parentNodeAggregateId)

internal  only for consumption inside the Command Handler
 

No description

Parameters

NodeAggregateId $parentNodeAggregateId

Return Value

NodeAggregates

NodeAggregate|null findChildNodeAggregateByName(NodeAggregateId $parentNodeAggregateId, NodeName $name)

internal  only for consumption inside the Command Handler
 

A node aggregate can have no or exactly one child node aggregate with a given name as enforced by constraint checks

Parameters

NodeAggregateId $parentNodeAggregateId
NodeName $name

Return Value

NodeAggregate|null

NodeAggregates findTetheredChildNodeAggregates(NodeAggregateId $parentNodeAggregateId)

internal  only for consumption inside the Command Handler
 

No description

Parameters

NodeAggregateId $parentNodeAggregateId

Return Value

NodeAggregates

DimensionSpacePointSet getDimensionSpacePointsOccupiedByChildNodeName(NodeName $nodeName, NodeAggregateId $parentNodeAggregateId, OriginDimensionSpacePoint $parentNodeOriginDimensionSpacePoint, DimensionSpacePointSet $dimensionSpacePointsToCheck)

internal  only for consumption inside the Command Handler
 

No description

Parameters

NodeName $nodeName
NodeAggregateId $parentNodeAggregateId
OriginDimensionSpacePoint $parentNodeOriginDimensionSpacePoint
DimensionSpacePointSet $dimensionSpacePointsToCheck

Return Value

DimensionSpacePointSet

NodeAggregates findNodeAggregatesTaggedBy(SubtreeTag $subtreeTag)

internal  experimental api, the order of the returned node aggregates is undefined and does not follow the hierarchy
 

No description

Parameters

SubtreeTag $subtreeTag

Return Value

NodeAggregates

ContentStreamId getContentStreamId()

internal  The content stream id where the workspace name points to for this instance
 

No description

Return Value

ContentStreamId