Documentation

SeedDMS_Core_Workflow_Action
in package

Class to represent a workflow action in the document management system

Tags
category

DMS

author

Markus Westphal, Malcolm Cowe, Uwe Steinmann uwe@steinmann.cx

copyright

Copyright (C) 2012-2024 Uwe Steinmann

version

Release: @package_version@

Table of Contents

Properties

$_dms  : SeedDMS_Core_DMS
$_id  : int
$_name  : string

Methods

__construct()  : mixed
SeedDMS_Core_Workflow_Action constructor.
getID()  : int
getName()  : string
getTransitions()  : array<string|int, SeedDMS_Core_Workflow_Transition>|bool
Return workflow transitions the action is being used in
isUsed()  : bool
Check if workflow action is currently used by any workflow transition
remove()  : bool
Remove the workflow action
setDMS()  : mixed
setName()  : bool

Properties

$_name

public string $_name

name of the workflow action

Tags
access

protected

Methods

__construct()

SeedDMS_Core_Workflow_Action constructor.

public __construct( $id,  $name) : mixed
Parameters
$id :
$name :

isUsed()

Check if workflow action is currently used by any workflow transition

public isUsed() : bool
Return values
bool

true if workflow action is used, otherwise false

remove()

Remove the workflow action

public remove() : bool
Return values
bool

true on success or false in case of an error false is also returned if the workflow action is currently in use

setName()

public setName( $newName) : bool
Parameters
$newName :
Return values
bool

        
On this page

Search results