Drupal 8  8.0.2
PagersCacheContext Class Reference
Inheritance diagram for PagersCacheContext:

Public Member Functions

 getContext ($pager_id=NULL)
 
 getCacheableMetadata ($pager_id=NULL)
 
- Public Member Functions inherited from RequestStackCacheContextBase
 __construct (RequestStack $request_stack)
 

Static Public Member Functions

static getLabel ()
 

Additional Inherited Members

- Protected Attributes inherited from RequestStackCacheContextBase
 $requestStack
 

Detailed Description

Defines a cache context for "per page in a pager" caching.

Cache context ID: 'url.query_args.pagers' (to vary by all pagers). Calculated cache context ID: 'url.query_args.pagers:pager_id', e.g. 'url.query_args.pagers:1' (to vary by the pager with ID 1).

Member Function Documentation

getCacheableMetadata (   $pager_id = NULL)

{Gets the cacheability metadata for the context based on the parameter value.There are three valid cases for the returned CacheableMetadata object:

  • An empty object means this can be optimized away safely.
  • A max-age of 0 means that this context can never be optimized away. It will never bubble up and cache tags will not be used.
  • Any non-zero max-age and cache tags will bubble up into the cache item if this is optimized away to allow for invalidation if the context value changes.
Parameters
string | null$parameterThe parameter, or NULL to indicate all possible parameter values.
Returns
A cacheable metadata object.
Exceptions
\LogicExceptionThrown if the passed in parameter is invalid.
}

Implements CalculatedCacheContextInterface.

getContext (   $pager_id = NULL)

{Returns the string representation of the cache context.A cache context service's name is used as a token (placeholder) cache key, and is then replaced with the string returned by this method.

Parameters
string | null$parameterThe parameter, or NULL to indicate all possible parameter values.
Returns
string The string representation of the cache context. When $parameter is NULL, a value representing all possible parameters must be generated.
Exceptions
\LogicExceptionThrown if the passed in parameter is invalid.
}

See Also
pager_find_page()

Implements CalculatedCacheContextInterface.

References Drupal\requestStack().

Here is the call graph for this function:

static getLabel ( )
static

{Returns the label of the cache context.

Returns
string The label of the cache context.
See Also
Cache
}

Implements CalculatedCacheContextInterface.

References t().

Here is the call graph for this function:


The documentation for this class was generated from the following file: