class AdvancedWorkflowExtension extends Extension (View source)

Handles interactions triggered by users in the backend of the CMS. Replicate this type of functionality wherever you need UI interaction with workflow.

Properties

protected T $owner

The object this extension is applied to.

from  Extension

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
string|null
startworkflow(array $data, Form $form, HTTPRequest $request)

No description

public
updateEditForm(Form $form)

Need to update the edit form AFTER it's been transformed to read only so that the workflow stuff is still allowed to be added with 'write' permissions

public
updateItemEditForm(Form $form)

No description

public
string|null
updateworkflow(array $data, Form $form, HTTPRequest $request)

Update a workflow based on user input.

protected
returnResponse($form)

No description

protected
void
saveAsDraftWithAction(Form $form, DataObject $item)

Ocassionally users forget to apply their changes via the standard CMS "Save Draft" button, and select the action button instead - losing their changes.

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

string|null startworkflow(array $data, Form $form, HTTPRequest $request)

No description

Parameters

array $data
Form $form
HTTPRequest $request

Return Value

string|null

updateEditForm(Form $form)

Need to update the edit form AFTER it's been transformed to read only so that the workflow stuff is still allowed to be added with 'write' permissions

Parameters

Form $form

updateItemEditForm(Form $form)

No description

Parameters

Form $form

string|null updateworkflow(array $data, Form $form, HTTPRequest $request)

Update a workflow based on user input.

refactor with WorkflowInstance::updateWorkflow

Parameters

array $data
Form $form
HTTPRequest $request

Return Value

string|null

protected returnResponse($form)

No description

Parameters

$form

protected void saveAsDraftWithAction(Form $form, DataObject $item)

Ocassionally users forget to apply their changes via the standard CMS "Save Draft" button, and select the action button instead - losing their changes.

Calling this from a controller method saves a draft automatically for the user, whenever a workflow action is run See: #72 and #77

Parameters

Form $form
DataObject $item

Return Value

void