class WorkflowStateTransitionOperationsAccessCheck implements AccessInterface (View source)

Provides an access check for state and transition operations.

Methods

access(RouteMatchInterface $route_match, AccountInterface $account)

Checks access for operations of workflow states and transitions.

string
getOperation(RouteMatchInterface $route_match)

Get the operation that will be used for the access check.

Details

AccessResultInterface access(RouteMatchInterface $route_match, AccountInterface $account)

Checks access for operations of workflow states and transitions.

The value of '_workflow_access' is used to check to kind of access that should be applied to a route in the context of a workflow and a state or transition. States and transitions can individually have access control applied to them for 'add', 'update' and 'delete'. By default workflows will use the admin permission 'administer workflows' for all of these operations, except for delete-state which checks there is at least one state, a state does not have data and it's not a required state.

For the update and delete operations, a workflow and a state or transition is required in the route for the access check to be applied. For the "add" operation, only a workflow is required. The '_workflow_access' requirement translates into access checks on the workflow entity type in the formats:

  • @code"$operation-state:$state_id"@endcode
  • @code"$operation-transition:$transition_id"@endcode

For example the following route definition with the path "/test-workflow/foo-state/delete" the 'delete-state:foo-state' operation will be checked:

Parameters

RouteMatchInterface $route_match

The parametrized route

AccountInterface $account

The currently logged in account.

Return Value

AccessResultInterface

An access result.

Exceptions

Exception

protected string getOperation(RouteMatchInterface $route_match)

Get the operation that will be used for the access check.

Parameters

RouteMatchInterface $route_match

The parametrized route

Return Value

string

The access operation.