class EntityToJsonApi in JSON:API 8

Simplifies the process of generating a JSON API version of an entity.

@api

Hierarchy

• class \Drupal\jsonapi\EntityToJsonApi

1 string reference to 'EntityToJsonApi'

jsonapi.services.yml in ./jsonapi.services.yml

jsonapi.services.yml

1 service uses EntityToJsonApi

jsonapi.entity.to_jsonapi in ./jsonapi.services.yml

Drupal\jsonapi\EntityToJsonApi

File

src/EntityToJsonApi.php, line 18

Namespace

Drupal\jsonapi

class EntityToJsonApi {

  /**
   * The currently logged in user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Serializer object.
   *
   * @var \Drupal\jsonapi\Serializer\Serializer
   */
  protected $serializer;

  /**
   * The JSON API resource type repository.
   *
   * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
   */
  protected $resourceTypeRepository;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The JSON API base path.
   *
   * @var string
   */
  protected $jsonApiBasePath;

  /**
   * EntityToJsonApi constructor.
   *
   * @param \Drupal\jsonapi\Serializer\Serializer $serializer
   *   The serializer.
   * @param \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface $resource_type_repository
   *   The resource type repository.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The currently logged in user.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param string $jsonapi_base_path
   *   The JSON API base path.
   */
  public function __construct(Serializer $serializer, ResourceTypeRepositoryInterface $resource_type_repository, AccountInterface $current_user, RequestStack $request_stack, $jsonapi_base_path) {
    $this->serializer = $serializer;
    $this->resourceTypeRepository = $resource_type_repository;
    $this->currentUser = $current_user;
    $this->requestStack = $request_stack;
    assert(is_string($jsonapi_base_path));
    assert($jsonapi_base_path[0] === '/');
    assert(substr($jsonapi_base_path, -1) !== '/');
    $this->jsonApiBasePath = $jsonapi_base_path;
  }

  /**
   * Return the requested entity as a raw string.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to generate the JSON from.
   *
   * @return string
   *   The raw JSON string of the requested resource.
   */
  public function serialize(EntityInterface $entity) {

    // TODO: Supporting includes requires adding the 'include' query string.
    return $this->serializer
      ->serialize(new JsonApiDocumentTopLevel($entity), 'api_json', $this
      ->calculateContext($entity));
  }

  /**
   * Return the requested entity as an structured array.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to generate the JSON from.
   *
   * @return array
   *   The JSON structure of the requested resource.
   */
  public function normalize(EntityInterface $entity) {
    return $this->serializer
      ->normalize(new JsonApiDocumentTopLevel($entity), 'api_json', $this
      ->calculateContext($entity))
      ->rasterizeValue();
  }

  /**
   * Calculate the context for the serialize/normalize operation.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to generate the JSON from.
   *
   * @return array
   *   The context.
   */
  protected function calculateContext(EntityInterface $entity) {

    // TODO: Supporting includes requires adding the 'include' query string.
    $resource_type = $this->resourceTypeRepository
      ->get($entity
      ->getEntityTypeId(), $entity
      ->bundle());
    $resource_path = $resource_type
      ->getPath();
    $path = sprintf('%s%s/%s', $this->jsonApiBasePath, $resource_path, $entity
      ->uuid());
    $master_request = $this->requestStack
      ->getMasterRequest();
    $request = Request::create($master_request
      ->getSchemeAndHttpHost() . $master_request
      ->getBaseUrl() . $path, 'GET');
    return [
      'account' => $this->currentUser,
      'resource_type' => $resource_type,
      'request' => $request,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityToJsonApi::$currentUser	protected	property	The currently logged in user.
EntityToJsonApi::$jsonApiBasePath	protected	property	The JSON API base path.
EntityToJsonApi::$requestStack	protected	property	The request stack.
EntityToJsonApi::$resourceTypeRepository	protected	property	The JSON API resource type repository.
EntityToJsonApi::$serializer	protected	property	Serializer object.
EntityToJsonApi::calculateContext	protected	function	Calculate the context for the serialize/normalize operation.
EntityToJsonApi::normalize	public	function	Return the requested entity as an structured array.
EntityToJsonApi::serialize	public	function	Return the requested entity as a raw string.
EntityToJsonApi::__construct	public	function	EntityToJsonApi constructor.