interface FieldNormalizerValueInterface in JSON:API 8

Interface to help normalize fields in compliance with the JSON API spec.

@internal

Hierarchy

• interface \Drupal\jsonapi\Normalizer\Value\ValueExtractorInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface
  • interface \Drupal\jsonapi\Normalizer\Value\FieldNormalizerValueInterface

3 files declare their use of FieldNormalizerValueInterface

EntityNormalizer.php in src/Normalizer/EntityNormalizer.php

EntityNormalizerValueTest.php in tests/src/Unit/Normalizer/Value/EntityNormalizerValueTest.php

JsonApiDocumentTopLevelNormalizerValueTest.php in tests/src/Unit/Normalizer/Value/JsonApiDocumentTopLevelNormalizerValueTest.php

File

src/Normalizer/Value/FieldNormalizerValueInterface.php, line 12

Namespace

Drupal\jsonapi\Normalizer\Value

interface FieldNormalizerValueInterface extends ValueExtractorInterface, CacheableDependencyInterface {

  /**
   * Gets the includes.
   *
   * @return mixed
   *   The includes.
   */
  public function getIncludes();

  /**
   * Gets the propertyType.
   *
   * @return mixed
   *   The propertyType.
   */
  public function getPropertyType();

  /**
   * Computes all the nested includes recursively.
   *
   * @return array
   *   The includes and the nested includes.
   */
  public function getAllIncludes();

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
FieldNormalizerValueInterface::getAllIncludes	public	function	Computes all the nested includes recursively.	2
FieldNormalizerValueInterface::getIncludes	public	function	Gets the includes.	2
FieldNormalizerValueInterface::getPropertyType	public	function	Gets the propertyType.	2
ValueExtractorInterface::rasterizeIncludes	public	function	Get the includes.	5
ValueExtractorInterface::rasterizeValue	public	function	Get the rasterized value.	4