Workflow
abstract class Workflow extends ConcreteObject implements ObjectInterface (View source)
Properties
| $error | from ConcreteObject | ||
| protected int | $wfID | The workflow ID. |
|
| protected string[] | $allowedTasks | The list of allowed tasks. |
|
| protected string[] | $restrictedToPermissionKeyHandles | The list of permission key handles that this workflow can be attached to. |
Methods
Get the workflow ID.
Get the workflow (English) name.
Get the display name for this workflow (localized and escaped accordingly to $format).
Get the list of allowed tasks.
Get the workflow type associated to this workflow.
Get the list of permission key handles that this workflow can be attached to.
No description
No description
No description
No description
Delete this workflow and all its associated progresses.
By default the basic workflow just passes the status num from the request we do this so that we can order things by most important, etc.
Get the list of installed workflows, sorted by the workflow display name.
Get the list of workflows installed by a package, sorted by the workflow display name.
Change the (English) name of this workflow.
Check if the currently logged-in user can approve this workflow.
Get the list of actions that can be performed against an operation.
Get the description of the status of an operation.
Check if the currently logged-in user can approve an operation.
Update the workflow details with data (usually received via POST).
Load the details of this workflow (usually called right after this instance has been created).
No description
Load the workflow data from the database row.
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
int
getWorkflowID()
Get the workflow ID.
string
getWorkflowName()
Get the workflow (English) name.
string
getWorkflowDisplayName(string $format = 'html')
Get the display name for this workflow (localized and escaped accordingly to $format).
string[]
getAllowedTasks()
Get the list of allowed tasks.
Type|null
getWorkflowTypeObject()
Get the workflow type associated to this workflow.
getRestrictedToPermissionKeyHandles()
Get the list of permission key handles that this workflow can be attached to.
getPermissionResponseClassName()
No description
getPermissionAssignmentClassName()
No description
getPermissionObjectKeyCategoryHandle()
No description
getPermissionObjectIdentifier()
No description
delete()
Delete this workflow and all its associated progresses.
int|null
getWorkflowProgressCurrentStatusNum(Progress $wp)
By default the basic workflow just passes the status num from the request we do this so that we can order things by most important, etc.
..
static Workflow[]
getList()
Get the list of installed workflows, sorted by the workflow display name.
static Workflow[]
getListByPackage(Package $pkg)
Get the list of workflows installed by a package, sorted by the workflow display name.
static Workflow|null
getByID(int $wfID)
Get a workflow given its ID.
static Workflow|null
getByName(string $wfName)
Get a workflow given its (English) name.
updateName(string $wfName)
Change the (English) name of this workflow.
abstract Response|SkippedResponse|null
start(Progress $wp)
Start the workflow.
abstract bool
canApproveWorkflow()
Check if the currently logged-in user can approve this workflow.
abstract UserInfo[]
getWorkflowProgressApprovalUsers(Progress $wp)
Get the list of users that can approve an operation.
abstract Action[]
getWorkflowProgressActions(Progress $wp)
Get the list of actions that can be performed against an operation.
abstract string|false|null
getWorkflowProgressCurrentComment(Progress $wp)
Get the comments about an operation.
abstract string
getWorkflowProgressStatusDescription(Progress $wp)
Get the description of the status of an operation.
abstract bool
canApproveWorkflowProgressObject(Progress $wp)
Check if the currently logged-in user can approve an operation.
abstract
updateDetails(array $vars)
Update the workflow details with data (usually received via POST).
abstract
loadDetails()
Load the details of this workflow (usually called right after this instance has been created).
bool
getPermissionAccessObject()
No description
bool
validateTrigger(Request $req)
Check if a workflow request is valid.
protected
load(int $wfID)
Load the workflow data from the database row.