final class ResourceObjectToEntityMapper in JSON:API Resources 8

Service which maps a resource object into an entity.

This class acts as an intermediary between JSON:API's serializer (which is internal) and the public API of this module. The JSON:API serializer may be phased out of Drupal core.

@internal Do not use this class. It is for internal use and will be phased out when core support for similar behavior exists.

Hierarchy

• class \Drupal\jsonapi_resources\Unstable\Entity\ResourceObjectToEntityMapper

See also

\Drupal\jsonapi\Normalizer\ContentEntityDenormalizer

1 string reference to 'ResourceObjectToEntityMapper'

jsonapi_resources.services.yml in ./jsonapi_resources.services.yml

jsonapi_resources.services.yml

1 service uses ResourceObjectToEntityMapper

jsonapi_resources.resource_object_to_entity_mapper in ./jsonapi_resources.services.yml

Drupal\jsonapi_resources\Unstable\Entity\ResourceObjectToEntityMapper

File

src/Unstable/Entity/ResourceObjectToEntityMapper.php, line 25

Namespace

Drupal\jsonapi_resources\Unstable\Entity

final class ResourceObjectToEntityMapper {

  /**
   * The JSON:API serializer.
   *
   * @var \Drupal\jsonapi\Serializer\Serializer
   */
  protected $serializer;

  /**
   * Constructs an EntityDenormalizerBase object.
   *
   * @param \Drupal\jsonapi\Serializer\Serializer $serializer
   *   The JSON:API serializer. Concrete type hint is intentional.
   */
  public function __construct(Serializer $serializer) {
    $this->serializer = $serializer;
  }

  /**
   * Creates a new entity from the given resource object.
   *
   * @param \Drupal\jsonapi\JsonApiResource\ResourceObject $resource_object
   *   The resource object from which to create a new entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The newly created entity.
   */
  public function createEntityFromResourceObject(ResourceObject $resource_object) {
    return $this
      ->mapResourceObjectToEntity($resource_object);
  }

  /**
   * Builds an array of values to use to create an entity.
   *
   * @param \Drupal\jsonapi\JsonApiResource\ResourceObject $resource_object
   *   The resource object from which to map values.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface
   *   A new entity created from a resource object.
   *
   * @throws \UnexpectedValueException
   *   Thrown when the resource object does not represent an entity.
   * @throws \Symfony\Component\HttpKernel\Exception\HttpException
   *   Thrown when the resource object represents a config entity.
   *
   * @see \Drupal\Core\Entity\EntityStorageInterface::create()
   */
  protected function mapResourceObjectToEntity(ResourceObject $resource_object) : EntityInterface {
    $target_class = $resource_object
      ->getResourceType()
      ->getDeserializationTargetClass();
    if (in_array(ContentEntityInterface::class, class_implements($target_class, TRUE) ?: [])) {
      return $this
        ->mapResourceObjectToContentEntity($resource_object);
    }
    elseif (in_array(ConfigEntityInterface::class, class_implements($target_class, TRUE) ?: [])) {
      throw new HttpException(501, 'The JSON:API Resources module does not yet support config entity mutation.');
    }
    else {
      throw new \UnexpectedValueException('The given resource object does not represent a content or config entity.');
    }
  }

  /**
   * Builds an array of values to use to create a content entity.
   *
   * Copied from JSON:API code. Modify with extreme care.
   *
   * @param \Drupal\jsonapi\JsonApiResource\ResourceObject $resource_object
   *   The resource object from which to create a new entity.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface
   *   A new entity created from a resource object.
   *
   * @see \Drupal\jsonapi\Normalizer\ContentEntityDenormalizer::prepareInput()
   */
  protected function mapResourceObjectToContentEntity(ResourceObject $resource_object) : ContentEntityInterface {
    $resource_type = $resource_object
      ->getResourceType();
    return $this->serializer
      ->denormalize($resource_object
      ->getFields(), $resource_type
      ->getDeserializationTargetClass(), 'api_json', [
      'resource_type' => $resource_type,
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ResourceObjectToEntityMapper::$serializer	protected	property	The JSON:API serializer.
ResourceObjectToEntityMapper::createEntityFromResourceObject	public	function	Creates a new entity from the given resource object.
ResourceObjectToEntityMapper::mapResourceObjectToContentEntity	protected	function	Builds an array of values to use to create a content entity.
ResourceObjectToEntityMapper::mapResourceObjectToEntity	protected	function	Builds an array of values to use to create an entity.
ResourceObjectToEntityMapper::__construct	public	function	Constructs an EntityDenormalizerBase object.