class OrderAccessControlHandler in Ubercart 8.4

Defines the access control handler for Ubercart orders.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\uc_order\OrderAccessControlHandler

File

uc_order/src/OrderAccessControlHandler.php, line 13

Namespace

Drupal\uc_order

class OrderAccessControlHandler extends EntityAccessControlHandler {

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

    /** @var \Drupal\uc_order\OrderInterface $order */
    switch ($operation) {
      case 'view':
      case 'invoice':

        // Admins can view all orders.
        if ($account
          ->hasPermission('view all orders')) {
          return AccessResult::allowed()
            ->cachePerPermissions();
        }

        // Non-anonymous users can view their own orders
        // and invoices with permission.
        $permission = $operation == 'view' ? 'view own orders' : 'view own invoices';
        if ($account
          ->id() && $account
          ->id() == $order
          ->getOwnerId() && $account
          ->hasPermission($permission)) {
          return AccessResult::allowed()
            ->cachePerPermissions()
            ->cachePerUser()
            ->cacheUntilEntityChanges($order);
        }
        return AccessResult::forbidden()
          ->cachePerPermissions()
          ->cachePerUser()
          ->cacheUntilEntityChanges($order);
      case 'update':
        return AccessResult::allowedIfHasPermission($account, 'edit orders')
          ->cachePerPermissions()
          ->cachePerUser();
      case 'delete':
        if ($account
          ->hasPermission('unconditionally delete orders')) {

          // Unconditional deletion perms are always TRUE.
          return AccessResult::allowed()
            ->cachePerPermissions()
            ->cachePerUser();
        }
        if ($account
          ->hasPermission('delete orders')) {

          // Only users with unconditional deletion perms
          // can delete completed orders.
          if ($order
            ->getStateId() == 'completed') {
            return AccessResult::forbidden()
              ->cachePerPermissions()
              ->cachePerUser()
              ->cacheUntilEntityChanges($order);
          }
          else {

            // See if any modules have a say in this order's
            // eligibility for deletion.
            $module_handler = \Drupal::moduleHandler();
            foreach ($module_handler
              ->getImplementations('uc_order_can_delete') as $module) {
              $function = $module . '_uc_order_can_delete';
              if ($function($order) === FALSE) {
                return AccessResult::forbidden()
                  ->cachePerPermissions()
                  ->cachePerUser()
                  ->cacheUntilEntityChanges($order);
              }
            }
            return AccessResult::allowed()
              ->cachePerPermissions()
              ->cachePerUser()
              ->cacheUntilEntityChanges($order);
          }
        }
        return AccessResult::forbidden()
          ->cachePerPermissions()
          ->cachePerUser()
          ->cacheUntilEntityChanges($order);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermission($account, 'create orders')
      ->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.
OrderAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess
OrderAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. 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.