You are here

Home » API reference » Workflow 8 » WorkflowAccessControlHandler.php

class WorkflowAccessControlHandler in Workflow 8

Defines the access control handler for the workflow entity type.

Hierarchy

Expanded class hierarchy of WorkflowAccessControlHandler

See also

\Drupal\workflow\Entity\Workflow

1 file declares its use of WorkflowAccessControlHandler
workflow.entity.inc in ./workflow.entity.inc
Implements entity hooks.

File

src/WorkflowAccessControlHandler.php, line 20

Namespace

Drupal\workflow
View source 
class WorkflowAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {

  /**
   * This is a hack.
   *
   * {@inheritdoc}
   */
  public function __construct(EntityTypeInterface $entity_type = NULL) {
    $this->entityType = $entity_type;
    if ($entity_type) {
      parent::__construct($entity_type);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type);
  }

  /**
   * {@inheritdoc}
   */
  public function access(EntityInterface $entity, $operation, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $account = workflow_current_user($account);
    $result = parent::access($entity, $operation, $account, TRUE);

    // Only for Edit/Delete transition. For Add/create, use createAccess.
    switch ($entity
      ->getEntityTypeId()) {
      case 'workflow_scheduled_transition':
        switch ($operation) {
          case 'update':

            // This operation is not defined for Scheduled Transitions.
            $result = AccessResult::forbidden();
            break;
          case 'delete':

            // This operation is not defined for Scheduled Transitions.
            $result = AccessResult::forbidden();
            break;
          case 'revert':

            // This operation is not defined for Scheduled Transitions.
            $result = AccessResult::forbidden();
            break;
          default:
            $result = parent::access($entity, $operation, $account, TRUE);
            break;
        }
        break;
      case 'workflow_transition':

        /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $transition */
        $transition = $entity;
        $is_owner = WorkflowManager::isOwner($account, $transition);
        $type_id = $transition
          ->getWorkflowId();
        switch ($operation) {
          case 'update':
            if ($account
              ->hasPermission("bypass {$type_id} workflow_transition access")) {
              $result = AccessResult::allowed()
                ->cachePerPermissions();
            }
            elseif ($account
              ->hasPermission("edit any {$type_id} workflow_transition")) {
              $result = AccessResult::allowed()
                ->cachePerPermissions();
            }
            elseif ($is_owner && $account
              ->hasPermission("edit own {$type_id} workflow_transition")) {
              $result = AccessResult::allowed()
                ->cachePerPermissions();
            }
            return $return_as_object ? $result : $result
              ->isAllowed();
          case 'delete':

            // The delete operation is not defined for Transitions.
            $result = AccessResult::forbidden();
            break;
          case 'revert':
            if (!$transition
              ->isRevertable()) {

              // No access for same state transitions.
              $result = AccessResult::forbidden();
            }
            elseif ($account
              ->hasPermission("revert any {$type_id} workflow_transition")) {

              // OK, add operation.
              $result = AccessResult::allowed();
            }
            elseif ($is_owner && $account
              ->hasPermission("revert own {$type_id} workflow_transition")) {

              // OK, add operation.
              $result = AccessResult::allowed();
            }
            else {

              // No access.
              $result = AccessResult::forbidden();
            }
            if ($result == AccessResult::allowed()) {

              // Ask other modules if the reversion is allowed.
              // Reversing old and new sid!
              $permitted = \Drupal::moduleHandler()
                ->invokeAll('workflow', [
                'transition revert',
                $transition,
                $account,
              ]);

              // Remove access if it is vetoed by other module.
              if (in_array(FALSE, $permitted, TRUE)) {
                $result = AccessResult::forbidden();
              }
            }
            break;
          default:
            $result = parent::access($entity, $operation, $account, TRUE);
            break;
        }
        break;
      case 'workflow_config_transition':

        // This is not (yet) configured.
        break;
      case 'workflow_state':
        switch ($operation) {
          case 'view label':

            // The following two lines are copied from below, and need to be reviewed carefully.
            $result = AccessResult::allowed();
            return $return_as_object ? $result : $result
              ->isAllowed();
          default:

            // E.g., operation 'update' on the WorkflowStates config page.
            break;
        }
        break;
    }
    $result = $result
      ->cachePerPermissions();
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function createAccess($entity_bundle = NULL, AccountInterface $account = NULL, array $context = [], $return_as_object = FALSE) {
    workflow_debug(__FILE__, __FUNCTION__, __LINE__);

    // @todo D8: test this snippet.

    /** @var \Drupal\Core\Access\AccessResult $result */
    $result = parent::createAccess($entity_bundle, $account, $context, TRUE);
    $result = $result
      ->cachePerPermissions();
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    workflow_debug(__FILE__, __FUNCTION__, __LINE__);

    // @todo D8: test this snippet.
    return AccessResult::allowedIf($account
      ->hasPermission('create ' . $entity_bundle . ' content'))
      ->cachePerPermissions();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityAccessControlHandler::$accessCache protected property Stores calculated access check results.
EntityAccessControlHandler::$entityType protected property Information about the entity type.
EntityAccessControlHandler::$entityTypeId protected property The entity type ID of the access control handler instance.
EntityAccessControlHandler::$viewLabelOperation protected property Allows to grant access to just the labels. 5
EntityAccessControlHandler::checkAccess protected function Performs access checks. 33
EntityAccessControlHandler::checkFieldAccess protected function Default field access as determined by this access control handler. 4
EntityAccessControlHandler::fieldAccess public function Checks access to an operation on a given entity field. Overrides EntityAccessControlHandlerInterface::fieldAccess
EntityAccessControlHandler::getCache protected function Tries to retrieve a previously cached access value from the static cache.
EntityAccessControlHandler::prepareUser protected function Loads the current account object, if it does not exist yet.
EntityAccessControlHandler::processAccessHookResults protected function We grant access to the entity if both of these conditions are met:
EntityAccessControlHandler::resetCache public function Clears all cached access checks. Overrides EntityAccessControlHandlerInterface::resetCache
EntityAccessControlHandler::setCache protected function Statically caches whether the given user has access.
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WorkflowAccessControlHandler::access public function Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandler::access
WorkflowAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
WorkflowAccessControlHandler::createAccess public function Checks access to create an entity. Overrides EntityAccessControlHandler::createAccess
WorkflowAccessControlHandler::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
WorkflowAccessControlHandler::__construct public function This is a hack. Overrides EntityAccessControlHandler::__construct