ModelWorkflows module

Transition

A model in the Workflows module, with 17 members for templates, 13 API properties and 20 members for admin templates.

Workflows\Models\Frontend\Transition Workflows\Models\Api\Transition Workflows\Models\Backend\Transition Also in Workflows: BranchApproval BranchComment BranchTransition RevisionBranch Step Target Workflow
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 16

Take no arguments.

# isForward()
bool
Determines whether the transition aims to advance the record
# isMakeActiveTransition()
bool
Determines whether the transition aims to advance the record
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTransitionEveryone()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getWorkflow()
?Workflow
# getSourceStep()
?Step
# getTargetStep()
?Step
# getAdvanceGroups()
?Collection<Group>
# getApprovalGroups()
?Collection<Group>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

Methods 1

Take arguments. The API serialises only getters that need none.

# isAllowedForCurrentUser(RevisionBranch $branch)
bool
Checks whether the user can do the transition for the provided branch

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 13

Read-only values on the record.

# forward
bool
Determines whether the transition aims to advance the record
# makeActiveTransition
bool
Determines whether the transition aims to advance the record
# id
?int
# name
?string
# position
?int
# transitionEveryone
bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# workflow
?Workflow
# sourceStep
?Step
# targetStep
?Step
# advanceGroups
?Collection<Group>
# approvalGroups
?Collection<Group>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 19

Take no arguments.

# isForward()
bool
Determines whether the transition aims to advance the record
# isMakeActiveTransition()
bool
Determines whether the transition aims to advance the record
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTransitionEveryone()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getWorkflow()
?Workflow
# getSourceStep()
?Step
# getTargetStep()
?Step
# getAdvanceGroups()
?Collection<Group>
# getApprovalGroups()
?Collection<Group>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getFromUid() Admin only
?string
Get the source uid to match diagram elements
# getToUid() Admin only
?string
Get the target uid to match diagram elements
# getData() Admin only
array
Get the data of the transition in a format usable for the diagram

Methods 1

Take arguments. The API serialises only getters that need none.

# isAllowedForCurrentUser(RevisionBranch $branch)
bool
Checks whether the user can do the transition for the provided branch