class MessageAccessControlHandler in Message UI 8

Access controller for the comment entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\message_ui\MessageAccessControlHandler

See also

\Drupal\comment\Entity\Comment.

File

src/MessageAccessControlHandler.php, line 15

Namespace

Drupal\message_ui

class MessageAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   *
   * Link the activities to the permissions. checkAccess is called with the
   * $operation as defined in the routing.yml file.
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {

    // Return early if we have bypass or create any template permissions.
    if ($account
      ->hasPermission('bypass message access control') || $account
      ->hasPermission($operation . ' any message template')) {
      return AccessResult::allowed()
        ->cachePerPermissions();
    }
    $params = [
      $entity,
      $operation,
      $account,
    ];

    /** @var \Drupal\Core\Access\AccessResult[] $results */
    $results = $this
      ->moduleHandler()
      ->invokeAll('message_message_ui_access_control', $params);
    foreach ($results as $result) {
      if ($result
        ->isNeutral()) {
        continue;
      }
      return $result;
    }
    return AccessResult::allowedIfHasPermission($account, $operation . ' ' . $entity
      ->bundle() . ' message')
      ->cachePerPermissions();
  }

  /**
   * {@inheritdoc}
   *
   * Separate from the checkAccess because the entity does not yet exist, it
   * will be created during the 'add' process.
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {

    // Return early if we have bypass or create any template permissions.
    if ($account
      ->hasPermission('bypass message access control') || $account
      ->hasPermission('create any message template')) {
      return AccessResult::allowed()
        ->cachePerPermissions();
    }

    /** @var \Drupal\Core\Access\AccessResult[] $results */
    $results = $this
      ->moduleHandler()
      ->invokeAll('message_message_ui_create_access_control', [
      $entity_bundle,
      $account,
    ]);
    foreach ($results as $result) {
      if ($result
        ->isNeutral()) {
        continue;
      }
      return $result;
    }

    // When we have a bundle, check access on that bundle.
    if ($entity_bundle) {
      return AccessResult::allowedIfHasPermission($account, 'create ' . $entity_bundle . ' message')
        ->cachePerPermissions();
    }

    // With no bundle, e.g. on message/add, check access to any message bundle.
    // @todo: perhaps change this method to a service as in NodeAddAccessCheck.
    foreach (\Drupal::entityTypeManager()
      ->getStorage('message_template')
      ->loadMultiple() as $template) {
      $access = AccessResult::allowedIfHasPermission($account, 'create ' . $template
        ->id() . ' message');

      // If access is allowed to any of the existing bundles return allowed.
      if ($access
        ->isAllowed()) {
        return $access
          ->cachePerPermissions();
      }
    }
    return AccessResult::neutral()
      ->cachePerPermissions();
  }

}

Members

Name	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::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	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.
EntityAccessControlHandler::__construct	public	function	Constructs an access control handler instance.	5
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.
MessageAccessControlHandler::checkAccess	protected	function	Link the activities to the permissions. checkAccess is called with the $operation as defined in the routing.yml file. Overrides EntityAccessControlHandler::checkAccess
MessageAccessControlHandler::checkCreateAccess	protected	function	Separate from the checkAccess because the entity does not yet exist, it will be created during the 'add' process. Overrides EntityAccessControlHandler::checkCreateAccess
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.