PHP Interface Neos\ContentRepository\Domain\Service\PublishingServiceInterface

Show file Open project: neos/neos-development-collection Interface Usage Examples

Public Methods

Method Description
discardAllNodes ( Workspace $workspace ) : void Discards all unpublished nodes of the given workspace.
discardNode ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : void Discards the given node.
discardNodes ( array $nodes ) : void Discards the given nodes.
getUnpublishedNodes ( Workspace $workspace ) : array<\Neos\ContentRepository\Domain\Model\NodeInterface> Returns a list of nodes contained in the given workspace which are not yet published
getUnpublishedNodesCount ( Workspace $workspace ) : integer Returns the number of unpublished nodes contained in the given workspace
publishNode ( Neos\ContentRepository\Domain\Model\NodeInterface $node, Workspace $targetWorkspace = null ) : void Publishes the given node to the specified target workspace. If no workspace is specified, "live" is assumed.
publishNodes ( array $nodes, Workspace $targetWorkspace = null ) : void Publishes the given nodes to the specified target workspace. If no workspace is specified, "live" is assumed.

Method Details

discardAllNodes() public method

Discards all unpublished nodes of the given workspace.
public discardAllNodes ( Workspace $workspace ) : void
$workspace Neos\ContentRepository\Domain\Model\Workspace The workspace to flush, can't be the live workspace
return void

discardNode() public method

Discards the given node.
public discardNode ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : void
$node Neos\ContentRepository\Domain\Model\NodeInterface
return void

discardNodes() public method

Discards the given nodes.
public discardNodes ( array $nodes ) : void
$nodes array
return void

getUnpublishedNodes() public method

Returns a list of nodes contained in the given workspace which are not yet published
public getUnpublishedNodes ( Workspace $workspace ) : array<\Neos\ContentRepository\Domain\Model\NodeInterface>
$workspace Neos\ContentRepository\Domain\Model\Workspace
return array<\Neos\ContentRepository\Domain\Model\NodeInterface>

getUnpublishedNodesCount() public method

Returns the number of unpublished nodes contained in the given workspace
public getUnpublishedNodesCount ( Workspace $workspace ) : integer
$workspace Neos\ContentRepository\Domain\Model\Workspace
return integer

publishNode() public method

Publishes the given node to the specified target workspace. If no workspace is specified, "live" is assumed.
public publishNode ( Neos\ContentRepository\Domain\Model\NodeInterface $node, Workspace $targetWorkspace = null ) : void
$node Neos\ContentRepository\Domain\Model\NodeInterface
$targetWorkspace Neos\ContentRepository\Domain\Model\Workspace If not set the "live" workspace is assumed to be the publishing target
return void

publishNodes() public method

Publishes the given nodes to the specified target workspace. If no workspace is specified, "live" is assumed.
public publishNodes ( array $nodes, Workspace $targetWorkspace = null ) : void
$nodes array
$targetWorkspace Neos\ContentRepository\Domain\Model\Workspace If not set the "live" workspace is assumed to be the publishing target
return void