1. class
  2. Drupal
  3. \
  4. rest
  5. \
  6. ResourceResponse

ResourceResponse

class ResourceResponse extends Response implements CacheableResponseInterface, ResourceResponseInterface (View source)

Contains data for serialization before sending the response.

We do not want to abuse the $content property on the Response class to store our response data. $content implies that the provided data must either be a string or an object with a __toString() method, which is not a requirement for data used here.

Traits

CacheableResponseTrait

Provides an implementation of CacheableResponseInterface.

ResourceResponseTrait

Properties

protected CacheableMetadata $cacheabilityMetadata

The cacheability metadata.

 from  CacheableResponseTrait
protected mixed $responseData

Response data that should be serialized.

 from  ResourceResponseTrait

Methods

addCacheableDependency($dependency)

{@inheritdoc}

from  CacheableResponseTrait
getCacheableMetadata()

{@inheritdoc}

from  CacheableResponseTrait
mixed
getResponseData()

Returns response data that should be serialized.

from  ResourceResponseTrait
__construct(mixed $data = NULL, int $status = 200, array $headers = [])

Constructor for ResourceResponse objects.

Details

in CacheableResponseTrait at line 22
addCacheableDependency($dependency)

{@inheritdoc}

Parameters

$dependency

in CacheableResponseTrait at line 37
getCacheableMetadata()

{@inheritdoc}

in ResourceResponseTrait at line 20
mixed getResponseData()

Returns response data that should be serialized.

Return Value

mixed

Response data that should be serialized.

at line 34
__construct(mixed $data = NULL, int $status = 200, array $headers = [])

Constructor for ResourceResponse objects.

Parameters

mixed $data

Response data that should be serialized.
int $status

The response status code.
array $headers

An array of response headers.