UserProgress
class UserProgress extends Progress (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 | $uID |
Methods
Get the users that should be excluded from notifications Expected return value would be users involved in the creation of the notification, they may not need to be notified.
Gets the Workflow object attached to this WorkflowProgress object.
Gets an optional WorkflowResponse object. This is set in some cases.
Gets the date the WorkflowProgress object was added.
Get the WorkflowRequest object for the current WorkflowProgress object.
Creates a WorkflowProgress object (which will be assigned to a Page, File, etc... in our system.
No description
The function that is automatically run when a workflowprogress object is started.
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.
No description
No description
No description
No description
Details
loadError($error)
No description
isError()
No description
getError()
No description
setPropertiesFromArray($arr)
No description
static
camelcase($file)
No description
static
uncamelcase($string)
No description
DateTime
getNotificationDate()
Get the date of this notification
User[]
getUsersToExcludeFromNotification()
Get the users that should be excluded from notifications Expected return value would be users involved in the creation of the notification, they may not need to be notified.
Workflow
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.
Request
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... in our system.
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
getWorkflowProgressFormAction()
No description
loadDetails()
No description
getWorkflowProgressHistoryObjectByID($wphID)
No description
addWorkflowProgressHistoryObject($obj)
No description
markCompleted()
No description
getPendingWorkflowProgressList()
No description
static
getList($requestedUID, $filters = array('wpIsCompleted' => 0), $sortBy = 'wpDateAdded asc')
No description