class ResourceResponse in Drupal 9

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.

Hierarchy

• class \Drupal\rest\ResourceResponse extends \Symfony\Component\HttpFoundation\Response implements CacheableResponseInterface, ResourceResponseInterface uses CacheableResponseTrait, ResourceResponseTrait

See also

\Drupal\rest\ModifiedResourceResponse

6 files declare their use of ResourceResponse

DBLogResource.php in core/modules/dblog/src/Plugin/rest/resource/DBLogResource.php

EntityResource.php in core/modules/rest/src/Plugin/rest/resource/EntityResource.php

NoSerializationClassTestResource.php in core/modules/rest/tests/modules/rest_test/src/Plugin/rest/resource/NoSerializationClassTestResource.php

RequestHandlerTest.php in core/modules/rest/tests/src/Kernel/RequestHandlerTest.php

ResourceResponseSubscriberTest.php in core/modules/rest/tests/src/Unit/EventSubscriber/ResourceResponseSubscriberTest.php

... See full list

File

core/modules/rest/src/ResourceResponse.php, line 19

Namespace

Drupal\rest

class ResourceResponse extends Response implements CacheableResponseInterface, ResourceResponseInterface {
  use CacheableResponseTrait;
  use ResourceResponseTrait;

  /**
   * Constructor for ResourceResponse objects.
   *
   * @param mixed $data
   *   Response data that should be serialized.
   * @param int $status
   *   The response status code.
   * @param array $headers
   *   An array of response headers.
   */
  public function __construct($data = NULL, $status = 200, $headers = []) {
    $this->responseData = $data;
    parent::__construct('', $status, $headers);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableResponseTrait::$cacheabilityMetadata	protected	property	The cacheability metadata.
CacheableResponseTrait::addCacheableDependency	public	function
CacheableResponseTrait::getCacheableMetadata	public	function
ResourceResponse::__construct	public	function	Constructor for ResourceResponse objects.
ResourceResponseTrait::$responseData	protected	property	Response data that should be serialized.
ResourceResponseTrait::getResponseData	public	function	Returns response data that should be serialized.