Chris@5: <?php
Chris@5: 
Chris@5: namespace Drupal\jsonapi;
Chris@5: 
Chris@5: use Drupal\Core\Cache\CacheableResponseInterface;
Chris@5: use Drupal\Core\Cache\CacheableResponseTrait;
Chris@5: use Symfony\Component\HttpFoundation\Response;
Chris@5: 
Chris@5: /**
Chris@5:  * Contains data for serialization before sending the response.
Chris@5:  *
Chris@5:  * We do not want to abuse the $content property on the Response class to store
Chris@5:  * our response data. $content implies that the provided data must either be a
Chris@5:  * string or an object with a __toString() method, which is not a requirement
Chris@5:  * for data used here.
Chris@5:  *
Chris@5:  * @internal JSON:API maintains no PHP API since its API is the HTTP API. This
Chris@5:  *   class may change at any time and this will break any dependencies on it.
Chris@5:  *
Chris@5:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@5:  * @see jsonapi.api.php
Chris@5:  *
Chris@5:  * @see \Drupal\rest\ModifiedResourceResponse
Chris@5:  */
Chris@5: class ResourceResponse extends Response implements CacheableResponseInterface {
Chris@5: 
Chris@5:   use CacheableResponseTrait;
Chris@5: 
Chris@5:   /**
Chris@5:    * Response data that should be serialized.
Chris@5:    *
Chris@5:    * @var mixed
Chris@5:    */
Chris@5:   protected $responseData;
Chris@5: 
Chris@5:   /**
Chris@5:    * Constructor for ResourceResponse objects.
Chris@5:    *
Chris@5:    * @param mixed $data
Chris@5:    *   Response data that should be serialized.
Chris@5:    * @param int $status
Chris@5:    *   The response status code.
Chris@5:    * @param array $headers
Chris@5:    *   An array of response headers.
Chris@5:    */
Chris@5:   public function __construct($data = NULL, $status = 200, array $headers = []) {
Chris@5:     $this->responseData = $data;
Chris@5:     parent::__construct('', $status, $headers);
Chris@5:   }
Chris@5: 
Chris@5:   /**
Chris@5:    * Returns response data that should be serialized.
Chris@5:    *
Chris@5:    * @return mixed
Chris@5:    *   Response data that should be serialized.
Chris@5:    */
Chris@5:   public function getResponseData() {
Chris@5:     return $this->responseData;
Chris@5:   }
Chris@5: 
Chris@5: }