class WorkflowAccessControlHandler

Same name in other branches
  1. 9 core/modules/workflows/src/WorkflowAccessControlHandler.php \Drupal\workflows\WorkflowAccessControlHandler
  2. 8.9.x core/modules/workflows/src/WorkflowAccessControlHandler.php \Drupal\workflows\WorkflowAccessControlHandler
  3. 10 core/modules/workflows/src/WorkflowAccessControlHandler.php \Drupal\workflows\WorkflowAccessControlHandler

Access controller for the Workflow entity.

Hierarchy

Expanded class hierarchy of WorkflowAccessControlHandler

See also

\Drupal\workflows\Entity\Workflow.

File

core/modules/workflows/src/WorkflowAccessControlHandler.php, line 19

Namespace

Drupal\workflows
View source
class WorkflowAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {
    
    /**
     * The workflow type plugin manager.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $workflowTypeManager;
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('plugin.manager.workflows.type'));
    }
    
    /**
     * Constructs the workflow access control handler instance.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Component\Plugin\PluginManagerInterface $workflow_type_manager
     *   The workflow type plugin manager.
     */
    public function __construct(EntityTypeInterface $entity_type, PluginManagerInterface $workflow_type_manager) {
        parent::__construct($entity_type);
        $this->workflowTypeManager = $workflow_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        
        /** @var \Drupal\workflows\Entity\Workflow $entity */
        $workflow_type = $entity->getTypePlugin();
        if (str_starts_with($operation, 'delete-state')) {
            [
                ,
                $state_id,
            ] = explode(':', $operation, 2);
            // Deleting a state is editing a workflow, but also we should forbid
            // access if there is only one state.
            return AccessResult::allowedIf(count($entity->getTypePlugin()
                ->getStates()) > 1)
                ->andIf(parent::checkAccess($entity, 'edit', $account))
                ->andIf(AccessResult::allowedIf(!in_array($state_id, $workflow_type->getRequiredStates(), TRUE)))
                ->addCacheableDependency($entity);
        }
        return parent::checkAccess($entity, $operation, $account);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
        $workflow_types_count = count($this->workflowTypeManager
            ->getDefinitions());
        $admin_access = parent::checkCreateAccess($account, $context, $entity_bundle);
        // Allow access if there is at least one workflow type. Since workflow types
        // are provided by modules this is cacheable until extensions change.
        return $admin_access->andIf(AccessResult::allowedIf($workflow_types_count > 0));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
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. 7
EntityAccessControlHandler::access public function Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandlerInterface::access 1
EntityAccessControlHandler::checkFieldAccess protected function Default field access as determined by this access control handler. 4
EntityAccessControlHandler::createAccess public function Checks access to create an entity. Overrides EntityAccessControlHandlerInterface::createAccess 1
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 Determines entity access.
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. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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::$workflowTypeManager protected property The workflow type plugin manager.
WorkflowAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
WorkflowAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
WorkflowAccessControlHandler::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
WorkflowAccessControlHandler::__construct public function Constructs the workflow access control handler instance. Overrides EntityAccessControlHandler::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.