class UserHasEntityFieldAccess

Provides a 'User has entity field access' condition.

@todo Add access callback information from Drupal 7.

Plugin annotation


@Condition(
  id = "rules_entity_field_access",
  label = @Translation("User has entity field access"),
  category = @Translation("User"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user",
      label = @Translation("User"),
      description = @Translation("Specifies the user account for which to check access. If left empty, the currently logged in user will be used."),
      assignment_restriction = "selector",
      required = FALSE
    ),
    "entity" = @ContextDefinition("entity",
      label = @Translation("Entity"),
      description = @Translation("Specifies the entity for which to evaluate the condition."),
      assignment_restriction = "selector"
    ),
    "field" = @ContextDefinition("string",
      label = @Translation("Field"),
      description = @Translation("The name of the field to check for."),
      assignment_restriction = "input",
      options_provider = "\Drupal\rules\TypedData\Options\FieldListOptions"
    ),
    "operation" = @ContextDefinition("string",
      label = @Translation("Access operation"),
      description = @Translation("The access type to check."),
      assignment_restriction = "input",
      default_value = "view",
      required = FALSE,
      options_provider = "\Drupal\rules\TypedData\Options\ViewEditOptions"
    ),
  }
)

Hierarchy

Expanded class hierarchy of UserHasEntityFieldAccess

File

src/Plugin/Condition/UserHasEntityFieldAccess.php, line 50

Namespace

Drupal\rules\Plugin\Condition
View source 
class UserHasEntityFieldAccess extends RulesConditionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a UserHasEntityFieldAccess object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity_type.manager service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'));
    }
    
    /**
     * Evaluate if the user has access to the field of an entity.
     *
     * @param \Drupal\Core\Session\AccountInterface $user
     *   The user account to test access against.
     * @param \Drupal\Core\Entity\ContentEntityInterface $entity
     *   The entity to check access on.
     * @param string $field
     *   The name of the field to check access on.
     * @param string $operation
     *   The operation access should be checked for. Usually one of "view" or
     *   "edit".
     *
     * @return bool
     *   TRUE if the user has access to the field on the entity, FALSE otherwise.
     */
    protected function doEvaluate(AccountInterface $user, ContentEntityInterface $entity, $field, $operation) {
        if (!$entity->hasField($field)) {
            return FALSE;
        }
        $access = $this->entityTypeManager
            ->getAccessControlHandler($entity->getEntityTypeId());
        if (!$access->access($entity, $operation, $user)) {
            return FALSE;
        }
        $definition = $entity->getFieldDefinition($field);
        $items = $entity->get($field);
        return $access->fieldAccess($operation, $definition, $user, $items);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 6
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 6
ConditionPluginBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager public function Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 6
ConditionPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
ContextProviderTrait::$providedContext protected property The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext public function
ContextProviderTrait::getProvidedContextDefinition public function
ContextProviderTrait::getProvidedContextDefinitions public function
ContextProviderTrait::setProvidedValue public function
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
ExecutablePluginBase::getConfig public function Gets all configuration values.
ExecutablePluginBase::getConfigDefinition public function Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions public function Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig public function Sets the value of a particular configuration option.
ExecutablePluginTrait::getLabelValue protected function Get the translated label from the plugin definition.
ExecutablePluginTrait::summary public function Get the translated summary from the label annotation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesConditionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata 1
RulesConditionBase::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate 5
RulesConditionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginTrait::getContextValue
RulesConditionBase::negate public function Negates the result after evaluating this condition. Overrides RulesConditionInterface::negate
RulesConditionBase::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions 1
UserHasEntityFieldAccess::$entityTypeManager protected property The entity type manager.
UserHasEntityFieldAccess::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserHasEntityFieldAccess::doEvaluate protected function Evaluate if the user has access to the field of an entity.
UserHasEntityFieldAccess::__construct public function Constructs a UserHasEntityFieldAccess object. Overrides ConditionPluginBase::__construct