class CacheableJsonResponse in Drupal 9

A JsonResponse that contains and can expose cacheability metadata.

Supports Drupal's caching concepts: cache tags for invalidation and cache contexts for variations.

Hierarchy

• class \Drupal\Core\Cache\CacheableJsonResponse extends \Symfony\Component\HttpFoundation\JsonResponse implements CacheableResponseInterface uses CacheableResponseTrait

See also

\Drupal\Core\Cache\Cache

\Drupal\Core\Cache\CacheableMetadata

\Drupal\Core\Cache\CacheableResponseTrait

6 files declare their use of CacheableJsonResponse

ExceptionHandlingTest.php in core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php

ExceptionJsonSubscriber.php in core/lib/Drupal/Core/EventSubscriber/ExceptionJsonSubscriber.php

ExceptionJsonSubscriberTest.php in core/tests/Drupal/Tests/Core/EventSubscriber/ExceptionJsonSubscriberTest.php

JsonRenderer.php in core/modules/system/tests/modules/common_test/src/Render/MainContent/JsonRenderer.php

PageCacheAcceptHeaderController.php in core/modules/system/tests/modules/system_test/src/Controller/PageCacheAcceptHeaderController.php

... See full list

File

core/lib/Drupal/Core/Cache/CacheableJsonResponse.php, line 17

Namespace

Drupal\Core\Cache

class CacheableJsonResponse extends JsonResponse implements CacheableResponseInterface {
  use CacheableResponseTrait;

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableResponseTrait::$cacheabilityMetadata	protected	property	The cacheability metadata.
CacheableResponseTrait::addCacheableDependency	public	function
CacheableResponseTrait::getCacheableMetadata	public	function