[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/MVC/Model/ -> WorkflowBehaviorTrait.php (summary)

Joomla! Content Management System

Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 411 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 12 functions

  setUpWorkflow()
  enableWorkflowBatch()
  workflowPreprocessForm()
  workflowBeforeStageChange()
  workflowBeforeSave()
  workflowAfterSave()
  batchWorkflowStage()
  workflowCleanupBatchMove()
  executeTransition()
  importWorkflowPlugins()
  addTransitionField()
  getStageForNewItem()

Functions
Functions that are not part of a class:

setUpWorkflow($extension)   X-Ref
Set Up the workflow

param: string  $extension  The option and section separated by.
return: void

enableWorkflowBatch()   X-Ref
Add the workflow batch to the command list. Can be overwritten bei the child class

return: void

workflowPreprocessForm(Form $form, $data)   X-Ref
Method to allow derived classes to preprocess the form.

param: Form   $form  A Form object.
param: mixed  $data  The data expected for the form.
return: void

workflowBeforeStageChange()   X-Ref
Let plugins access stage change events

return: void

workflowBeforeSave()   X-Ref
Preparation of workflow data/plugins

return: void

workflowAfterSave($data)   X-Ref
Executing of relevant workflow methods

return: void

batchWorkflowStage(int $value, array $pks, array $contexts)   X-Ref
Batch change workflow stage or current.

param: integer  $value     The workflow stage ID.
param: array    $pks       An array of row IDs.
param: array    $contexts  An array of item contexts.
return: mixed  An array of new IDs on success, boolean false on failure.

workflowCleanupBatchMove($oldId, $newId)   X-Ref
Batch change workflow stage or current.

param: integer  $oldId     The ID of the item copied from
param: integer  $newId     The ID of the new item
return: null

executeTransition(array $pks, int $transitionId)   X-Ref
Runs transition for item.

param: array    $pks           Id of items to execute the transition
param: integer  $transitionId  Id of transition
return: boolean

importWorkflowPlugins()   X-Ref
Import the Workflow plugins.

param: Form   $form  A Form object.
param: mixed  $data  The data expected for the form.
return: void

addTransitionField(Form $form, $data)   X-Ref
Adds a transition field to the form. Can be overwritten by the child class if not needed

param: Form   $form  A Form object.
param: mixed  $data  The data expected for the form.
return: void

getStageForNewItem(Form $form, $data)   X-Ref
Try to load a workflow stage for newly created items
which does not have a workflow assigned yet. If the category is not the
carrier, overwrite it on your model and deliver your own carrier.

param: Form   $form  A Form object.
param: mixed  $data  The data expected for the form.
return: boolean|integer  An integer, holding the stage ID or false



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer