[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Workflow/ -> Workflow.php (summary)

Joomla! Content Management System

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

Defines 1 class

Workflow:: (10 methods):
  __construct()
  getConditionName()
  getComponent()
  getDefaultStageByCategory()
  getValidTransition()
  executeTransition()
  createAssociation()
  updateAssociations()
  deleteAssociation()
  getAssociation()


Class: Workflow  - X-Ref

Workflow Class.

__construct(string $extension, ?CMSApplication $app = null, ?DatabaseDriver $db = null)   X-Ref
Class constructor

param: string           $extension  The extension name
param: ?CMSApplication  $app        Application Object
param: ?DatabaseDriver  $db         Database Driver Object

getConditionName(int $value)   X-Ref
Returns the translated condition name, based on the given number

param: integer  $value  The condition ID
return: string

getComponent()   X-Ref
Returns the booted component

return: ComponentInterface

getDefaultStageByCategory($catId = 0)   X-Ref
Try to load a workflow default stage by category ID.

param: integer   $catId  The category ID.
return: boolean|integer  An integer, holding the stage ID or false

getValidTransition(array $pks, int $transitionId)   X-Ref
Check if a transition can be executed

param: integer[]  $pks           The item IDs, which should use the transition
param: integer    $transitionId  The transition which should be executed
return: object | null

executeTransition(array $pks, int $transitionId)   X-Ref
Executes a transition to change the current state in the association table

param: integer[]  $pks           The item IDs, which should use the transition
param: integer    $transitionId  The transition which should be executed
return: boolean

createAssociation(int $pk, int $state)   X-Ref
Creates an association for the workflow_associations table

param: integer  $pk     ID of the item
param: integer  $state  ID of state
return: boolean

updateAssociations(array $pks, int $state)   X-Ref
Update an existing association with a new state

param: array    $pks    An Array of item IDs which should be changed
param: integer  $state  The new state ID
return: boolean

deleteAssociation(array $pks)   X-Ref
Removes associations from the workflow_associations table

param: integer[]  $pks  ID of content
return: boolean

getAssociation(int $itemId)   X-Ref
Loads an existing association item with state and item ID

param: integer  $itemId  The item ID to load
return: \stdClass|null



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