Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Cache/Context/UserRolesCacheContext.php

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