FileWorkflowApplicable
class FileWorkflowApplicable extends WorkflowApplicable (View source)
WorkflowApplicable extension specifically for File objects, which don't have the same CMS UI structure so need to be handled a little differently. Additionally, it doesn't really work without custom code to handle the triggering of workflow, and in general is not ready for production use just yet.
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
| public | bool | $isPublishJobRunning | Used to flag to this extension if there's a WorkflowPublishTargetJob running. |
from WorkflowApplicable |
| public | WorkflowService | $workflowService | from WorkflowApplicable | |
| protected | WorkflowInstance | $currentInstance | A cache var for the current workflow instance |
from WorkflowApplicable |
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Included in CMS-generated email templates for a NotifyUsersWorkflowAction.
Included in CMS-generated email templates for a NotifyUsersWorkflowAction.
After a workflow item is written, we notify the workflow so that it can take action if needbe
Gets the history of a workflow instance
Check all recent WorkflowActionIntances and return the most recent one with a Comment
Content can never be directly publishable if there's a workflow applied.
Can only edit content that's NOT in another person's content changeset
Can a user edit the current workflow attached to this item?
No description
Details
__construct()
No description
static
add_to_class(string $class, string $extensionClass, mixed $args = null)
Called when this extension is added to a particular class
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
static string
get_classname_without_arguments(string $extensionStr)
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
setIsPublishJobRunning(bool $truth)
No description
bool
getIsPublishJobRunning()
No description
bool
isPublishJobRunning()
No description
protected
updateSettingsFields(FieldList $fields)
No description
protected
updateCMSFields(FieldList $fields)
No description
updateFields(FieldList $fields)
No description
protected
updateCMSActions(FieldList $actions)
No description
protected
createActionMenu()
No description
string|null
AbsoluteEditLink()
Included in CMS-generated email templates for a NotifyUsersWorkflowAction.
Returns an absolute link to the CMS UI for a Page object
string
LinkToPendingItems()
Included in CMS-generated email templates for a NotifyUsersWorkflowAction.
Allows users to select a link in an email for direct access to the transition-selection dropdown in the CMS UI.
protected
onAfterWrite()
After a workflow item is written, we notify the workflow so that it can take action if needbe
WorkflowInstances()
No description
WorkflowInstance
getWorkflowInstance()
Gets the current instance of workflow
WorkflowActionInstance>|void
getWorkflowHistory($limit = null)
Gets the history of a workflow instance
WorkflowActionInstance|null
RecentWorkflowComment(int $limit = 10)
Check all recent WorkflowActionIntances and return the most recent one with a Comment
canPublish()
Content can never be directly publishable if there's a workflow applied.
If there's an active instance, then it 'might' be publishable
bool
canEdit($member)
Can only edit content that's NOT in another person's content changeset
bool
canEditWorkflow()
Can a user edit the current workflow attached to this item?
$this
setWorkflowService(WorkflowService $workflowService)
No description
WorkflowService
getWorkflowService()
No description
WorkflowDefinition
WorkflowDefinition()
No description
void
ManyManyList() $WorkflowDefinition> AdditionalWorkflowDefinitions()
No description
protected
updateSummaryFields($fields)
No description