WorkflowServiceInterface

WorkflowServiceInterface.php : 23 Copy path

Interface

Methods¶

can() ¶

WorkflowServiceInterface.php : 60 Copy path

public can(WorkflowMetadata $workflow, string $transitionName) : bool

Parameters

Name	Type	Default value	Description
$workflow	WorkflowMetadata	-	-
$transitionName	string	-	-

Return values

bool

deleteContentLocks() ¶

WorkflowServiceInterface.php : 163 Copy path

public deleteContentLocks(int $contentId) : void

Parameters

Name	Type	Default value	Description
$contentId	int	-	-

deleteLock() ¶

WorkflowServiceInterface.php : 159 Copy path

public deleteLock(VersionLock $versionLock) : void

Parameters

Name	Type	Default value	Description
$versionLock	VersionLock	-	-

deleteUserLocks() ¶

WorkflowServiceInterface.php : 161 Copy path

public deleteUserLocks(int $userId) : void

Parameters

Name	Type	Default value	Description
$userId	int	-	-

getVersionLock() ¶

WorkflowServiceInterface.php : 129 Copy path

public getVersionLock(VersionInfo $versionInfo) : VersionLock

Parameters

Name	Type	Default value	Description
$versionInfo	VersionInfo	-	-

Return values

VersionLock

Tags

getVersionLockByContentId() ¶

WorkflowServiceInterface.php : 134 Copy path

    
                        public getVersionLockByContentId(int $contentId, int $versionNo) : VersionLock

Parameters

Name	Type	Default value	Description
$contentId	int	-	-
$versionNo	int	-	-

Return values

VersionLock

Tags

isVersionLocked() ¶

WorkflowServiceInterface.php : 139 Copy path

public isVersionLocked(VersionInfo $versionInfo[, int|null $userId = null ]) : bool

Parameters

Name	Type	Default value	Description
$versionInfo	VersionInfo	-	-
$userId	int\|null	null	-

Return values

bool

loadAllWorkflowMetadata() ¶

WorkflowServiceInterface.php : 93 Copy path

Loads all workflow metadata stored in the database.

public loadAllWorkflowMetadata() : array<string|int, WorkflowMetadata>

Loading all workflow metadata is highly discouraged, it leads to performance issues. Please use only if you understand the consequences.

Return values

array<string|int, WorkflowMetadata>

Tags

loadOngoingWorkflowMetadata() ¶

WorkflowServiceInterface.php : 100 Copy path

    
                        public loadOngoingWorkflowMetadata([int $limit = 10 ][, int $offset = 0 ]) : array<string|int, WorkflowMetadata>

Parameters

Name	Type	Default value	Description
$limit	int	10	-
$offset	int	0	-

Return values

array<string|int, WorkflowMetadata>

loadOngoingWorkflowMetadataOriginatedByUser() ¶

WorkflowServiceInterface.php : 108 Copy path

public loadOngoingWorkflowMetadataOriginatedByUser(UserReference $user[, string|null $name = null ][, int $limit = 10 ][, int $offset = 0 ]) : array<string|int, WorkflowMetadata>

Parameters

Name	Type	Default value	Description
$user	UserReference	-	-
$name	string\|null	null	-
$limit	int	10	-
$offset	int	0	-

Return values

array<string|int, WorkflowMetadata>

loadWorkflowMetadataByStage() ¶

WorkflowServiceInterface.php : 121 Copy path

    
                        public loadWorkflowMetadataByStage(string $workflowName, string $stageName) : array<string|int, WorkflowMetadata>

Parameters

Name	Type	Default value	Description
$workflowName	string	-	-
$stageName	string	-	-

Return values

array<string|int, WorkflowMetadata>

loadWorkflowMetadataForContent() ¶

WorkflowServiceInterface.php : 33 Copy path

public loadWorkflowMetadataForContent(Content $content[, string|null $name = null ]) : WorkflowMetadata

Parameters

Name	Type	Default value	Description
$content	Content	-	-
$name	string\|null	null	-

Return values

WorkflowMetadata

Tags

loadWorkflowMetadataForVersionInfo() ¶

WorkflowServiceInterface.php : 41 Copy path

public loadWorkflowMetadataForVersionInfo(VersionInfo $versionInfo[, string|null $name = null ]) : WorkflowMetadata

Parameters

Name	Type	Default value	Description
$versionInfo	VersionInfo	-	-
$name	string\|null	null	-

Return values

WorkflowMetadata

Tags

loadWorkflowMetadataList() ¶

WorkflowServiceInterface.php : 95 Copy path

    
                        public loadWorkflowMetadataList(WorkflowMetadataQuery $query) : WorkflowMetadataList

Parameters

Name	Type	Default value	Description
$query	WorkflowMetadataQuery	-	-

Return values

WorkflowMetadataList

loadWorkflowMetadataOriginatedByUser() ¶

WorkflowServiceInterface.php : 78 Copy path

Loads all workflow metadata started by $user.

public loadWorkflowMetadataOriginatedByUser(UserReference $user[, string|null $name = null ]) : array<string|int, WorkflowMetadata>

Loading all workflow metadata is highly discouraged, it leads to performance issues. Please use only if you understand the consequences.

Parameters

Name	Type	Default value	Description
$user	UserReference	-	-
$name	string\|null	null	-

Return values

array<string|int, WorkflowMetadata>

Tags

lockVersion() ¶

WorkflowServiceInterface.php : 147 Copy path

public lockVersion(VersionInfo $versionInfo[, int|null $userId = null ]) : void

Parameters

Name	Type	Default value	Description
$versionInfo	VersionInfo	-	-
$userId	int\|null	null	-

Tags

start() ¶

WorkflowServiceInterface.php : 49 Copy path

public start(Content $content[, string|null $name = null ]) : WorkflowMetadata

Parameters

Name	Type	Default value	Description
$content	Content	-	-
$name	string\|null	null	-

Return values

WorkflowMetadata

Tags

unlockVersion() ¶

WorkflowServiceInterface.php : 157 Copy path

public unlockVersion(VersionInfo $versionInfo) : void

Parameters

Name	Type	Default value	Description
$versionInfo	VersionInfo	-	-