CacheableMetadata::setCacheMaxAge

public CacheableMetadata::setCacheMaxAge($max_age)

Sets the maximum age (in seconds).

Defaults to Cache::PERMANENT

Parameters

int $max_age: The max age to associate.

Return value

$this

Throws

\InvalidArgumentException If a non-integer value is supplied.

File

core/lib/Drupal/Core/Cache/CacheableMetadata.php, line 74

Class

CacheableMetadata: Defines a generic class for passing cacheability metadata.

Namespace

Drupal\Core\Cache

Code

public function setCacheMaxAge($max_age) {
  if (!is_int($max_age)) {
    throw new \InvalidArgumentException('$max_age must be an integer');
  }
 
  $this->cacheMaxAge = $max_age;
  return $this;
}

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Cache%21CacheableMetadata.php/function/CacheableMetadata%3A%3AsetCacheMaxAge/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Popular Articles

CacheableMetadata Defines a generic class for passing cacheability metadata. Hierarchy class \Drupal\Core\Cache\CacheableMetadata implements RefinableCacheableDependen

AccessResult::setCacheMaxAge public AccessResult::setCacheMaxAge($max_age) Sets the maximum age for which this access result may be cached. Parameters int $max_age: The maximum

CacheableMetadata::createFromRenderArray public static CacheableMetadata::createFromRenderArray(array $build) Creates a CacheableMetadata object with values taken from a render array. Parame

CacheableMetadata::getCacheMaxAge public CacheableMetadata::getCacheMaxAge() The maximum age for which this object may be cached. Return value int The maximum time in seconds that th

CacheableMetadata::createFromObject public static CacheableMetadata::createFromObject($object) Creates a CacheableMetadata object from a depended object. Parameters \Drupal\Core\Cache\