HandlerInterface

HandlerInterface.php : 19 Copy path

Interface

Methods¶

cleanupWorkflowMetadataForContent() ¶

HandlerInterface.php : 101 Copy path

public cleanupWorkflowMetadataForContent(int $contentId) : void

Parameters

Name	Type	Default value	Description
$contentId	int	-	-

countContentWithOrphanedWorkflowMetadata() ¶

HandlerInterface.php : 108 Copy path

public countContentWithOrphanedWorkflowMetadata() : int

Return values

int

countWorkflowMetadata() ¶

HandlerInterface.php : 110 Copy path

public countWorkflowMetadata(Criterion $filter) : int

Parameters

Name	Type	Default value	Description
$filter	Criterion	-	-

Return values

int

create() ¶

HandlerInterface.php : 21 Copy path

public create(WorkflowMetadataCreateStruct $createStruct) : WorkflowMetadata

Parameters

Name	Type	Default value	Description
$createStruct	WorkflowMetadataCreateStruct	-	-

Return values

WorkflowMetadata

createTransitionMetadata() ¶

HandlerInterface.php : 23 Copy path

    
                        public createTransitionMetadata(TransitionMetadataCreateStruct $createStruct, int $workflowId) : TransitionMetadata

Parameters

Name	Type	Default value	Description
$createStruct	TransitionMetadataCreateStruct	-	-
$workflowId	int	-	-

Return values

TransitionMetadata

createVersionLock() ¶

HandlerInterface.php : 86 Copy path

public createVersionLock(int $contentId, int $versionNo, int $userId) : void

Parameters

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

deleteTransitionMetadata() ¶

HandlerInterface.php : 30 Copy path

public deleteTransitionMetadata(int $transitionId) : void

Parameters

Name	Type	Default value	Description
$transitionId	int	-	-

deleteTransitionMetadataForWorkflow() ¶

HandlerInterface.php : 32 Copy path

public deleteTransitionMetadataForWorkflow(int $workflowId) : void

Parameters

Name	Type	Default value	Description
$workflowId	int	-	-

deleteVersionLock() ¶

HandlerInterface.php : 95 Copy path

public deleteVersionLock(int $contentId[, int $versionNo = null ]) : void

Parameters

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

deleteVersionLocksByUserId() ¶

HandlerInterface.php : 97 Copy path

public deleteVersionLocksByUserId(int $userId) : void

Parameters

Name	Type	Default value	Description
$userId	int	-	-

deleteWorkflowMetadata() ¶

HandlerInterface.php : 28 Copy path

public deleteWorkflowMetadata(int $workflowId) : void

Parameters

Name	Type	Default value	Description
$workflowId	int	-	-

findWorkflowMetadata() ¶

HandlerInterface.php : 69 Copy path

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

Parameters

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

Return values

array<string|int, WorkflowMetadata>

getVersionLock() ¶

HandlerInterface.php : 93 Copy path

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

Parameters

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

Return values

VersionLock

Tags

isVersionLocked() ¶

HandlerInterface.php : 99 Copy path

    
                        public isVersionLocked(int $contentId, int $versionNo[, int|null $userId = null ]) : bool

Parameters

Name	Type	Default value	Description
$contentId	int	-	-
$versionNo	int	-	-
$userId	int\|null	null	-

Return values

bool

load() ¶

HandlerInterface.php : 37 Copy path

    
                        public load(int $contentId, int $versionNo[, string|null $workflowName = null ]) : WorkflowMetadata

Parameters

Name	Type	Default value	Description
$contentId	int	-	-
$versionNo	int	-	-
$workflowName	string\|null	null	-

Return values

WorkflowMetadata

Tags

loadAllWorkflowMetadata() ¶

HandlerInterface.php : 74 Copy path

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

Return values

array<string|int, WorkflowMetadata>

loadAllWorkflowMetadataOriginatedByUser() ¶

HandlerInterface.php : 49 Copy path

    
                        public loadAllWorkflowMetadataOriginatedByUser(int $userId[, string|null $workflowName = null ]) : array<string|int, WorkflowMetadata>

Parameters

Name	Type	Default value	Description
$userId	int	-	-
$workflowName	string\|null	null	-

Return values

array<string|int, WorkflowMetadata>

loadContentIdsWithOrphanedWorkflowMetadata() ¶

HandlerInterface.php : 106 Copy path

public loadContentIdsWithOrphanedWorkflowMetadata() : array<string|int, int>

Return values

array<string|int, int>

loadMarkingMetadataByWorkflowId() ¶

HandlerInterface.php : 56 Copy path

    
                        public loadMarkingMetadataByWorkflowId(int $workflowId) : array<string|int, MarkingMetadata>

Parameters

Name	Type	Default value	Description
$workflowId	int	-	-

Return values

array<string|int, MarkingMetadata>

Tags

loadTransitionMetadataByWorkflowId() ¶

HandlerInterface.php : 44 Copy path

    
                        public loadTransitionMetadataByWorkflowId(int $workflowId) : array<string|int, TransitionMetadata>

Parameters

Name	Type	Default value	Description
$workflowId	int	-	-

Return values

array<string|int, TransitionMetadata>

Tags

loadWorkflowMetadataByContent() ¶

HandlerInterface.php : 79 Copy path

    
                        public loadWorkflowMetadataByContent(int $contentId[, int|null $versionNo = null ]) : array<string|int, WorkflowMetadata>

Parameters

Name	Type	Default value	Description
$contentId	int	-	-
$versionNo	int\|null	null	-

Return values

array<string|int, WorkflowMetadata>

loadWorkflowMetadataByStage() ¶

HandlerInterface.php : 84 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>

setMarkingMetadata() ¶

HandlerInterface.php : 61 Copy path

    
                        public setMarkingMetadata(MarkingMetadataSetStruct $setStruct, int $workflowId) : array<string|int, MarkingMetadata>

Parameters

Name	Type	Default value	Description
$setStruct	MarkingMetadataSetStruct	-	-
$workflowId	int	-	-

Return values

array<string|int, MarkingMetadata>

updateVersionLock() ¶

HandlerInterface.php : 88 Copy path

    
                        public updateVersionLock(int $contentId, int $versionNo, bool $isLocked[, int|null $userId = null ]) : void

Parameters

Name	Type	Default value	Description
$contentId	int	-	-
$versionNo	int	-	-
$isLocked	bool	-	-
$userId	int\|null	null	-