Menu

## SeedDMS_Core_Workflow_Transition
in package

inc.ClassWorkflow.php : 840

Class to represent a workflow transition 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

$_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

inc.ClassWorkflow.php : 874
`protected SeedDMS_Core_Workflow_Action $_action`

of the workflow transition

##### Tags

access

  protected

#### $_dms

inc.ClassWorkflow.php : 902
`protected SeedDMS_Core_DMS $_dms`

reference to the dms instance this attribute belongs to

##### Tags

access

  protected

#### $_groups

inc.ClassWorkflow.php : 895
`protected array<string|int, SeedDMS_Core_Group> $_groups`

of groups allowed to trigger this transaction

##### Tags

access

  protected

#### $_id

inc.ClassWorkflow.php : 846
`protected int $_id`

id of workflow transition

##### Tags

access

  protected

#### $_maxtime

inc.ClassWorkflow.php : 881
`protected int $_maxtime`

maximum of seconds allowed until this transition must be triggered

##### Tags

access

  protected

#### $_nextstate

inc.ClassWorkflow.php : 867
`protected SeedDMS_Core_Workflow_State $_nextstate`

next state of the workflow transition

##### Tags

access

  protected

#### $_state

inc.ClassWorkflow.php : 860
`protected SeedDMS_Core_Workflow_State $_state`

of the workflow transition

##### Tags

access

  protected

#### $_users

inc.ClassWorkflow.php : 888
`protected array<string|int, SeedDMS_Core_User> $_users`

of users allowed to trigger this transaction

##### Tags

access

  protected

#### $_workflow

inc.ClassWorkflow.php : 853
`protected SeedDMS_Core_Workflow $_workflow`

workflow this transition belongs to

##### Tags

access

  protected

### Methods

#### __construct()

inc.ClassWorkflow.php : 913

SeedDMS_Core_Workflow_Transition constructor.

`public __construct( $id, $workflow, $state, $action, $nextstate, $maxtime) : mixed`

##### Parameters

$id :
$workflow :
$state :
$action :
$nextstate :
$maxtime :

#### getAction()

inc.ClassWorkflow.php : 1005
`public getAction() : SeedDMS_Core_Workflow_Action`

##### Return values

SeedDMS_Core_Workflow_Action

#### getGroups()

inc.ClassWorkflow.php : 1092

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()

inc.ClassWorkflow.php : 933
`public getID() : int`

##### Return values

int

#### getMaxTime()

inc.ClassWorkflow.php : 1027
`public getMaxTime() : int`

##### Return values

int

#### getNextState()

inc.ClassWorkflow.php : 983
`public getNextState() : SeedDMS_Core_Workflow_State`

##### Return values

SeedDMS_Core_Workflow_State

#### getState()

inc.ClassWorkflow.php : 961
`public getState() : SeedDMS_Core_Workflow_State`

##### Return values

SeedDMS_Core_Workflow_State

#### getUsers()

inc.ClassWorkflow.php : 1051

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()

inc.ClassWorkflow.php : 938
`public getWorkflow() : SeedDMS_Core_Workflow`

##### Return values

SeedDMS_Core_Workflow

#### remove()

inc.ClassWorkflow.php : 1134

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()

inc.ClassWorkflow.php : 1011
`public setAction(SeedDMS_Core_Workflow_Action $newAction) : bool`

##### Parameters

$newAction : SeedDMS_Core_Workflow_Action

##### Return values

bool

#### setDMS()

inc.ClassWorkflow.php : 926
`public setDMS( $dms) : mixed`

##### Parameters

$dms :

#### setMaxTime()

inc.ClassWorkflow.php : 1033
`public setMaxTime( $maxtime) : bool`

##### Parameters

$maxtime :

##### Return values

bool

#### setNextState()

inc.ClassWorkflow.php : 989
`public setNextState(SeedDMS_Core_Workflow_State $newNextState) : bool`

##### Parameters

$newNextState : SeedDMS_Core_Workflow_State

##### Return values

bool

#### setState()

inc.ClassWorkflow.php : 967
`public setState(SeedDMS_Core_Workflow_State $newState) : bool`

##### Parameters

$newState : SeedDMS_Core_Workflow_State

##### Return values

bool

#### setWorkflow()

inc.ClassWorkflow.php : 944
`public setWorkflow(SeedDMS_Core_Workflow $newWorkflow) : bool`

##### Parameters

$newWorkflow : SeedDMS_Core_Workflow

##### Return values

bool

## Search results