class WorkflowApplicable extends DataExtension (View source)

DataObjects that have the WorkflowApplicable extension can have a workflow definition applied to them. At some point, the workflow definition is then triggered.

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.

public WorkflowService $workflowService
protected WorkflowInstance $currentInstance

A cache var for the current workflow instance

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
T
getOwner()

Returns the owner of this extension.

public 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().

public
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

public
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

public
augmentDatabase()

Update the database schema as required by this extension.

public
augmentWrite(array $manipulation)

Augment a write-record request.

public
onBeforeWrite()

Extend the owner's onBeforeWrite() logic

public
onAfterWrite()

After a workflow item is written, we notify the workflow so that it can take action if needbe

public
onBeforeDelete()

Extend the owner's onBeforeDelete() logic

public
onAfterDelete()

Extend the owner's onAfterDelete() logic

public
requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

public
populateDefaults()

Extend the owner's populateDefaults() logic

public
onAfterBuild()

Extend the owner's onAfterBuild() logic

public
bool|null
can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canEdit(Member $member)

Can only edit content that's NOT in another person's content changeset

public
bool|null
canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

public
updateCMSFields(FieldList $fields)

This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().

public
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

public
updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

public
updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

public
updateSummaryFields(array $fields)

this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']

public
updateFieldLabels(array $labels)

this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']

public
setIsPublishJobRunning(bool $truth)

No description

public
bool
getIsPublishJobRunning()

No description

public
bool
isPublishJobRunning()

No description

public
updateSettingsFields(FieldList $fields)

No description

public
updateFields(FieldList $fields)

No description

protected
createActionMenu()

No description

public
string|null
AbsoluteEditLink()

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

public
string
LinkToPendingItems()

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

public
WorkflowInstances()

No description

public
getWorkflowInstance()

Gets the current instance of workflow

public
WorkflowActionInstance>|void
getWorkflowHistory($limit = null)

Gets the history of a workflow instance

public
RecentWorkflowComment(int $limit = 10)

Check all recent WorkflowActionIntances and return the most recent one with a Comment

public
canPublish()

Content can never be directly publishable if there's a workflow applied.

public
bool
canEditWorkflow()

Can a user edit the current workflow attached to this item?

public
$this
setWorkflowService(WorkflowService $workflowService)

No description

public
getWorkflowService()

No description

void
ManyManyList() $WorkflowDefinition> AdditionalWorkflowDefinitions()

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

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

T getOwner()

Returns the owner of this extension.

Return Value

T

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().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query

Query to augment.

DataQuery $dataQuery

Container DataQuery for this SQLSelect

augmentDatabase()

Update the database schema as required by this extension.

When duplicating a table's structure, remember to duplicate the create options as well. See Versioned->augmentDatabase for an example.

augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation

Array of operations to augment.

onBeforeWrite()

Extend the owner's onBeforeWrite() logic

See DataObject::onBeforeWrite() for context.

onAfterWrite()

After a workflow item is written, we notify the workflow so that it can take action if needbe

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

onAfterDelete()

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

populateDefaults()

Extend the owner's populateDefaults() logic

See DataObject::populateDefaults() for context.

onAfterBuild()

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

bool|null can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::can()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canEdit(Member $member)

Can only edit content that's NOT in another person's content changeset

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canDelete()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canCreate()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

array extraStatics(string $class = null, string $extension = null)

Define extra database fields

Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

Parameters

string $class

since this method might be called on the class directly

string $extension

since this can help to extract parameters to help set indexes

Return Value

array

Returns a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

updateCMSFields(FieldList $fields)

This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().

Please consider using updateFormFields() to globally add formfields to the record. The method updateCMSFields() should just be used to add or modify tabs, or fields which are specific to the CMS-context.

Caution: Use FieldList->addFieldToTab() to add fields.

Parameters

FieldList $fields

FieldList with a contained TabSet

void updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

Caution: Use CompositeValidator->addValidator() to add Validators.

Parameters

CompositeValidator $compositeValidator

Return Value

void

updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

Caution: Use FieldList->push() to add fields.

Parameters

FieldList $fields

FieldList without TabSet nesting

updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

Parameters

FieldList $actions FieldList

updateSummaryFields(array $fields)

this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']

Parameters

array $fields

Array of field names

updateFieldLabels(array $labels)

this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']

Parameters

array $labels

Array of field labels

setIsPublishJobRunning(bool $truth)

No description

Parameters

bool $truth

bool getIsPublishJobRunning()

No description

Return Value

bool

bool isPublishJobRunning()

No description

Return Value

bool

See also

{@link $this->isPublishJobRunning}

updateSettingsFields(FieldList $fields)

No description

Parameters

FieldList $fields

updateFields(FieldList $fields)

No description

Parameters

FieldList $fields

protected createActionMenu()

No description

Included in CMS-generated email templates for a NotifyUsersWorkflowAction.

Returns an absolute link to the CMS UI for a Page object

Return Value

string|null

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.

Return Value

string

WorkflowInstances()

No description

WorkflowInstance getWorkflowInstance()

Gets the current instance of workflow

Return Value

WorkflowInstance

WorkflowActionInstance>|void getWorkflowHistory($limit = null)

Gets the history of a workflow instance

Parameters

$limit

Return Value

WorkflowActionInstance>|void

WorkflowActionInstance|null RecentWorkflowComment(int $limit = 10)

Check all recent WorkflowActionIntances and return the most recent one with a Comment

Parameters

int $limit

Return Value

WorkflowActionInstance|null

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 canEditWorkflow()

Can a user edit the current workflow attached to this item?

Return Value

bool

$this setWorkflowService(WorkflowService $workflowService)

No description

Parameters

WorkflowService $workflowService

Return Value

$this

WorkflowService getWorkflowService()

No description

Return Value

WorkflowService

WorkflowDefinition WorkflowDefinition()

No description

Return Value

WorkflowDefinition

void ManyManyList() $WorkflowDefinition> AdditionalWorkflowDefinitions()

No description

Parameters

) $WorkflowDefinition> AdditionalWorkflowDefinitions(

Return Value

void