class Progress extends ConcreteObject implements SubjectInterface (View source)

Base class for workflow progresses.

Properties

$error from ConcreteObject
protected $wrID
protected $wpID
protected $wpDateAdded
protected $wfID
protected $response
protected $wpDateLastAction

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

getNotificationDate()

No description

getWorkflowObject()

Gets the Workflow object attached to this WorkflowProgress object.

getWorkflowProgressResponseObject()

Gets an optional WorkflowResponse object. This is set in some cases.

setWorkflowProgressResponseObject($obj)

No description

getWorkflowProgressDateLastAction()

Gets the date of the last action.

getWorkflowProgressID()

Gets the ID of the progress object.

getWorkflowProgressCategoryHandle()

Gets the ID of the progress object.

getWorkflowProgressCategoryID()

Get the category ID.

datetime
getWorkflowProgressDateAdded()

Gets the date the WorkflowProgress object was added.

getWorkflowRequestObject()

Get the WorkflowRequest object for the current WorkflowProgress object.

static 
__callStatic($name, $arguments)

No description

static Progress
create(string $wpCategoryHandle, Workflow $wf, Request $wr)

Creates a WorkflowProgress object (which will be assigned to a Page, File, etc.

delete()

No description

static 
getByID($wpID)

No description

static 
getRequestedTask()

No description

start()

The function that is automatically run when a workflowprogress object is started.

updateOnAction(Workflow $wf)

No description

WorkflowProgressResponse
runTask($task, $args = array())

Attempts to run a workflow task on the bound WorkflowRequest object first, then if that doesn't exist, attempts to run it on the current WorkflowProgress object.

getWorkflowProgressActions($additionalActions = true)

No description

loadDetails()

No description

getWorkflowProgressHistoryObjectByID($wphID)

No description

addWorkflowProgressHistoryObject($obj)

No description

markCompleted()

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

getNotificationDate()

getUsersToExcludeFromNotification()

Workflow getWorkflowObject()

Gets the Workflow object attached to this WorkflowProgress object.

Return Value

Workflow

getWorkflowProgressResponseObject()

Gets an optional WorkflowResponse object. This is set in some cases.

setWorkflowProgressResponseObject($obj)

Parameters

$obj

getWorkflowProgressDateLastAction()

Gets the date of the last action.

getWorkflowProgressID()

Gets the ID of the progress object.

getWorkflowProgressCategoryHandle()

Gets the ID of the progress object.

getWorkflowProgressCategoryID()

Get the category ID.

datetime getWorkflowProgressDateAdded()

Gets the date the WorkflowProgress object was added.

Return Value

datetime

Request getWorkflowRequestObject()

Get the WorkflowRequest object for the current WorkflowProgress object.

Return Value

Request

static __callStatic($name, $arguments)

Parameters

$name
$arguments

static Progress create(string $wpCategoryHandle, Workflow $wf, Request $wr)

Creates a WorkflowProgress object (which will be assigned to a Page, File, etc.

.. in our system.

Parameters

string $wpCategoryHandle
Workflow $wf
Request $wr

Return Value

Progress

delete()

static getByID($wpID)

Parameters

$wpID

static getRequestedTask()

start()

The function that is automatically run when a workflowprogress object is started.

updateOnAction(Workflow $wf)

Parameters

Workflow $wf

WorkflowProgressResponse runTask($task, $args = array())

Attempts to run a workflow task on the bound WorkflowRequest object first, then if that doesn't exist, attempts to run it on the current WorkflowProgress object.

Parameters

$task
$args

Return Value

WorkflowProgressResponse

getWorkflowProgressActions($additionalActions = true)

Parameters

$additionalActions

abstract getWorkflowProgressFormAction()

abstract loadDetails()

getWorkflowProgressHistoryObjectByID($wphID)

Parameters

$wphID

addWorkflowProgressHistoryObject($obj)

Parameters

$obj

markCompleted()

abstract getPendingWorkflowProgressList()