ApprovalProcessStep
extends BaseEntity
in package
Ordered approval step within an award approval process.
Table of Contents
Constants
- ACTION_CLOSE : mixed = 'close'
- ACTION_OPTIONS : mixed = [self::ACTION_RETURN_PREVIOUS => 'Return to pre...
- ACTION_RETURN_PREVIOUS : mixed = 'return_previous'
- ACTION_RETURN_STEP_PREFIX : mixed = 'return_step:'
- APPROVER_TYPE_DYNAMIC : mixed = 'dynamic'
- APPROVER_TYPE_MEMBER : mixed = 'member'
- APPROVER_TYPE_OFFICE : mixed = 'office'
- APPROVER_TYPE_OPTIONS : mixed = [self::APPROVER_TYPE_ROLE => 'Role', self::APPR...
- APPROVER_TYPE_PERMISSION : mixed = 'permission'
- APPROVER_TYPE_ROLE : mixed = 'role'
- BRANCH_MODE_ANCESTOR_TYPE : mixed = 'ancestor_branch_type'
- BRANCH_MODE_AWARD : mixed = 'award_branch'
- BRANCH_MODE_OPTIONS : mixed = [self::BRANCH_MODE_AWARD => 'Award branch', sel...
- STEP_TYPE_APPROVAL : mixed = 'approval'
- THRESHOLD_ALL : mixed = 'all'
- THRESHOLD_ANY : mixed = 'any'
- THRESHOLD_COUNT : mixed = 'count'
- THRESHOLD_MODE_OPTIONS : mixed = [self::THRESHOLD_ANY => 'Any one approver', sel...
Properties
- $branch_id : int|null
- $created : DateTime|null
- $id : int
- $modified : DateTime|null
- $_accessible : array<string|int, mixed>
Methods
- getBranchId() : int|null
- Get the branch ID for authorization checks.
- _getApproverSummary() : string
- Summarize the configured approver source.
- _getThresholdSummary() : string
- Summarize the configured approval threshold.
Constants
ACTION_CLOSE
public
mixed
ACTION_CLOSE
= 'close'
ACTION_OPTIONS
public
mixed
ACTION_OPTIONS
= [self::ACTION_RETURN_PREVIOUS => 'Return to previous step', self::ACTION_CLOSE => 'Close recommendation']
ACTION_RETURN_PREVIOUS
public
mixed
ACTION_RETURN_PREVIOUS
= 'return_previous'
ACTION_RETURN_STEP_PREFIX
public
mixed
ACTION_RETURN_STEP_PREFIX
= 'return_step:'
APPROVER_TYPE_DYNAMIC
public
mixed
APPROVER_TYPE_DYNAMIC
= 'dynamic'
APPROVER_TYPE_MEMBER
public
mixed
APPROVER_TYPE_MEMBER
= 'member'
APPROVER_TYPE_OFFICE
public
mixed
APPROVER_TYPE_OFFICE
= 'office'
APPROVER_TYPE_OPTIONS
public
mixed
APPROVER_TYPE_OPTIONS
= [self::APPROVER_TYPE_ROLE => 'Role', self::APPROVER_TYPE_PERMISSION => 'Permission', self::APPROVER_TYPE_OFFICE => 'Office', self::APPROVER_TYPE_MEMBER => 'Member', self::APPROVER_TYPE_DYNAMIC => 'Dynamic resolver']
APPROVER_TYPE_PERMISSION
public
mixed
APPROVER_TYPE_PERMISSION
= 'permission'
APPROVER_TYPE_ROLE
public
mixed
APPROVER_TYPE_ROLE
= 'role'
BRANCH_MODE_ANCESTOR_TYPE
public
mixed
BRANCH_MODE_ANCESTOR_TYPE
= 'ancestor_branch_type'
BRANCH_MODE_AWARD
public
mixed
BRANCH_MODE_AWARD
= 'award_branch'
BRANCH_MODE_OPTIONS
public
mixed
BRANCH_MODE_OPTIONS
= [self::BRANCH_MODE_AWARD => 'Award branch', self::BRANCH_MODE_ANCESTOR_TYPE => 'Ancestor branch type']
STEP_TYPE_APPROVAL
public
mixed
STEP_TYPE_APPROVAL
= 'approval'
THRESHOLD_ALL
public
mixed
THRESHOLD_ALL
= 'all'
THRESHOLD_ANY
public
mixed
THRESHOLD_ANY
= 'any'
THRESHOLD_COUNT
public
mixed
THRESHOLD_COUNT
= 'count'
THRESHOLD_MODE_OPTIONS
public
mixed
THRESHOLD_MODE_OPTIONS
= [self::THRESHOLD_ANY => 'Any one approver', self::THRESHOLD_ALL => 'All resolved approvers', self::THRESHOLD_COUNT => 'Specific number of approvers']
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime|null
$created
Creation timestamp
$id
public
int
$id
Primary key identifier
$modified
public
DateTime|null
$modified
Last modification timestamp
$_accessible
protected
array<string|int, mixed>
$_accessible
= ['approval_process_id' => true, 'step_key' => true, 'label' => true, 'sequence' => true, 'step_type' => true, 'approver_type' => true, 'approver_source_id' => true, 'approver_source_key' => true, 'branch_mode' => true, 'branch_type' => true, 'threshold_mode' => true, 'required_count' => true, 'on_reject' => true, 'on_request_changes' => true, 'retain_read_visibility' => true, 'created' => true, 'modified' => true, 'created_by' => true, 'modified_by' => true, 'deleted' => true, 'approval_process' => true]
Methods
getBranchId()
Get the branch ID for authorization checks.
public
getBranchId() : int|null
Child classes should override for complex branch relationships.
Return values
int|null —The branch ID, or null if no association
_getApproverSummary()
Summarize the configured approver source.
protected
_getApproverSummary() : string
Return values
string_getThresholdSummary()
Summarize the configured approval threshold.
protected
_getThresholdSummary() : string