SeedDMS_Core_Workflow_Action
in package
Class to represent a workflow action in the document management system
Tags
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
$_dms
public
SeedDMS_Core_DMS
$_dms
reference to the dms instance this attribute belongs to
Tags
$_id
public
int
$_id
id of workflow action
Tags
$_name
public
string
$_name
name of the workflow action
Tags
Methods
__construct()
SeedDMS_Core_Workflow_Action constructor.
public
__construct( $id, $name) : mixed
Parameters
getID()
public
getID() : int
Return values
intgetName()
public
getName() : string
Return values
string —name
getTransitions()
Return workflow transitions the action is being used in
public
getTransitions() : array<string|int, SeedDMS_Core_Workflow_Transition>|bool
Return values
array<string|int, SeedDMS_Core_Workflow_Transition>|bool —array of workflow transitions or false in case of an error
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
setDMS()
public
setDMS( $dms) : mixed
Parameters
setName()
public
setName( $newName) : bool