PHP API

Using the Event Sourced Content Repository with PHP

Neos 9

This page is for Neos 9.0 with the new Event Sourced Content Repository.

The PHP API of the Content Repository is separated into a reading and a writing part. This implements  the CQRS pattern (Command Query Request Separation) and thus allows for a separate optimization of both sides of the API.

Content Repository Registry

In order to work with the Content Repository one first has to get hold of it. The Content Repository Registry is the central entrypoint for exactly that in Neos. It can be injected via Flow Annotation or fetched from the Object Manager.

php
use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry;
use Neos\ContentRepository\Core\ContentRepository;
use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;

class Example {

    #[Flow\Inject]
    protected ContentRepositoryRegistry $contentRepositoryRegistry;

After the Content Repository Registry is obtained it can be used to get the actual Content Repository via the Content Repository Id. In Neos the Content Repository Id defaultusually addresses the main Content Repository but this depends on the concrete project setup and may diverge.

php
$contentRepository = $contentRepositoryRegistry->get($node->contentRepositoryId);

Content Subgraph - Reading from the Content Repository

Reading from the Content Repository is done via the Subgraph API that provides a view to the Content Repository for a specific Dimension Space Point and a workspace, identified by its Workspace Name. It can be obtained from the Content Repository.

php
$contentSubGraph = $contentRepository->getContentSubgraph(
    WorkspaceName::forLive(),
    DimensionSpacePoint::createWithoutDimensions()
);

The Subgraph can also be obtained directly from the Content Repository Registry if you already have a Node.

php
$contentSubGraph = $this->contentRepositoryRegistry->subgraphForNode($node);

The Content Subgraph provides methods to query Nodes and the References between nodes.

php
$sitesRootNodeNode = $contentSubgraph->findRootNodeByType(NodeTypeName::fromString('Neos.Neos:Sites'));

$homePage = $contentSubgraph->findNodeByPath(
    NodeName::fromString('mySite'),
    $sitesRootNodeNode->aggregateId
);

$children = $contentSubgraph->findChildNodes(
    $homePage->aggregateId,
	FindChildNodesFilter::create();	
);

For Details see the Content Repository Subgraph Overview or the Content Subgraph Interface

Commands - writing to the Content Repository

To modify the Content Repository, Commands objects are created which are then passed to the content Repository for handling.

php
$setNodePropertiesCommand = SetNodeProperties::create(
    $node->workspaceName,
    $node->aggregateId,
    $node->originDimensionSpacePoint,
    PropertyValuesToWrite::fromArray($properties)
); 

$contentRepository->handle($setNodePropertiesCommand);

All the commands available are listed in the Command References or grouped by feature in the Neos Codebase ContentRepository Features

Security