PHP Class Pimcore\WorkflowManagement\Workflow\Manager

Datei anzeigen Open project: pimcore/pimcore Class Usage Examples

Protected Properties

Property	Type	Description
$actionData		The data submitted when an action is performed
$element	Pimcore\Model\Object\Concrete \| Pimcore\Model\Document \| Pimcore\Model\Asset	The element for this workflow
$error	mixed	Any errors within the workflow will be stored here
$registeredActionEvents	array	An array of the event triggers that are registered with an action
$user	Pimcore\Model\User	The user using the workflow All actions will be recorded against this user
$userIds	array	An array of the different pimcore user ids that the current user is related to - first in array is the users id, - any additional are the role ids that have been assigned to the user
$workflow	Pimcore\WorkflowManagement\Workflow	The loaded workflow

Public Methods

Method	Description
__construct ( $element, null $user = null )
actionHasTransition ( $actionConfig )
elementCanAction ( $element ) : boolean	Returns whether or not an element can be actioned
elementHasWorkflow ( AbstractElement $element ) : boolean	Returns whether or not an element has a workflow
getActionData ( )
getAdditionalFieldsForAction ( $actionName ) : array \| mixed	Shortcut method - probably should clean this up a bit more
getAvailableActions ( ) : mixed	Get the available actions that can be performed on an element
getAvailableStates ( $actionName ) : array	Returns the available state configurations given an action NOTE: ASSUMES THE ACTION EXISTS
getAvailableStatuses ( $actionName, $stateName ) : array	Returns the available statuses given an action and a state
getElement ( )
getElementState ( ) : string	Return the element state
getElementStatus ( )	Returns the current status of an object
getError ( )
getNotesRequiredForAction ( string $actionName ) : boolean	Returns whether or not notes are required for a given action on the current object Assumes the action is valid at that point in time
getObjectLayout ( ) : string \| null	Returns the objects layout configuration given the current place in the workflow If no layout is specified then null will be returned
getUser ( )
getWorkflow ( ) : Pimcore\WorkflowManagement\Workflow
getWorkflowStateForElement ( ) : null \| WorkflowState
performAction ( mixed $actionName, array $formData = [] )	Performs an action
setActionData ( $data )
setElementState ( $newState )
setElementStatus ( $newStatus )
userCanPerformAction ( $actionName, null $statusName = null ) : boolean	Returns whether or not a user can perform an action if a status is given then it will be taken into consideration
validateAction ( $actionName, $newState, $newStatus ) : boolean	Validates that a transition between requested states can be done on an element NOTE: DOES NOT VALIDATE FIELDS @see performAction

Private Methods

Method	Description
initUserIds ( )
initWorkflow ( )	Loads the workflow into the manager
registerActionEvents ( $actionConfig )	Used by performAction to initialise events
unregisterActionEvents ( )	Unregisters events (before, success, failure)

Method Details

__construct() public method

public __construct ( $element, null $user = null )
$element
$user	null	- optional parameter so that importers can use some functions of manager too.

actionHasTransition() public method

public actionHasTransition ( $actionConfig )

elementCanAction() public static method

Returns whether or not an element can be actioned

public static elementCanAction ( $element ) : boolean
$element
return	boolean

elementHasWorkflow() public static method

Returns whether or not an element has a workflow

public static elementHasWorkflow ( AbstractElement $element ) : boolean
$element	Pimcore\Model\Element\AbstractElement
return	boolean

getActionData() public method

public getActionData ( )

getAdditionalFieldsForAction() public method

Shortcut method - probably should clean this up a bit more

public getAdditionalFieldsForAction ( $actionName ) : array \| mixed
$actionName
return	array \| mixed

getAvailableActions() public method

Get the available actions that can be performed on an element

public getAvailableActions ( ) : mixed
return	mixed

getAvailableStates() public method

Returns the available state configurations given an action NOTE: ASSUMES THE ACTION EXISTS

getAvailableStatuses() public method

Returns the available statuses given an action and a state

public getAvailableStatuses ( $actionName, $stateName ) : array
$actionName
$stateName
return	array

getElement() public method

public getElement ( )

getElementState() public method

Return the element state

public getElementState ( ) : string
return	string

getElementStatus() public method

Returns the current status of an object

public getElementStatus ( )

getError() public method

public getError ( )

getNotesRequiredForAction() public method

Returns whether or not notes are required for a given action on the current object Assumes the action is valid at that point in time

public getNotesRequiredForAction ( string $actionName ) : boolean
$actionName	string
return	boolean

getObjectLayout() public method

Returns the objects layout configuration given the current place in the workflow If no layout is specified then null will be returned

public getObjectLayout ( ) : string \| null
return	string \| null

getUser() public method

public getUser ( )

getWorkflow() public method

public getWorkflow ( ) : Pimcore\WorkflowManagement\Workflow
return	Pimcore\WorkflowManagement\Workflow

getWorkflowStateForElement() public method

public getWorkflowStateForElement ( ) : null \| WorkflowState
return	null \| Pimcore\Model\Element\WorkflowState

performAction() public method

Performs an action

public performAction ( mixed $actionName, array $formData = [] )
$actionName	mixed
$formData	array

setActionData() public method

public setActionData ( $data )

setElementState() public method

public setElementState ( $newState )

setElementStatus() public method

public setElementStatus ( $newStatus )

userCanPerformAction() public method

Returns whether or not a user can perform an action if a status is given then it will be taken into consideration

public userCanPerformAction ( $actionName, null $statusName = null ) : boolean
$actionName
$statusName	null
return	boolean

validateAction() public method

Validates that a transition between requested states can be done on an element NOTE: DOES NOT VALIDATE FIELDS @see performAction

public validateAction ( $actionName, $newState, $newStatus ) : boolean
$actionName
$newState
$newStatus
return	boolean

Property Details

$actionData protected_oe property

The data submitted when an action is performed

protected $actionData

$element protected_oe property

The element for this workflow

protected Concrete,Pimcore\Model\Object\|Document,Pimcore\Model\|Asset,Pimcore\Model $element
return	Pimcore\Model\Object\Concrete \| Pimcore\Model\Document \| Pimcore\Model\Asset

$error protected_oe property

Any errors within the workflow will be stored here

protected mixed $error
return	mixed

$registeredActionEvents protected_oe property

An array of the event triggers that are registered with an action

protected array $registeredActionEvents
return	array

$user protected_oe property

The user using the workflow All actions will be recorded against this user

protected User,Pimcore\Model $user
return	Pimcore\Model\User

$userIds protected_oe property

An array of the different pimcore user ids that the current user is related to - first in array is the users id, - any additional are the role ids that have been assigned to the user

protected array $userIds
return	array

$workflow protected_oe property

The loaded workflow

protected Workflow,Pimcore\WorkflowManagement $workflow
return	Pimcore\WorkflowManagement\Workflow

public getAvailableStates ( $actionName ) : array
$actionName
return	array