You are here

public function CacheableMetadata::setCacheMaxAge in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Cache/CacheableMetadata.php \Drupal\Core\Cache\CacheableMetadata::setCacheMaxAge()
  2. 10 core/lib/Drupal/Core/Cache/CacheableMetadata.php \Drupal\Core\Cache\CacheableMetadata::setCacheMaxAge()

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;
}