PHP Class Neos\Neos\Command\WorkspaceCommandController

Inheritance: extends Neos\Flow\Cli\CommandController
Show file Open project: neos/neos-development-collection

Protected Properties

Property Type Description
$publishingService Neos\Neos\Service\PublishingService
$userService Neos\Neos\Domain\Service\UserService
$workspaceRepository Neos\ContentRepository\Domain\Repository\WorkspaceRepository

Public Methods

Method Description
createCommand ( string $workspace, string $baseWorkspace = 'live', string $title = null, string $description = null, string $owner = '' ) : void Create a new workspace
deleteCommand ( string $workspace, boolean $force = false ) : void Deletes a workspace
discardAllCommand ( string $workspaceName, boolean $verbose = false ) : void Discard changes in workspace
discardCommand ( string $workspace, boolean $verbose = false, boolean $dryRun = false ) : void Discard changes in workspace
listCommand ( ) : void Display a list of existing workspaces
publishAllCommand ( string $workspaceName, boolean $verbose = false ) : void Publish changes of a workspace
publishCommand ( string $workspace, string $targetWorkspace = null, boolean $verbose = false, boolean $dryRun = false ) : void Publish changes of a workspace
rebaseCommand ( string $workspace, string $baseWorkspace ) : void Rebase a workspace

Method Details

createCommand() public method

This command creates a new workspace.
public createCommand ( string $workspace, string $baseWorkspace = 'live', string $title = null, string $description = null, string $owner = '' ) : void
$workspace string Name of the workspace, for example "christmas-campaign"
$baseWorkspace string Name of the base workspace. If none is specified, "live" is assumed.
$title string Human friendly title of the workspace, for example "Christmas Campaign"
$description string A description explaining the purpose of the new workspace
$owner string The identifier of a User to own the workspace
return void

deleteCommand() public method

This command deletes a workspace. If you only want to empty a workspace and not delete the workspace itself, use workspace:discard instead.
public deleteCommand ( string $workspace, boolean $force = false ) : void
$workspace string Name of the workspace, for example "christmas-campaign"
$force boolean Delete the workspace and all of its contents
return void

discardAllCommand() public method

This command discards all modified, created or deleted nodes in the specified workspace.
Deprecation: since 1.2
public discardAllCommand ( string $workspaceName, boolean $verbose = false ) : void
$workspaceName string Name of the workspace, for example "user-john"
$verbose boolean If enabled, information about individual nodes will be displayed
return void

discardCommand() public method

This command discards all modified, created or deleted nodes in the specified workspace.
public discardCommand ( string $workspace, boolean $verbose = false, boolean $dryRun = false ) : void
$workspace string Name of the workspace, for example "user-john"
$verbose boolean If enabled, information about individual nodes will be displayed
$dryRun boolean If set, only displays which nodes would be discarded, no real changes are committed
return void

listCommand() public method

Display a list of existing workspaces
public listCommand ( ) : void
return void

publishAllCommand() public method

This command publishes all modified, created or deleted nodes in the specified workspace to the live workspace.
Deprecation: since 1.2
public publishAllCommand ( string $workspaceName, boolean $verbose = false ) : void
$workspaceName string Name of the workspace, for example "user-john"
$verbose boolean If enabled, information about individual nodes will be displayed
return void

publishCommand() public method

This command publishes all modified, created or deleted nodes in the specified workspace to its base workspace. If a target workspace is specified, the content is published to that workspace instead.
public publishCommand ( string $workspace, string $targetWorkspace = null, boolean $verbose = false, boolean $dryRun = false ) : void
$workspace string Name of the workspace containing the changes to publish, for example "user-john"
$targetWorkspace string If specified, the content will be published to this workspace instead of the base workspace
$verbose boolean If enabled, some information about individual nodes will be displayed
$dryRun boolean If set, only displays which nodes would be published, no real changes are committed
return void

rebaseCommand() public method

This command sets a new base workspace for the specified workspace. Note that doing so will put the possible changes contained in the workspace to be rebased into a different context and thus might lead to unintended results when being published.
public rebaseCommand ( string $workspace, string $baseWorkspace ) : void
$workspace string Name of the workspace to rebase, for example "user-john"
$baseWorkspace string Name of the new base workspace
return void

Property Details

$publishingService protected property

protected PublishingService,Neos\Neos\Service $publishingService
return Neos\Neos\Service\PublishingService

$userService protected property

protected UserService,Neos\Neos\Domain\Service $userService
return Neos\Neos\Domain\Service\UserService

$workspaceRepository protected property

protected WorkspaceRepository,Neos\ContentRepository\Domain\Repository $workspaceRepository
return Neos\ContentRepository\Domain\Repository\WorkspaceRepository