class WorkspaceController extends AbstractServiceController (View source)

Service Controller for managing Workspaces

Traits

A trait to add backend translation based on the backend users settings

Properties

protected Service $_localizationService from  BackendUserTranslationTrait
protected UserService $_userService from  BackendUserTranslationTrait
protected array $supportedMediaTypes from  AbstractServiceController
protected ThrowableStorageInterface $throwableStorage from  AbstractServiceController
protected string $defaultViewObjectName
protected NodeView $view
protected NodeDataRepository $nodeDataRepository
protected PublishingService $publishingService
protected WorkspaceRepository $workspaceRepository
protected PropertyMapper $propertyMapper

Methods

void
initializeObject()

Set the locale according to the user settings

void
errorAction()

A preliminary error action for handling validation errors

void
processRequest(ActionRequest $request, ActionResponse $response)

Catch exceptions while processing an exception and respond to JSON format TODO: This is an explicit exception handling that will be replaced by format-enabled exception handlers.

array
convertException(Exception $exception)

No description

void
initializeAction()

No description

void
publishNodeAction(NodeInterface $node, string $targetWorkspaceName = null)

Publishes the given node to the specified targetWorkspace

void
publishNodesAction(array $nodes, string $targetWorkspaceName = null)

Publishes the given nodes to the specified targetWorkspace

void
discardNodeAction(NodeInterface $node)

Discards the given node

void
discardNodesAction(array $nodes)

Discards the given nodes

void
publishAllAction(string $sourceWorkspaceName, string $targetWorkspaceName)

Publish everything in the workspace with the given workspace name

void
getWorkspaceWideUnpublishedNodesAction(Workspace $workspace)

Get every unpublished node in the workspace with the given workspace name

void
discardAllAction(Workspace $workspace)

Discard everything in the workspace with the given workspace name

Details

protected void initializeObject()

Set the locale according to the user settings

Return Value

void

void errorAction()

A preliminary error action for handling validation errors

Return Value

void

Exceptions

StopActionException

void processRequest(ActionRequest $request, ActionResponse $response)

Catch exceptions while processing an exception and respond to JSON format TODO: This is an explicit exception handling that will be replaced by format-enabled exception handlers.

Parameters

ActionRequest $request

The request object

ActionResponse $response

The response, modified by this handler

Return Value

void

Exceptions

StopActionException
Exception

protected array convertException(Exception $exception)

No description

Parameters

Exception $exception

Return Value

array

protected void initializeAction()

No description

Return Value

void

void publishNodeAction(NodeInterface $node, string $targetWorkspaceName = null)

Publishes the given node to the specified targetWorkspace

Parameters

NodeInterface $node
string $targetWorkspaceName

Return Value

void

void publishNodesAction(array $nodes, string $targetWorkspaceName = null)

Publishes the given nodes to the specified targetWorkspace

Parameters

array $nodes
string $targetWorkspaceName

Return Value

void

void discardNodeAction(NodeInterface $node)

Discards the given node

Parameters

NodeInterface $node

Return Value

void

void discardNodesAction(array $nodes)

Discards the given nodes

Parameters

array $nodes

Return Value

void

void publishAllAction(string $sourceWorkspaceName, string $targetWorkspaceName)

Publish everything in the workspace with the given workspace name

Parameters

string $sourceWorkspaceName

Name of the source workspace containing the content to publish

string $targetWorkspaceName

Name of the target workspace the content should be published to

Return Value

void

void getWorkspaceWideUnpublishedNodesAction(Workspace $workspace)

Get every unpublished node in the workspace with the given workspace name

Parameters

Workspace $workspace

Return Value

void

void discardAllAction(Workspace $workspace)

Discard everything in the workspace with the given workspace name

Parameters

Workspace $workspace

Return Value

void