WorkflowPluginTrait

Trait for component workflow plugins.

since

4.0.0

Methods

checkAllowedAndForbiddenlist

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

checkAllowedAndForbiddenlist(string $context) : boolean

Arguments

$context

stringContext to check

Response

boolean

checkExtensionSupport

Check if the context supports a specific functionality.

checkExtensionSupport(string $context, string $functionality) : boolean

Arguments

$context

stringContext to check

$functionality

stringThe functionality

Response

boolean

enhanceWorkflowTransitionForm

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

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

4.0.0

Arguments

$form

\Joomla\CMS\Form\FormThe form

$data

\stdClassThe data

Response

boolean

getWorkflow

Get the workflow for a given ID

getWorkflow(integer|null $workflowId = null) : \Joomla\CMS\Object\CMSObject|boolean
since

4.0.0

Arguments

$workflowId

integer|nullID of the workflow

Response

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

isSupported

Check if the current plugin should execute workflow related activities

isSupported(string $context) : boolean
since

4.0.0

Arguments

$context

stringContext to check

Response

boolean