WorkflowPluginTrait

Trait for component workflow plugins.

since

4.0.0

package

Joomla CMS

Methods

checkAllowedAndForbiddenlist

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

checkAllowedAndForbiddenlist( context) : 

Arguments

context

stringContext to check

Response

bool

checkExtensionSupport

Check if the context supports a specific functionality.

checkExtensionSupport( context,  functionality) : 

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|\stdClass
since

4.0.0

Arguments

form

FormThe form

data

stdClassThe data

Response

bool|stdClass

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

CMSObject|boolObject on success, false on failure.

isSupported

Check if the current plugin should execute workflow related activities

isSupported( context) : 
since

4.0.0

Arguments

context

stringContext to check

Response

bool