ModelWorkflows module

Step

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

Workflows\Models\Frontend\Step Workflows\Models\Api\Step Workflows\Models\Backend\Step Also in Workflows: BranchApproval BranchComment BranchTransition RevisionBranch Target Transition 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.

# isEditingAllowedForUser()
bool
Determined whether editing of records in this step is allowed for the current user
# getId()
?int
# getName()
?string
# getColor()
?string
# getPosition()
?int
# isEditEveryone()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getWorkflow()
?Workflow
# getIncomingTransitions()
?Collection<Transition>
# getOutgoingTransitions()
?Collection<Transition>
# getEditGroups()
?Collection<Group>
# getNotificationGroups()
?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.

# getAllowedTransitions(RevisionBranch $branch)
Collection
Get the transitions allowed from this step for the current user

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.

# editingAllowedForUser
bool
Determined whether editing of records in this step is allowed for the current user
# id
?int
# name
?string
# color
?string
# position
?int
# editEveryone
bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# workflow
?Workflow
# incomingTransitions
?Collection<Transition>
# outgoingTransitions
?Collection<Transition>
# editGroups
?Collection<Group>
# notificationGroups
?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 18

Take no arguments.

# isEditingAllowedForUser()
bool
Determined whether editing of records in this step is allowed for the current user
# getId()
?int
# getName()
?string
# getColor()
?string
# getPosition()
?int
# isEditEveryone()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getWorkflow()
?Workflow
# getIncomingTransitions()
?Collection<Transition>
# getOutgoingTransitions()
?Collection<Transition>
# getEditGroups()
?Collection<Group>
# getNotificationGroups()
?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
# getUid() Admin only
?string
Get uid to match diagram elements
# getData() Admin only
array
Get the data of the step in a format usable for the diagram

Methods 1

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

# getAllowedTransitions(RevisionBranch $branch)
Collection
Get the transitions allowed from this step for the current user