CacheableResourceResponse.php

Same filename and directory in other branches
  1. 10 core/modules/jsonapi/src/CacheableResourceResponse.php
  2. 11.x core/modules/jsonapi/src/CacheableResourceResponse.php

Namespace

Drupal\jsonapi

File

core/modules/jsonapi/src/CacheableResourceResponse.php

View source
<?php

namespace Drupal\jsonapi;

use Drupal\Core\Cache\CacheableResponseInterface;
use Drupal\Core\Cache\CacheableResponseTrait;

/**
 * Extends ResourceResponse with cacheability.
 *
 * We want to have the same functionality for both responses that are cacheable
 * and those that are not.  This response class should be used in all instances
 * where the response is expected to be cacheable.
 *
 * @internal JSON:API maintains no PHP API since its API is the HTTP API. This
 *   class may change at any time and this will break any dependencies on it.
 *
 * @see https://www.drupal.org/project/drupal/issues/3032787
 * @see jsonapi.api.php
 */
class CacheableResourceResponse extends ResourceResponse implements CacheableResponseInterface {
    use CacheableResponseTrait;

}

Classes

Title Deprecated Summary
CacheableResourceResponse Extends ResourceResponse with cacheability.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.