class CalendarEventProgress extends Progress implements SiteProgressInterface (View source)

Properties

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

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

from Progress
getWorkflowObject()

Gets the Workflow object attached to this WorkflowProgress object.

from Progress
getWorkflowProgressResponseObject()

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

from Progress
setWorkflowProgressResponseObject($obj)

No description

from Progress
getWorkflowProgressDateLastAction()

Gets the date of the last action.

from Progress
getWorkflowProgressID()

Gets the ID of the progress object.

from Progress
getWorkflowProgressCategoryHandle()

Gets the ID of the progress object.

from Progress
getWorkflowProgressCategoryID()

Get the category ID.

from Progress
datetime
getWorkflowProgressDateAdded()

Gets the date the WorkflowProgress object was added.

from Progress
getWorkflowRequestObject()

Get the WorkflowRequest object for the current WorkflowProgress object.

from Progress
static 
__callStatic($name, $arguments)

No description

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

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

from Progress
delete()

No description

static 
getByID($wpID)

No description

from Progress
static 
getRequestedTask()

No description

from Progress
start()

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

from Progress
updateOnAction(Workflow $wf)

No description

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

from Progress
getWorkflowProgressActions($additionalActions = true)

No description

from Progress
loadDetails()

No description

getWorkflowProgressHistoryObjectByID($wphID)

No description

from Progress
addWorkflowProgressHistoryObject($obj)

No description

from Progress
markCompleted()

No description

from Progress
getSite()

No description

static 
add(Workflow $wf, CalendarEventRequest $wr)

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

getWorkflowProgressFormAction()

loadDetails()

getWorkflowProgressHistoryObjectByID($wphID)

Parameters

$wphID

addWorkflowProgressHistoryObject($obj)

Parameters

$obj

markCompleted()

getPendingWorkflowProgressList()

Site getSite()

Return Value

Site

static add(Workflow $wf, CalendarEventRequest $wr)

Parameters

Workflow $wf
CalendarEventRequest $wr