You are here

class WeatherAccessControlHandler in Weather 2.0.x

Same name and namespace in other branches
  1. 8 src/WeatherAccessControlHandler.php \Drupal\weather\WeatherAccessControlHandler

Access controller for weather entities.

Hierarchy

Expanded class hierarchy of WeatherAccessControlHandler

File

src/WeatherAccessControlHandler.php, line 14

Namespace

Drupal\weather
View source
class WeatherAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    return $this
      ->commonAccessCheck($account, $entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return $this
      ->commonAccessCheck($account);
  }

  /**
   * For all weather entities we do the same access check.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user for which to check access.
   * @param \Drupal\Core\Entity\EntityInterface|null $entity
   *   Entity interface.
   *
   * @return \Drupal\Core\Access\AccessResult|\Drupal\Core\Access\AccessResultAllowed|\Drupal\Core\Access\AccessResultNeutral
   *   Access result,
   */
  protected function commonAccessCheck(AccountInterface $account, EntityInterface $entity = NULL) {

    // Allow everything for administrators.
    if ($account
      ->hasPermission('administer site configuration')) {
      return AccessResult::allowed();
    }

    // If user can administer own weather block - allow only some entities.
    $entityTypesAllowed = [
      'weather_display',
      'weather_display_place',
    ];
    if ($account
      ->hasPermission('administer custom weather block') && in_array($this->entityTypeId, $entityTypesAllowed)) {

      // In case we updating entity.
      if ($entity instanceof EntityInterface) {
        $typeFieldName = $this->entityTypeId == 'weather_display' ? 'type' : 'display_type';
        $ownerFieldName = $this->entityTypeId == 'weather_display' ? 'number' : 'display_number';
        $type = $entity->{$typeFieldName}->value;
        $owner = $entity->{$ownerFieldName}->value;
        return AccessResult::allowedIf($type == WeatherDisplayInterface::USER_TYPE && $owner == $account
          ->id());
      }
      return AccessResult::allowed();
    }
    return AccessResult::neutral();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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. 6
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. 4
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.
WeatherAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
WeatherAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
WeatherAccessControlHandler::commonAccessCheck protected function For all weather entities we do the same access check.