interface ContentSubgraphInterface implements JsonSerializable (View source)

This is the most important read model of a content repository.

It is a "view" to the content graph, only showing a single dimension (e.g. "language=de,country=ch") - so this means this is effectively a tree of nodes.

Accessing the Content Subgraph

From the central Content Repository instance, you can fetch the singleton {\Neos\ContentRepository\Core\Projection\ContentGraph\ContentGraphInterface}. There, you can call {\Neos\ContentRepository\Core\Projection\ContentGraph\ContentGraphInterface::getSubgraph()} and pass in the {\Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId}, {\Neos\ContentRepository\Core\DimensionSpace\DimensionSpacePoint} and {\Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints} you want to have.

Why is this called "Subgraph" and not Tree?

This is because a tree can have only a single root node, but the ContentSubgraph supports multiple root nodes. So the totally correct term would be a "Forest", but this is unknown terminology outside academia. This is why we go for "Subgraph" to show that this is a part of the Content Graph.

Methods

findChildNodes(NodeAggregateId $parentNodeAggregateId, FindChildNodesFilter $filter)

No description

References
findReferencedNodes(NodeAggregateId $nodeAggregateId, FindReferencedNodesFilter $filter)

No description

References
findReferencingNodes(NodeAggregateId $nodeAggregateId, FindReferencingNodesFilter $filter)

No description

Node|null
findNodeById(NodeAggregateId $nodeAggregateId)

No description

Node|null
findParentNode(NodeAggregateId $childNodeAggregateId)

No description

Node|null
findNodeByPath(NodePath $path, NodeAggregateId $startingNodeAggregateId)

No description

Node|null
findChildNodeConnectedThroughEdgeName(NodeAggregateId $parentNodeAggregateId, NodeName $edgeName)

No description

findSucceedingSiblings(NodeAggregateId $sibling, FindSucceedingSiblingsFilter $filter)

No description

findPrecedingSiblings(NodeAggregateId $sibling, FindPrecedingSiblingsFilter $filter)

No description

findNodePath(NodeAggregateId $nodeAggregateId)

No description

findSubtrees(NodeAggregateIds $entryNodeAggregateIds, FindSubtreesFilter $filter)

No description

findDescendants(NodeAggregateIds $entryNodeAggregateIds, FindDescendantsFilter $filter)

Recursively find all nodes underneath the $entryNodeAggregateIds, which match the node type constraints specified by NodeTypeConstraints.

int
countNodes()

No description

Details

Nodes findChildNodes(NodeAggregateId $parentNodeAggregateId, FindChildNodesFilter $filter)

No description

Parameters

NodeAggregateId $parentNodeAggregateId
FindChildNodesFilter $filter

Return Value

Nodes

References findReferencedNodes(NodeAggregateId $nodeAggregateId, FindReferencedNodesFilter $filter)

No description

Parameters

NodeAggregateId $nodeAggregateId
FindReferencedNodesFilter $filter

Return Value

References

References findReferencingNodes(NodeAggregateId $nodeAggregateId, FindReferencingNodesFilter $filter)

No description

Parameters

NodeAggregateId $nodeAggregateId
FindReferencingNodesFilter $filter

Return Value

References

Node|null findNodeById(NodeAggregateId $nodeAggregateId)

No description

Parameters

NodeAggregateId $nodeAggregateId

Return Value

Node|null

Node|null findParentNode(NodeAggregateId $childNodeAggregateId)

No description

Parameters

NodeAggregateId $childNodeAggregateId

Return Value

Node|null

Node|null findNodeByPath(NodePath $path, NodeAggregateId $startingNodeAggregateId)

No description

Parameters

NodePath $path
NodeAggregateId $startingNodeAggregateId

Return Value

Node|null

Node|null findChildNodeConnectedThroughEdgeName(NodeAggregateId $parentNodeAggregateId, NodeName $edgeName)

No description

Parameters

NodeAggregateId $parentNodeAggregateId
NodeName $edgeName

Return Value

Node|null

Nodes findSucceedingSiblings(NodeAggregateId $sibling, FindSucceedingSiblingsFilter $filter)

No description

Parameters

NodeAggregateId $sibling
FindSucceedingSiblingsFilter $filter

Return Value

Nodes

Nodes findPrecedingSiblings(NodeAggregateId $sibling, FindPrecedingSiblingsFilter $filter)

No description

Parameters

NodeAggregateId $sibling
FindPrecedingSiblingsFilter $filter

Return Value

Nodes

NodePath findNodePath(NodeAggregateId $nodeAggregateId)

No description

Parameters

NodeAggregateId $nodeAggregateId

Return Value

NodePath

Subtrees findSubtrees(NodeAggregateIds $entryNodeAggregateIds, FindSubtreesFilter $filter)

No description

Parameters

NodeAggregateIds $entryNodeAggregateIds
FindSubtreesFilter $filter

Return Value

Subtrees

Nodes findDescendants(NodeAggregateIds $entryNodeAggregateIds, FindDescendantsFilter $filter)

Recursively find all nodes underneath the $entryNodeAggregateIds, which match the node type constraints specified by NodeTypeConstraints.

If a Search Term is specified, the properties are searched for this search term.

Parameters

NodeAggregateIds $entryNodeAggregateIds
FindDescendantsFilter $filter

Return Value

Nodes

int countNodes()

internal  this method might change without further notice.
 

No description

Return Value

int