You are here

class LPResultAccessControlHandler in Opigno Learning path 8

Same name and namespace in other branches
  1. 3.x src/LPResultAccessControlHandler.php \Drupal\opigno_learning_path\LPResultAccessControlHandler

Access control handler for the learning_path_result entity.

@package Drupal\opigno_learning_path

Hierarchy

Expanded class hierarchy of LPResultAccessControlHandler

File

src/LPResultAccessControlHandler.php, line 16

Namespace

Drupal\opigno_learning_path
View source
class LPResultAccessControlHandler extends EntityAccessControlHandler {

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

    /** @var \Drupal\opigno_learning_path\Entity\LPResult $entity */

    /** @var \Drupal\group\Entity\Group $group */
    $group = $entity
      ->getLearningPath();
    $is_owner = $entity
      ->getUserId() == $account
      ->id();
    if (empty($group) || !is_object($group)) {
      return AccessResult::neutral();
    }
    if ($group
      ->getGroupType()
      ->id() !== 'learning_path') {
      throw new AccessException('LPResult associated with wrong group type!');
    }
    switch ($operation) {
      case 'view':

        // Allow user to view their own results.
        return AccessResult::allowedIf($is_owner && $group
          ->hasPermission('view own results', $account) || $group
          ->hasPermission('view all results', $account));
      case 'edit':
        return AccessResult::allowedIf($is_owner && $group
          ->hasPermission('edit own results', $account) || $group
          ->hasPermission('edit all results', $account));
      case 'delete':
        return AccessResult::allowedIf($is_owner && $group
          ->hasPermission('delete own results', $account) || $group
          ->hasPermission('delete all results', $account));
    }

    // Unknown operation, return neutral
    // (will be denied if all access control handlers return neutral).
    return AccessResult::neutral();
  }

  /**
   * {@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) {

    // Created only programmatically.
    return AccessResult::neutral();
  }

}

Members

Namesort descending 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.
LPResultAccessControlHandler::checkAccess protected function Entity access control. checkAccess is called with the $operation as defined in the routing.yml file. Overrides EntityAccessControlHandler::checkAccess
LPResultAccessControlHandler::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.