class IsSuperUserCacheContext in Drupal 9

Defines the IsSuperUserCacheContext service, for "super user or not" caching.

Cache context ID: 'user.is_super_user'.

Hierarchy

• class \Drupal\Core\Cache\Context\UserCacheContextBase
  • class \Drupal\Core\Cache\Context\IsSuperUserCacheContext implements CacheContextInterface

1 string reference to 'IsSuperUserCacheContext'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses IsSuperUserCacheContext

cache_context.user.is_super_user in core/core.services.yml

Drupal\Core\Cache\Context\IsSuperUserCacheContext

File

core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php, line 12

Namespace

Drupal\Core\Cache\Context

class IsSuperUserCacheContext extends UserCacheContextBase implements CacheContextInterface {

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t('Is super user');
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    return (int) $this->user
      ->id() === 1 ? '1' : '0';
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {
    return new CacheableMetadata();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
IsSuperUserCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
IsSuperUserCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
IsSuperUserCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CacheContextInterface::getLabel
UserCacheContextBase::$user	protected	property	The account object.
UserCacheContextBase::__construct	public	function	Constructs a new UserCacheContextBase class.	1