class Workflow extends ConcreteObject implements ObjectInterface (View source)

\@package Workflow

Properties

$error from ConcreteObject
protected $wfID
protected $allowedTasks
protected $restrictedToPermissionKeyHandles

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

getWorkflowID()

No description

getWorkflowName()

No description

string
getWorkflowDisplayName(string $format = 'html')

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

getWorkflowTypeObject()

No description

delete()

No description

static 
getList()

No description

static 
getListByPackage(Package $pkg)

No description

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

No description

load($wfID)

No description

static 
getByID($wfID)

No description

static 
getByName($wfName)

No description

getWorkflowToolsURL($task)

No description

updateName($wfName)

No description

start(Progress $wp)

No description

canApproveWorkflow()

No description

getWorkflowProgressActions(Progress $wp)

No description

updateDetails($vars)

No description

loadDetails()

No description

getPermissionAccessObject()

No description

validateTrigger(Request $req)

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

abstract start(Progress $wp)

Parameters

Progress $wp

abstract canApproveWorkflow()

abstract getWorkflowProgressApprovalUsers(Progress $wp)

Parameters

Progress $wp

abstract getWorkflowProgressActions(Progress $wp)

Parameters

Progress $wp

abstract getWorkflowProgressCurrentComment(Progress $wp)

Parameters

Progress $wp

abstract getWorkflowProgressStatusDescription(Progress $wp)

Parameters

Progress $wp

abstract canApproveWorkflowProgressObject(Progress $wp)

Parameters

Progress $wp

abstract updateDetails($vars)

Parameters

$vars

abstract loadDetails()

getPermissionAccessObject()

validateTrigger(Request $req)

Parameters

Request $req