class EntityReferenceNormalizer in Commerce Cart API 8

Expands entity reference field values to their referenced entity.

Hierarchy

• class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
  • class \Drupal\serialization\Normalizer\ComplexDataNormalizer
    • class \Drupal\serialization\Normalizer\FieldItemNormalizer implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface uses FieldableEntityNormalizerTrait, SerializedColumnNormalizerTrait
      • class \Drupal\serialization\Normalizer\EntityReferenceFieldItemNormalizer uses EntityReferenceFieldItemNormalizerTrait
        • class \Drupal\commerce_cart_api\Normalizer\EntityReferenceNormalizer

1 string reference to 'EntityReferenceNormalizer'

commerce_cart_api.services.yml in ./commerce_cart_api.services.yml

commerce_cart_api.services.yml

1 service uses EntityReferenceNormalizer

commerce_cart_api.normalizer.entity_references in ./commerce_cart_api.services.yml

Drupal\commerce_cart_api\Normalizer\EntityReferenceNormalizer

File

src/Normalizer/EntityReferenceNormalizer.php, line 13

Namespace

Drupal\commerce_cart_api\Normalizer

class EntityReferenceNormalizer extends EntityReferenceFieldItemNormalizer {

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * An array of allowed fields for this normalizer.
   *
   * @var array
   */
  protected $allowedFields;

  /**
   * Constructs a new EntityReferenceNormalizer object.
   *
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   * @param array $commerce_cart_api
   *   The Cart API's service parameters.
   */
  public function __construct(EntityRepositoryInterface $entity_repository, RouteMatchInterface $route_match, array $commerce_cart_api) {
    parent::__construct($entity_repository);
    $this->routeMatch = $route_match;
    $this->allowedFields = $commerce_cart_api['normalized_entity_references'];
  }

  /**
   * {@inheritdoc}
   */
  public function supportsNormalization($data, $format = NULL) {
    $supported = parent::supportsNormalization($data, $format);
    if ($supported) {
      $route = $this->routeMatch
        ->getRouteObject();

      /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $data */
      $name = $data
        ->getFieldDefinition()
        ->getName();
      return $route && in_array($name, $this
        ->getSupportedFields(), TRUE) && $route
        ->hasRequirement('_cart_api');
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function normalize($field_item, $format = NULL, array $context = []) {
    assert($field_item instanceof EntityReferenceItem);
    $entity = $field_item
      ->get('entity')
      ->getValue();
    return $this->serializer
      ->normalize($entity, $format, $context);
  }

  /**
   * Gets the supported fields by the normalizer.
   *
   * @return array
   *   An array of field names that are supported.
   */
  protected function getSupportedFields() {
    return $this->allowedFields;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
EntityReferenceFieldItemNormalizer::$entityRepository	protected	property	The entity repository.
EntityReferenceFieldItemNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides FieldItemNormalizer::$supportedInterfaceOrClass
EntityReferenceFieldItemNormalizer::constructValue	protected	function	Build the field item value using the incoming data. Overrides FieldableEntityNormalizerTrait::constructValue
EntityReferenceFieldItemNormalizerTrait::fieldItemReferencesTaxonomyTerm	protected	function	Determines if a field item references a taxonomy term.
EntityReferenceFieldItemNormalizerTrait::normalizeRootReferenceValue	protected	function
EntityReferenceNormalizer::$allowedFields	protected	property	An array of allowed fields for this normalizer.
EntityReferenceNormalizer::$routeMatch	protected	property	The current route match.
EntityReferenceNormalizer::getSupportedFields	protected	function	Gets the supported fields by the normalizer.
EntityReferenceNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars. Overrides EntityReferenceFieldItemNormalizer::normalize
EntityReferenceNormalizer::supportsNormalization	public	function	Checks whether the given class is supported for normalization by this normalizer. Overrides NormalizerBase::supportsNormalization
EntityReferenceNormalizer::__construct	public	function	Constructs a new EntityReferenceNormalizer object. Overrides EntityReferenceFieldItemNormalizer::__construct
FieldableEntityNormalizerTrait::$entityFieldManager	protected	property	The entity field manager.
FieldableEntityNormalizerTrait::$entityTypeManager	protected	property	The entity type manager.	1
FieldableEntityNormalizerTrait::$entityTypeRepository	protected	property	The entity type repository.
FieldableEntityNormalizerTrait::denormalizeFieldData	protected	function	Denormalizes entity data by denormalizing each field individually.
FieldableEntityNormalizerTrait::determineEntityTypeId	protected	function	Determines the entity type ID to denormalize as.
FieldableEntityNormalizerTrait::extractBundleData	protected	function	Denormalizes the bundle property so entity creation can use it.
FieldableEntityNormalizerTrait::getEntityFieldManager	protected	function	Returns the entity field manager.
FieldableEntityNormalizerTrait::getEntityTypeDefinition	protected	function	Gets the entity type definition.
FieldableEntityNormalizerTrait::getEntityTypeManager	protected	function	Returns the entity type manager.
FieldableEntityNormalizerTrait::getEntityTypeRepository	protected	function	Returns the entity type repository.
FieldItemNormalizer::denormalize	public	function	Denormalizes data back into an object of the given class.
NormalizerBase::$format	protected	property	List of formats which supports (de-)normalization.	3
NormalizerBase::addCacheableDependency	protected	function	Adds cacheability if applicable.
NormalizerBase::checkFormat	protected	function	Checks if the provided format is supported by this normalizer.	2
NormalizerBase::supportsDenormalization	public	function	Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization()	1
SerializedColumnNormalizerTrait::checkForSerializedStrings	protected	function	Checks if there is a serialized string for a column.
SerializedColumnNormalizerTrait::dataHasStringForSerializeColumn	protected	function	Checks if the data contains string value for serialize column.
SerializedColumnNormalizerTrait::getCustomSerializedPropertyNames	protected	function	Gets the names of all properties the plugin treats as serialized data.
SerializedColumnNormalizerTrait::getSerializedPropertyNames	protected	function	Gets the names of all serialized properties.