SeedDMS_Core_Workflow_Transition
in package
Class to represent a workflow transition in the document management system
Tags
Table of Contents
Properties
- $_action : SeedDMS_Core_Workflow_Action
- $_dms : SeedDMS_Core_DMS
- $_groups : array<string|int, SeedDMS_Core_Group>
- $_id : int
- $_maxtime : int
- $_nextstate : SeedDMS_Core_Workflow_State
- $_state : SeedDMS_Core_Workflow_State
- $_users : array<string|int, SeedDMS_Core_User>
- $_workflow : SeedDMS_Core_Workflow
Methods
- __construct() : mixed
- SeedDMS_Core_Workflow_Transition constructor.
- getAction() : SeedDMS_Core_Workflow_Action
- getGroups() : array<string|int, SeedDMS_Core_Group>|bool
- Get all users allowed to trigger this transition
- getID() : int
- getMaxTime() : int
- getNextState() : SeedDMS_Core_Workflow_State
- getState() : SeedDMS_Core_Workflow_State
- getUsers() : array<string|int, SeedDMS_Core_User>|bool
- Get all users allowed to trigger this transition
- getWorkflow() : SeedDMS_Core_Workflow
- remove() : bool
- Remove the workflow transition
- setAction() : bool
- setDMS() : mixed
- setMaxTime() : bool
- setNextState() : bool
- setState() : bool
- setWorkflow() : bool
Properties
$_action
public
SeedDMS_Core_Workflow_Action
$_action
of the workflow transition
Tags
$_dms
public
SeedDMS_Core_DMS
$_dms
reference to the dms instance this attribute belongs to
Tags
$_groups
public
array<string|int, SeedDMS_Core_Group>
$_groups
of groups allowed to trigger this transaction
Tags
$_id
public
int
$_id
id of workflow transition
Tags
$_maxtime
public
int
$_maxtime
maximum of seconds allowed until this transition must be triggered
Tags
$_nextstate
public
SeedDMS_Core_Workflow_State
$_nextstate
next state of the workflow transition
Tags
$_state
public
SeedDMS_Core_Workflow_State
$_state
of the workflow transition
Tags
$_users
public
array<string|int, SeedDMS_Core_User>
$_users
of users allowed to trigger this transaction
Tags
$_workflow
public
SeedDMS_Core_Workflow
$_workflow
workflow this transition belongs to
Tags
Methods
__construct()
SeedDMS_Core_Workflow_Transition constructor.
public
__construct( $id, $workflow, $state, $action, $nextstate, $maxtime) : mixed
Parameters
getAction()
public
getAction() : SeedDMS_Core_Workflow_Action
Return values
SeedDMS_Core_Workflow_ActiongetGroups()
Get all users allowed to trigger this transition
public
getGroups() : array<string|int, SeedDMS_Core_Group>|bool
Return values
array<string|int, SeedDMS_Core_Group>|bool —list of users
getID()
public
getID() : int
Return values
intgetMaxTime()
public
getMaxTime() : int
Return values
intgetNextState()
public
getNextState() : SeedDMS_Core_Workflow_State
Return values
SeedDMS_Core_Workflow_StategetState()
public
getState() : SeedDMS_Core_Workflow_State
Return values
SeedDMS_Core_Workflow_StategetUsers()
Get all users allowed to trigger this transition
public
getUsers() : array<string|int, SeedDMS_Core_User>|bool
Return values
array<string|int, SeedDMS_Core_User>|bool —list of users
getWorkflow()
public
getWorkflow() : SeedDMS_Core_Workflow
Return values
SeedDMS_Core_Workflowremove()
Remove the workflow transition
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
setAction()
public
setAction(SeedDMS_Core_Workflow_Action $newAction) : bool
Parameters
- $newAction : SeedDMS_Core_Workflow_Action
Return values
boolsetDMS()
public
setDMS( $dms) : mixed
Parameters
setMaxTime()
public
setMaxTime( $maxtime) : bool
Parameters
Return values
boolsetNextState()
public
setNextState(SeedDMS_Core_Workflow_State $newNextState) : bool
Parameters
- $newNextState : SeedDMS_Core_Workflow_State
Return values
boolsetState()
public
setState(SeedDMS_Core_Workflow_State $newState) : bool
Parameters
- $newState : SeedDMS_Core_Workflow_State
Return values
boolsetWorkflow()
public
setWorkflow(SeedDMS_Core_Workflow $newWorkflow) : bool
Parameters
- $newWorkflow : SeedDMS_Core_Workflow