class BillingScheduleAccessControlHandler in Commerce Recurring Framework 8

Controls access for the Billing Schedule entity type.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\entity\EntityAccessControlHandlerBase
      • class \Drupal\entity\EntityAccessControlHandler
        • class \Drupal\commerce_recurring\BillingScheduleAccessControlHandler implements EntityHandlerInterface

File

src/BillingScheduleAccessControlHandler.php, line 17

Namespace

Drupal\commerce_recurring

class BillingScheduleAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {

  /**
   * {@inheritdoc}
   */
  protected $viewLabelOperation = TRUE;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new BillingScheduleAccessControlHandler object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($entity_type);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'));
  }

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

    // Allow users with access to the 'commerce_subscription' entity type to
    // view the label of 'commerce_billing_schedule' entities.
    if ($operation === 'view label') {
      $permissions = [
        'administer commerce_billing_schedule',
        'administer commerce_subscription',
        'update any commerce_subscription',
        'view any commerce_subscription',
        'view own commerce_subscription',
      ];
      return AccessResult::allowedIfHasPermissions($account, $permissions, 'OR');
    }
    elseif ($operation === 'delete') {

      // Deny the "delete" operation if the billing schedule is referenced by
      // subscriptions.
      $is_referenced = (bool) $this->entityTypeManager
        ->getStorage('commerce_subscription')
        ->getQuery()
        ->accessCheck(FALSE)
        ->condition('billing_schedule', $entity
        ->id())
        ->count()
        ->execute();
      if ($is_referenced) {
        return AccessResult::forbidden();
      }
    }
    return parent::checkAccess($entity, $operation, $account);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BillingScheduleAccessControlHandler::$entityTypeManager	protected	property	The entity type manager.
BillingScheduleAccessControlHandler::$viewLabelOperation	protected	property	Allows to grant access to just the labels. Overrides EntityAccessControlHandler::$viewLabelOperation
BillingScheduleAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandlerBase::checkAccess
BillingScheduleAccessControlHandler::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
BillingScheduleAccessControlHandler::__construct	public	function	Constructs a new BillingScheduleAccessControlHandler object. Overrides EntityAccessControlHandler::__construct
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::access	public	function	Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandlerInterface::access	1
EntityAccessControlHandler::checkEntityOwnerPermissions	protected	function	Checks the entity operation and bundle permissions, with owners. Overrides EntityAccessControlHandlerBase::checkEntityOwnerPermissions
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.
EntityAccessControlHandlerBase::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
EntityAccessControlHandlerBase::checkEntityPermissions	protected	function	Checks the entity operation and bundle permissions.
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.
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.