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

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.

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
add(Type $wt, string $name, Package $pkg = null)

Create a new workflow.

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.

string
getWorkflowToolsURL(string $task)

Get the URL of a task for this workflow.

updateName(string $wfName)

Change the (English) name of this workflow.

start(Progress $wp)

Start the workflow.

bool
canApproveWorkflow()

Check if the currently logged-in user can approve this workflow.

getWorkflowProgressApprovalUsers(Progress $wp)

Get the list of users that can approve an operation.

Action[]
getWorkflowProgressActions(Progress $wp)

Get the list of actions that can be performed against an operation.

string|false|null
getWorkflowProgressCurrentComment(Progress $wp)

Get the comments about an operation.

string
getWorkflowProgressStatusDescription(Progress $wp)

Get the description of the status of an operation.

bool
canApproveWorkflowProgressObject(Progress $wp)

Check if the currently logged-in user can approve an operation.

updateDetails(array $vars)

Update the workflow details with data (usually received via POST).

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.

load(int $wfID)

Load the workflow data from the database row.

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

int getWorkflowID()

Get the workflow ID.

Return Value

int

string getWorkflowName()

Get the workflow (English) name.

Return Value

string

string getWorkflowDisplayName(string $format = 'html')

Get the display name for this workflow (localized and escaped accordingly to $format).

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

string[] getAllowedTasks()

Get the list of allowed tasks.

Return Value

string[]

Type|null getWorkflowTypeObject()

Get the workflow type associated to this workflow.

Return Value

Type|null

getRestrictedToPermissionKeyHandles()

Get the list of permission key handles that this workflow can be attached to.

getPermissionResponseClassName()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionResponseClassName()

getPermissionAssignmentClassName()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionAssignmentClassName()

getPermissionObjectKeyCategoryHandle()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionObjectKeyCategoryHandle()

getPermissionObjectIdentifier()

See also

\Concrete\Core\Permission\ObjectInterface::getPermissionObjectIdentifier()

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.

..

Parameters

Progress $wp

Return Value

int|null

static Workflow[] getList()

Get the list of installed workflows, sorted by the workflow display name.

Return Value

Workflow[]

static Workflow[] getListByPackage(Package $pkg)

Get the list of workflows installed by a package, sorted by the workflow display name.

Parameters

Package $pkg

Return Value

Workflow[]

static Workflow add(Type $wt, string $name, Package $pkg = null)

Create a new workflow.

Parameters

Type $wt The workflow type
string $name the (English) name of the workflow
Package $pkg the package that's creating the new workflow

Return Value

Workflow

static Workflow|null getByID(int $wfID)

Get a workflow given its ID.

Parameters

int $wfID the ID of the workflow

Return Value

Workflow|null

static Workflow|null getByName(string $wfName)

Get a workflow given its (English) name.

Parameters

string $wfName

Return Value

Workflow|null

string getWorkflowToolsURL(string $task)

Get the URL of a task for this workflow.

Parameters

string $task

Return Value

string

updateName(string $wfName)

Change the (English) name of this workflow.

Parameters

string $wfName

abstract Response|SkippedResponse|null start(Progress $wp)

Start the workflow.

Parameters

Progress $wp

Return Value

Response|SkippedResponse|null

abstract bool canApproveWorkflow()

Check if the currently logged-in user can approve this workflow.

Return Value

bool

abstract UserInfo[] getWorkflowProgressApprovalUsers(Progress $wp)

Get the list of users that can approve an operation.

Parameters

Progress $wp

Return Value

UserInfo[]

abstract Action[] getWorkflowProgressActions(Progress $wp)

Get the list of actions that can be performed against an operation.

Parameters

Progress $wp

Return Value

Action[]

abstract string|false|null getWorkflowProgressCurrentComment(Progress $wp)

Get the comments about an operation.

Parameters

Progress $wp

Return Value

string|false|null

abstract string getWorkflowProgressStatusDescription(Progress $wp)

Get the description of the status of an operation.

Parameters

Progress $wp

Return Value

string

abstract bool canApproveWorkflowProgressObject(Progress $wp)

Check if the currently logged-in user can approve an operation.

Parameters

Progress $wp

Return Value

bool

abstract updateDetails(array $vars)

Update the workflow details with data (usually received via POST).

Parameters

array $vars

abstract loadDetails()

Load the details of this workflow (usually called right after this instance has been created).

bool getPermissionAccessObject()

Return Value

bool

bool validateTrigger(Request $req)

Check if a workflow request is valid.

Parameters

Request $req

Return Value

bool

protected load(int $wfID)

Load the workflow data from the database row.

Parameters

int $wfID