class BasicWorkflow extends Workflow implements AssignableObjectInterface (View source)

Traits

Properties

$error from  ConcreteObject
protected int $wfID

The workflow ID.

from  Workflow
protected string[] $allowedTasks

The list of allowed tasks.

from  Workflow
protected string[] $restrictedToPermissionKeyHandles

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

from  Workflow

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.

from  Workflow
string
getWorkflowName()

Get the workflow (English) name.

from  Workflow
string
getWorkflowDisplayName(string $format = 'html')

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

from  Workflow
string[]
getAllowedTasks()

Get the list of allowed tasks.

from  Workflow
Type|null
getWorkflowTypeObject()

Get the workflow type associated to this workflow.

from  Workflow
getRestrictedToPermissionKeyHandles()

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

from  Workflow
from  Workflow
from  Workflow
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.

from  Workflow
static Workflow[]
getList()

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

from  Workflow
static Workflow[]
getListByPackage(Package $pkg)

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

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

Create a new workflow.

from  Workflow
static Workflow|null
getByID(int $wfID)

Get a workflow given its ID.

from  Workflow
static Workflow|null
getByName(string $wfName)

Get a workflow given its (English) name.

from  Workflow
updateName(string $wfName)

Change the (English) name of this workflow.

from  Workflow
start(Progress $wp)

Start the workflow.

bool
canApproveWorkflow()

Returns true if the logged-in user can approve the current 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($post)

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

from  Workflow
bool
validateTrigger(Request $req)

Check if a workflow request is valid.

from  Workflow
load(int $wfID)

Load the workflow data from the database row.

from  Workflow
assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

executeBeforePermissionAssignment($cascadeToChildren = true)

No description

setPermissionsToOverride()

No description

notify(Progress $wp, $message, $permission = 'notify_on_basic_workflow_entry', $parameters = [])

No description

cancel(Progress $wp)

No description

approve(Progress $wp)

No description

getTranslatedMessage($message, $date)

No description

Details

loadError($error)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

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()

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

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

updateName(string $wfName)

Change the (English) name of this workflow.

Parameters

string $wfName

Response|SkippedResponse|null start(Progress $wp)

Start the workflow.

Parameters

Progress $wp

Return Value

Response|SkippedResponse|null

bool canApproveWorkflow()

Returns true if the logged-in user can approve the current workflow.

Return Value

bool

UserInfo[] getWorkflowProgressApprovalUsers(Progress $wp)

Get the list of users that can approve an operation.

Parameters

Progress $wp

Return Value

UserInfo[]

Action[] getWorkflowProgressActions(Progress $wp)

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

Parameters

Progress $wp

Return Value

Action[]

string|false|null getWorkflowProgressCurrentComment(Progress $wp)

Get the comments about an operation.

Parameters

Progress $wp

Return Value

string|false|null

string getWorkflowProgressStatusDescription(Progress $wp)

Get the description of the status of an operation.

Parameters

Progress $wp

Return Value

string

bool canApproveWorkflowProgressObject(Progress $wp)

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

Parameters

Progress $wp

Return Value

bool

updateDetails($post)

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

Parameters

$post

loadDetails()

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

bool getPermissionAccessObject()

No description

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

assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

executeBeforePermissionAssignment($cascadeToChildren = true)

No description

Parameters

$cascadeToChildren

setChildPermissionsToOverride()

No description

setPermissionsToOverride()

No description

protected notify(Progress $wp, $message, $permission = 'notify_on_basic_workflow_entry', $parameters = [])

No description

Parameters

Progress $wp
$message
$permission
$parameters

cancel(Progress $wp)

No description

Parameters

Progress $wp

approve(Progress $wp)

No description

Parameters

Progress $wp

private getTranslatedMessage($message, $date)

No description

Parameters

$message
$date