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

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Cache\Context\PagersCacheContext.
6	*/
7
8	namespace Drupal\Core\Cache\Context;
9
10	use Drupal\Core\Cache\CacheableMetadata;
11
12	/**
13	* Defines a cache context for "per page in a pager" caching.
14	*
15	* Cache context ID: 'url.query_args.pagers' (to vary by all pagers).
16	* Calculated cache context ID: 'url.query_args.pagers:%pager_id', e.g.
17	* 'url.query_args.pagers:1' (to vary by the pager with ID 1).
18	*/
19	class PagersCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
20
21	/**
22	* {@inheritdoc}
23	*/
24	public static function getLabel() {
25	return t('Pager');
26	}
27
28	/**
29	* {@inheritdoc}
30	*
31	* @see pager_find_page()
32	*/
33	public function getContext($pager_id = NULL) {
34	// The value of the 'page' query argument contains the information that
35	// controls all pagers.
36	if ($pager_id === NULL) {
37	return $this->requestStack->getCurrentRequest()->query->get('page', '');
38	}
39
40	return $pager_id . '.' . pager_find_page($pager_id);
41	}
42
43	/**
44	* {@inheritdoc}
45	*/
46	public function getCacheableMetadata($pager_id = NULL) {
47	return new CacheableMetadata();
48	}
49
50	}