class GroupCommentAccessControlHandler in Open Social 8.8

Defines the access control handler for the comment entity type.

@todo: Implement setting to make it possible overridden on per-group basis.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\comment\CommentAccessControlHandler
      • class \Drupal\group_core_comments\GroupCommentAccessControlHandler

See also

\Drupal\comment\Entity\Comment

File

modules/custom/group_core_comments/src/GroupCommentAccessControlHandler.php, line 19

Namespace

Drupal\group_core_comments

class GroupCommentAccessControlHandler extends CommentAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {

    /** @var \Drupal\comment\CommentInterface|\Drupal\user\EntityOwnerInterface $entity */
    $parent_access = parent::checkAccess($entity, $operation, $account);
    $commented_entity = $entity
      ->getCommentedEntity();
    if (!$commented_entity instanceof ContentEntityInterface) {
      return AccessResult::neutral();
    }
    $group_contents = GroupContent::loadByEntity($commented_entity);

    // Check for 'delete all comments' permission in case content is not from
    // group.
    if (empty($group_contents) && $account
      ->hasPermission('delete all comments')) {
      $administer_access = AccessResult::allowed();
    }
    else {
      $administer_access = $this
        ->getPermissionInGroups('administer comments', $account, $group_contents);
    }
    if ($administer_access
      ->isAllowed()) {
      $access = AccessResult::allowed()
        ->cachePerPermissions();
      return $operation != 'view' ? $access : $access
        ->andIf($entity
        ->getCommentedEntity()
        ->access($operation, $account, TRUE));
    }

    // @todo: Only react on if $parent === allowed Is this good/safe enough?
    if ($parent_access
      ->isAllowed()) {

      // Only react if it is actually posted inside a group.
      if (!empty($group_contents)) {
        switch ($operation) {
          case 'view':
            return $this
              ->getPermissionInGroups('access comments', $account, $group_contents);
          case 'update':
            return $this
              ->getPermissionInGroups('edit own comments', $account, $group_contents);
          default:

            // No opinion.
            return AccessResult::neutral()
              ->cachePerPermissions();
        }
      }
    }

    // Fallback.
    return $parent_access;
  }

  /**
   * Checks if account was granted permission in group.
   */
  protected function getPermissionInGroups($perm, AccountInterface $account, $group_contents) {

    // Only when you have permission to view the comments.
    foreach ($group_contents as $group_content) {

      /** @var \Drupal\group\Entity\GroupContent $group_content */
      $group = $group_content
        ->getGroup();

      /** @var \Drupal\group\Entity\Group $group */
      if ($group
        ->hasPermission($perm, $account)) {
        return AccessResult::allowed()
          ->cachePerUser();
      }
    }

    // Fallback.
    return AccessResult::forbidden()
      ->cachePerUser();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommentAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
CommentAccessControlHandler::checkFieldAccess	protected	function	Default field access as determined by this access control handler. Overrides EntityAccessControlHandler::checkFieldAccess
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::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.
GroupCommentAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides CommentAccessControlHandler::checkAccess
GroupCommentAccessControlHandler::getPermissionInGroups	protected	function	Checks if account was granted permission in group.
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.