class BasicWorkflow extends Workflow implements AssignableObjectInterface (View source)

Traits

Properties

$error from ConcreteObject
protected $wfID from Workflow
protected $allowedTasks from Workflow
protected $restrictedToPermissionKeyHandles 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

getAllowedTasks()

No description

from Workflow
getWorkflowID()

No description

from Workflow
getWorkflowName()

No description

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

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

from Workflow
getWorkflowTypeObject()

No description

from Workflow
from Workflow
from Workflow
delete()

No description

static 
getList()

No description

from Workflow
static 
getListByPackage(Package $pkg)

No description

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

No description

from Workflow
load($wfID)

No description

from Workflow
static 
getByID($wfID)

No description

from Workflow
static 
getByName($wfName)

No description

from Workflow
getWorkflowToolsURL($task)

No description

from Workflow
updateName($wfName)

No description

from Workflow
start(Progress $wp)

No description

canApproveWorkflow()

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

getWorkflowProgressActions(Progress $wp)

No description

updateDetails($post)

No description

loadDetails()

No description

getPermissionAccessObject()

No description

from Workflow
validateTrigger(Request $req)

No description

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 = null, $date)

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

getAllowedTasks()

getWorkflowID()

getWorkflowName()

string getWorkflowDisplayName(string $format = 'html')

Returns 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

getWorkflowTypeObject()

getRestrictedToPermissionKeyHandles()

getPermissionResponseClassName()

getPermissionAssignmentClassName()

getPermissionObjectKeyCategoryHandle()

getPermissionObjectIdentifier()

delete()

getWorkflowProgressCurrentStatusNum(Progress $wp)

Parameters

Progress $wp

static getList()

static getListByPackage(Package $pkg)

Parameters

Package $pkg

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

Parameters

Type $wt
$name
Package $pkg

protected load($wfID)

Parameters

$wfID

static getByID($wfID)

Parameters

$wfID

static getByName($wfName)

Parameters

$wfName

getWorkflowToolsURL($task)

Parameters

$task

updateName($wfName)

Parameters

$wfName

start(Progress $wp)

Parameters

Progress $wp

canApproveWorkflow()

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

getWorkflowProgressApprovalUsers(Progress $wp)

Parameters

Progress $wp

getWorkflowProgressActions(Progress $wp)

Parameters

Progress $wp

getWorkflowProgressCurrentComment(Progress $wp)

Parameters

Progress $wp

getWorkflowProgressStatusDescription(Progress $wp)

Parameters

Progress $wp

canApproveWorkflowProgressObject(Progress $wp)

Parameters

Progress $wp

updateDetails($post)

Parameters

$post

loadDetails()

getPermissionAccessObject()

validateTrigger(Request $req)

Parameters

Request $req

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

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

executeBeforePermissionAssignment($cascadeToChildren = true)

Parameters

$cascadeToChildren

setChildPermissionsToOverride()

setPermissionsToOverride()

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

Parameters

Progress $wp
$message
$permission
$parameters

cancel(Progress $wp)

Parameters

Progress $wp

approve(Progress $wp)

Parameters

Progress $wp

private getTranslatedMessage($message = null, $date)

Parameters

$message
$date