class QueryAccessSubscriber in Entity API 8

Hierarchy

• class \Drupal\entity_module_test\EventSubscriber\QueryAccessSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'QueryAccessSubscriber'

entity_module_test.services.yml in tests/modules/entity_module_test/entity_module_test.services.yml

tests/modules/entity_module_test/entity_module_test.services.yml

1 service uses QueryAccessSubscriber

entity_module_test.query_access_subscriber in tests/modules/entity_module_test/entity_module_test.services.yml

Drupal\entity_module_test\EventSubscriber\QueryAccessSubscriber

File

tests/modules/entity_module_test/src/EventSubscriber/QueryAccessSubscriber.php, line 10

Namespace

Drupal\entity_module_test\EventSubscriber

class QueryAccessSubscriber implements EventSubscriberInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    return [
      'entity.query_access' => 'onGenericQueryAccess',
      'entity.query_access.entity_test_enhanced' => 'onQueryAccess',
      'entity.query_access.node' => 'onEventOnlyQueryAccess',
    ];
  }

  /**
   * Modifies the access conditions based on the entity type.
   *
   * This is just a convenient example for testing the catch-all event. A real
   * subscriber would probably extend the conditions based on the third party
   * settings it set on the entity type(s).
   *
   * @param \Drupal\entity\QueryAccess\QueryAccessEvent $event
   *   The event.
   */
  public function onGenericQueryAccess(QueryAccessEvent $event) {
    $conditions = $event
      ->getConditions();
    $email = $event
      ->getAccount()
      ->getEmail();
    if ($event
      ->getEntityTypeId() == 'entity_test_enhanced_with_owner') {

      // Disallow access to entity_test_enhanced_with_owner for the user with
      // email address [e-mail]. Anyone else has access.
      if ($email == '[e-mail]') {
        $conditions
          ->alwaysFalse();
      }
      elseif ($email == '[e-mail]') {
        $conditions
          ->alwaysFalse(FALSE);
      }
    }
  }

  /**
   * Modifies the access conditions based on the current user.
   *
   * This is just a convenient example for testing. A real subscriber would
   * ignore the account and extend the conditions to cover additional factors,
   * such as a custom entity field.
   *
   * @param \Drupal\entity\QueryAccess\QueryAccessEvent $event
   *   The event.
   */
  public function onQueryAccess(QueryAccessEvent $event) {
    $conditions = $event
      ->getConditions();
    $email = $event
      ->getAccount()
      ->getEmail();
    if ($email == '[e-mail]') {

      // This user should not have access to any entities.
      $conditions
        ->alwaysFalse();
    }
    elseif ($email == '[e-mail]') {

      // This user should have access to entities with the IDs 1, 2, and 3.
      // The query access handler might have already set ->alwaysFalse()
      // due to the user not having any other access, so we make sure
      // to undo it with $conditions->alwaysFalse(TRUE).
      $conditions
        ->alwaysFalse(FALSE);
      $conditions
        ->addCondition('id', [
        '1',
        '2',
        '3',
      ]);
    }
    elseif ($email == '[e-mail]') {

      // This user should only have access to entities assigned to "marketing",
      // or unassigned entities.
      $conditions
        ->alwaysFalse(FALSE);
      $conditions
        ->addCondition((new ConditionGroup('OR'))
        ->addCondition('assigned', NULL, 'IS NULL')
        ->addCondition('assigned.value', 'marketing'));
    }
  }

  /**
   * Modifies the access conditions based on the node type.
   *
   * This is just a convenient example for testing whether the event-only query
   * access subscriber is added to entity types that do not specify a query
   * access handler; in this case: node.
   *
   * @param \Drupal\entity\QueryAccess\QueryAccessEvent $event
   *   The event.
   */
  public function onEventOnlyQueryAccess(QueryAccessEvent $event) {
    if (\Drupal::state()
      ->get('test_event_only_query_access')) {
      $conditions = $event
        ->getConditions();
      $conditions
        ->addCondition('type', 'foo');
      $cacheability = \Drupal::state()
        ->get('event_only_query_acccess_cacheability');
      if ($cacheability instanceof CacheableDependencyInterface) {
        $conditions
          ->addCacheableDependency($cacheability);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
QueryAccessSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
QueryAccessSubscriber::onEventOnlyQueryAccess	public	function	Modifies the access conditions based on the node type.
QueryAccessSubscriber::onGenericQueryAccess	public	function	Modifies the access conditions based on the entity type.
QueryAccessSubscriber::onQueryAccess	public	function	Modifies the access conditions based on the current user.