class RestMenuItemsCachableDepenency in Rest menu items 8
Hierarchy
- class \Drupal\rest_menu_items\Plugin\rest\resource\RestMenuItemsCachableDepenency implements CacheableDependencyInterface
Expanded class hierarchy of RestMenuItemsCachableDepenency
File
- src/
Plugin/ rest/ resource/ RestMenuItemsCachableDepenency.php, line 14
Namespace
Drupal\rest_menu_items\Plugin\rest\resourceView source
class RestMenuItemsCachableDepenency implements CacheableDependencyInterface {
// Minimum depth parameter
protected $minDepth = 1;
// Maximum depth parameter
protected $maxDepth = 1;
// the menu being exposed
protected $menuName = '';
/**
* RestMenuItemsCachableDepenency constructor.
*
* @param int $minDepth The minimum depth to be used as a cache context
* @param int $maxDepth The maximum depth to be used as a cache context
*/
public function __construct($menuName, $minDepth, $maxDepth) {
$this->menuName = $menuName;
$this->minDepth = $minDepth;
$this->maxDepth = $maxDepth;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
$contexts = [];
// URL parameters as contexts
if ($this->minDepth != 1 || $this->maxDepth != 1) {
$contexts[] = 'url.query_args';
}
return $contexts;
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
$tags = [];
$tags[] = 'config:system.menu.' . $this->menuName;
return $tags;
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
RestMenuItemsCachableDepenency:: |
protected | property | ||
RestMenuItemsCachableDepenency:: |
protected | property | ||
RestMenuItemsCachableDepenency:: |
protected | property | ||
RestMenuItemsCachableDepenency:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
RestMenuItemsCachableDepenency:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
RestMenuItemsCachableDepenency:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
RestMenuItemsCachableDepenency:: |
public | function | RestMenuItemsCachableDepenency constructor. |