Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class WorkflowPluginTrait - list of methods

Trait for component workflow plugins.
Package: Joomla\CMS\Workflow
Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
Located at: Joomla/Workflow/WorkflowPluginTrait.php
Project: Joomla

Method Summary

protected bool
(\Joomla\CMS\Form\Form $form, mixed $data)

Add different parameter options to the transition view, we need when executing the transition
Parameters
  • \Joomla\CMS\Form\Form $form The form
  • \stdClass $data The data
Returns
  • bool
Since
  • 4.0.0
Show source code of this method: enhanceWorkflowTransitionForm Source Code

protected \Joomla\CMS\Object\CMSObject|bool
(int $workflowId = null)

Get the workflow for a given ID
Parameters
  • int|null $workflowId ID of the workflow
Returns
  • \Joomla\CMS\Object\CMSObject|bool Object on success, false on failure.
Since
  • 4.0.0
Show source code of this method: getWorkflow Source Code

protected bool
(mixed $context)

Check if the current plugin should execute workflow related activities
Parameters
  • string $context Context to check
Returns
  • bool
Since
  • 4.0.0
Show source code of this method: isSupported Source Code

protected bool
(mixed $context)

Check if the context is listed in the allowed of forbidden lists and return the result.
Parameters
  • string $context Context to check
Returns
  • bool
Show source code of this method: checkAllowedAndForbiddenlist Source Code

protected bool
(mixed $context, mixed $functionality)

Check if the context supports a specific functionality.
Parameters
  • string $context Context to check
  • string $functionality The functionality
Returns
  • bool
Show source code of this method: checkExtensionSupport Source Code

Tags Summary

Since
4.0.0