Menu

## SeedDMS_Core_Workflow_Action
in package

inc.ClassWorkflow.php : 695

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

#### $_dms

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

reference to the dms instance this attribute belongs to

##### Tags

access

  protected

#### $_id

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

id of workflow action

##### Tags

access

  protected

#### $_name

inc.ClassWorkflow.php : 708
`protected string $_name`

name of the workflow action

##### Tags

access

  protected

### Methods

#### __construct()

inc.ClassWorkflow.php : 722

SeedDMS_Core_Workflow_Action constructor.

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

##### Parameters

$id :
$name :

#### getID()

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

##### Return values

int

#### getName()

inc.ClassWorkflow.php : 743
`public getName() : string`

##### Return values

string —

name

#### getTransitions()

inc.ClassWorkflow.php : 783

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

inc.ClassWorkflow.php : 767

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

inc.ClassWorkflow.php : 808

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

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

##### Parameters

$dms :

#### setName()

inc.ClassWorkflow.php : 749
`public setName( $newName) : bool`

##### Parameters

$newName :

##### Return values

bool

## Search results