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)

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

getAllowedTasks()

No description

getWorkflowID()

No description

getWorkflowName()

No description

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

No description

getRestrictedToPermissionKeyHandles()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

getPermissionObjectIdentifier()

No description

delete()

No description

getWorkflowProgressCurrentStatusNum(Progress $wp)

No description

Parameters

Progress $wp

static getList()

No description

static getListByPackage(Package $pkg)

No description

Parameters

Package $pkg

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

No description

Parameters

Type $wt
$name
Package $pkg

protected load($wfID)

No description

Parameters

$wfID

static getByID($wfID)

No description

Parameters

$wfID

static getByName($wfName)

No description

Parameters

$wfName

getWorkflowToolsURL($task)

No description

Parameters

$task

updateName($wfName)

No description

Parameters

$wfName

start(Progress $wp)

No description

Parameters

Progress $wp

canApproveWorkflow()

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

getWorkflowProgressApprovalUsers(Progress $wp)

No description

Parameters

Progress $wp

getWorkflowProgressActions(Progress $wp)

No description

Parameters

Progress $wp

getWorkflowProgressCurrentComment(Progress $wp)

No description

Parameters

Progress $wp

getWorkflowProgressStatusDescription(Progress $wp)

No description

Parameters

Progress $wp

canApproveWorkflowProgressObject(Progress $wp)

No description

Parameters

Progress $wp

updateDetails($post)

No description

Parameters

$post

loadDetails()

No description

getPermissionAccessObject()

No description

validateTrigger(Request $req)

No description

Parameters

Request $req

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

No description

Parameters

$message
$date