www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Cache/Context/UserRolesCacheContext.php

   1 <?php
   2
   3 namespace Drupal\Core\Cache\Context;
   4
   5 use Drupal\Core\Cache\CacheableMetadata;
   6
   7 /**
   8  * Defines the UserRolesCacheContext service, for "per role" caching.
   9  *
  10  * Only use this cache context when checking explicitly for certain roles. Use
  11  * user.permissions for anything that checks permissions.
  12  *
  13  * Cache context ID: 'user.roles' (to vary by all roles of the current user).
  14  * Calculated cache context ID: 'user.roles:%role', e.g. 'user.roles:anonymous'
  15  * (to vary by the presence/absence of a specific role).
  16  */
  17 class UserRolesCacheContext extends UserCacheContextBase implements CalculatedCacheContextInterface {
  18
  19   /**
  20    * {@inheritdoc}
  21    */
  22   public static function getLabel() {
  23     return t("User's roles");
  24   }
  25
  26   /**
  27    * {@inheritdoc}
  28    */
  29   public function getContext($role = NULL) {
  30     // User 1 does not actually have any special behavior for roles; this is
  31     // added as additional security and backwards compatibility protection for
  32     // SA-CORE-2015-002.
  33     // @todo Remove in Drupal 9.0.0.
  34     if ($this->user->id() == 1) {
  35       return 'is-super-user';
  36     }
  37     if ($role === NULL) {
  38       return implode(',', $this->user->getRoles());
  39     }
  40     else {
  41       return (in_array($role, $this->user->getRoles()) ? '0' : '1');
  42     }
  43   }
  44
  45   /**
  46    * {@inheritdoc}
  47    */
  48   public function getCacheableMetadata($role = NULL) {
  49     return (new CacheableMetadata())->setCacheTags(['user:' . $this->user->id()]);
  50   }
  51
  52 }