final class DocumentUriPathFinder implements ProjectionStateInterface (View source)

internal  implementation detail to manage document node uris. For resolving please use the NodeUriBuilder and for matching the Router.
 

Methods

__construct(Connection $dbal, string $tableNamePrefix)

No description

getEnabledBySiteNodeNameUriPathAndDimensionSpacePointHash(SiteNodeName $siteNodeName, string $uriPath, string $dimensionSpacePointHash)

Returns the DocumentNodeInfo of a node for the given $siteNodeName and $uriPath

getByIdAndDimensionSpacePointHash(NodeAggregateId $nodeAggregateId, string $dimensionSpacePointHash)

Returns the DocumentNodeInfo of a node for the given $nodeAggregateId Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

getParentNode(DocumentNodeInfo $nodeInfo)

Returns the parent DocumentNodeInfo of a node for the given $nodeInfo Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

getPrecedingNode(NodeAggregateId $succeedingNodeAggregateId, NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash)

Returns the preceding DocumentNodeInfo for $succeedingNodeAggregateId and the $parentNodeAggregateId (= node on the same hierarchy level) Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

getFirstEnabledChildNode(NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash)

Returns the DocumentNodeInfo for the first enabled child node for the specified $parentNodeAggregateId Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

getLastChildNode(NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash)

No description

getLastChildNodeNotBeing(NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash, NodeAggregateId $excludedNodeAggregateId)

No description

getDescendantsOfNode(DocumentNodeInfo $node)

Returns the DocumentNodeInfos of all descendants of a given node.

Details

__construct(Connection $dbal, string $tableNamePrefix)

No description

Parameters

Connection $dbal
string $tableNamePrefix

DocumentNodeInfo getEnabledBySiteNodeNameUriPathAndDimensionSpacePointHash(SiteNodeName $siteNodeName, string $uriPath, string $dimensionSpacePointHash)

Returns the DocumentNodeInfo of a node for the given $siteNodeName and $uriPath

Parameters

SiteNodeName $siteNodeName
string $uriPath
string $dimensionSpacePointHash

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfo getByIdAndDimensionSpacePointHash(NodeAggregateId $nodeAggregateId, string $dimensionSpacePointHash)

Returns the DocumentNodeInfo of a node for the given $nodeAggregateId Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

Parameters

NodeAggregateId $nodeAggregateId
string $dimensionSpacePointHash

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfo getParentNode(DocumentNodeInfo $nodeInfo)

Returns the parent DocumentNodeInfo of a node for the given $nodeInfo Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

Parameters

DocumentNodeInfo $nodeInfo

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfo getPrecedingNode(NodeAggregateId $succeedingNodeAggregateId, NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash)

internal  only for use within the document uri path projection
 

Returns the preceding DocumentNodeInfo for $succeedingNodeAggregateId and the $parentNodeAggregateId (= node on the same hierarchy level) Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

Parameters

NodeAggregateId $succeedingNodeAggregateId
NodeAggregateId $parentNodeAggregateId
string $dimensionSpacePointHash

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfo getFirstEnabledChildNode(NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash)

Returns the DocumentNodeInfo for the first enabled child node for the specified $parentNodeAggregateId Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

Parameters

NodeAggregateId $parentNodeAggregateId
string $dimensionSpacePointHash

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfo getLastChildNode(NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash)

internal  only for use within the document uri path projection
 

No description

Parameters

NodeAggregateId $parentNodeAggregateId
string $dimensionSpacePointHash

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfo getLastChildNodeNotBeing(NodeAggregateId $parentNodeAggregateId, string $dimensionSpacePointHash, NodeAggregateId $excludedNodeAggregateId)

internal  only for use within the document uri path projection
 

No description

Parameters

NodeAggregateId $parentNodeAggregateId
string $dimensionSpacePointHash
NodeAggregateId $excludedNodeAggregateId

Return Value

DocumentNodeInfo

Exceptions

NodeNotFoundException

DocumentNodeInfos getDescendantsOfNode(DocumentNodeInfo $node)

Returns the DocumentNodeInfos of all descendants of a given node.

Note: This will not exclude disabled nodes in order to allow the calling side to make a distinction (e.g. in order to display a custom error)

Parameters

DocumentNodeInfo $node

Return Value

DocumentNodeInfos