class FileItemNormalizer in Better Normalizers 8

Converts File items, including display and description values.

Hierarchy

• class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
  • class \Drupal\hal\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface
    • class \Drupal\hal\Normalizer\FieldItemNormalizer uses FieldableEntityNormalizerTrait, SerializedColumnNormalizerTrait
      • class \Drupal\hal\Normalizer\EntityReferenceItemNormalizer implements UuidReferenceInterface uses EntityReferenceFieldItemNormalizerTrait
        • class \Drupal\better_normalizers\Normalizer\FileItemNormalizer

File

src/Normalizer/FileItemNormalizer.php, line 10

Namespace

Drupal\better_normalizers\Normalizer

class FileItemNormalizer extends EntityReferenceItemNormalizer {

  /**
   * {@inheritdoc}
   */
  protected $supportedInterfaceOrClass = 'Drupal\\file\\Plugin\\Field\\FieldType\\FileItem';

  /**
   * {@inheritdoc}
   */
  protected function constructValue($data, $context) {
    $value = parent::constructValue($data, $context);
    if ($value) {

      // Copy across any additional field-specific properties.
      $value += $data;
      unset($value['_links'], $value['uuid']);
    }
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function normalize($field_item, $format = NULL, array $context = array()) {

    /** @var \Drupal\file\Plugin\Field\FieldType\FileItem $field_item */
    $data = parent::normalize($field_item, $format, $context);

    // Copied from parent implementation.
    $field_name = $field_item
      ->getParent()
      ->getName();
    $entity = $field_item
      ->getEntity();
    $field_uri = $this->linkManager
      ->getRelationUri($entity
      ->getEntityTypeId(), $entity
      ->bundle(), $field_name);

    // Add any field-specific data.
    $data['_embedded'][$field_uri][0] += $field_item
      ->getValue();
    unset($data['_embedded'][$field_uri][0]['target_id']);
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
EntityReferenceFieldItemNormalizerTrait::fieldItemReferencesTaxonomyTerm	protected	function	Determines if a field item references a taxonomy term.
EntityReferenceFieldItemNormalizerTrait::normalizeRootReferenceValue	protected	function
EntityReferenceItemNormalizer::$entityResolver	protected	property	The entity resolver.
EntityReferenceItemNormalizer::$entityTypeManager	protected	property	The entity type manager. Overrides FieldableEntityNormalizerTrait::$entityTypeManager
EntityReferenceItemNormalizer::$linkManager	protected	property	The hypermedia link manager.
EntityReferenceItemNormalizer::getUuid	public	function	Get the uuid from the data array. Overrides UuidReferenceInterface::getUuid
EntityReferenceItemNormalizer::normalizedFieldValues	protected	function	Normalizes field values for an item. Overrides FieldItemNormalizer::normalizedFieldValues
EntityReferenceItemNormalizer::targetEntityIsFieldable	protected	function	Checks whether the referenced entity is of a fieldable entity type.
EntityReferenceItemNormalizer::__construct	public	function	Constructs an EntityReferenceItemNormalizer object.
FieldableEntityNormalizerTrait::$entityFieldManager	protected	property	The entity field manager.
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::createTranslatedInstance	protected	function	Get a translated version of the field item instance.
FieldItemNormalizer::denormalize	public	function	Denormalizes data back into an object of the given class.
FileItemNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides EntityReferenceItemNormalizer::$supportedInterfaceOrClass
FileItemNormalizer::constructValue	protected	function	Build the field item value using the incoming data. Overrides EntityReferenceItemNormalizer::constructValue
FileItemNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars. Overrides EntityReferenceItemNormalizer::normalize
NormalizerBase::$format	protected	property	List of formats which supports (de-)normalization. Overrides NormalizerBase::$format
NormalizerBase::addCacheableDependency	protected	function	Adds cacheability if applicable.
NormalizerBase::checkFormat	protected	function	Checks if the provided format is supported by this normalizer. Overrides NormalizerBase::checkFormat
NormalizerBase::supportsDenormalization	public	function	Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization()	1
NormalizerBase::supportsNormalization	public	function	Checks whether the given class is supported for normalization by this normalizer.	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.