WorkflowPluginTrait

Trait for component workflow plugins.

since

4.0.0

package

Application

Methods

checkAllowedAndForbiddenlist

Check if the context is listed in the allowed of forbidden lists and return the result.

checkAllowedAndForbiddenlist(string context) : bool

Arguments

context

stringContext to check

Response

bool

checkExtensionSupport

Check if the context supports a specific functionality.

checkExtensionSupport(string context, string functionality) : bool

Arguments

context

stringContext to check

functionality

stringThe functionality

Response

bool

enhanceWorkflowTransitionForm

Add different parameter options to the transition view, we need when executing the transition

enhanceWorkflowTransitionForm(\Joomla\CMS\Form\Form form, \stdClass data) : bool
since

4.0.0

Arguments

form

\Joomla\CMS\Form\FormThe form

data

\stdClassThe data

Response

bool

getWorkflow

Get the workflow for a given ID

getWorkflow(int|null workflowId = null) : \Joomla\CMS\Object\CMSObject|bool
since

4.0.0

Arguments

workflowId

int|nullID of the workflow

Response

\Joomla\CMS\Object\CMSObject|boolObject on success, false on failure.

isSupported

Check if the current plugin should execute workflow related activities

isSupported(string context) : bool
since

4.0.0

Arguments

context

stringContext to check

Response

bool