Copied!

WorkflowServiceInterface

WorkflowServiceInterface.php : 19
Interface

Methods

publiccan()

WorkflowServiceInterface.php : 28 
public can(WorkflowMetadata $workflow, string $transitionName) : bool

Parameters

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

Return values

bool

publicdeleteContentLocks()

WorkflowServiceInterface.php : 83 
public deleteContentLocks(int $contentId) : void

Parameters

Name Type Default value Description
$contentId int - -

publicdeleteLock()

WorkflowServiceInterface.php : 79 
public deleteLock(VersionLock $versionLock) : void

Parameters

Name Type Default value Description
$versionLock VersionLock - -

publicdeleteUserLocks()

WorkflowServiceInterface.php : 81 
public deleteUserLocks(int $userId) : void

Parameters

Name Type Default value Description
$userId int - -

publicgetVersionLock()

WorkflowServiceInterface.php : 58 
public getVersionLock(VersionInfo $versionInfo) : VersionLock

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -

Return values

VersionLock

Tags
Throws
NotFoundException

publicgetVersionLockByContentId()

WorkflowServiceInterface.php : 63 
public getVersionLockByContentId(int $contentId, int $versionNo) : VersionLock

Parameters

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

Return values

VersionLock

Tags
Throws
NotFoundException

publicisVersionLocked()

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

Parameters

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

Return values

bool

publicloadOngoingWorkflowMetadata()

WorkflowServiceInterface.php : 35 
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>

publicloadOngoingWorkflowMetadataOriginatedByUser()

WorkflowServiceInterface.php : 43 
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>

publicloadWorkflowMetadataByStage()

WorkflowServiceInterface.php : 53 
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>

publicloadWorkflowMetadataForContent()

WorkflowServiceInterface.php : 24 
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
Throws
NotFoundException

publicloadWorkflowMetadataList()

WorkflowServiceInterface.php : 30 
public loadWorkflowMetadataList(WorkflowMetadataQuery $query) : WorkflowMetadataList

Parameters

Name Type Default value Description
$query WorkflowMetadataQuery - -

Return values

WorkflowMetadataList

publiclockVersion()

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

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
$userId int|null null -
Tags
Throws
BadStateException

publicstart()

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

Parameters

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

Return values

WorkflowMetadata

publicunlockVersion()

WorkflowServiceInterface.php : 77 
public unlockVersion(VersionInfo $versionInfo) : void

Parameters

Name Type Default value Description
$versionInfo VersionInfo - -
Tags
Throws
UnauthorizedException
Throws
BadStateException
Throws
InvalidArgumentException