CslReferenceNormalizer.php in Bibliography & Citation 8

Namespace

Drupal\bibcite_entity\Normalizer

File

modules/bibcite_entity/src/Normalizer/CslReferenceNormalizer.php

<?php

namespace Drupal\bibcite_entity\Normalizer;

use Drupal\bibcite_entity\Entity\ReferenceInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Symfony\Component\Serializer\Exception\LogicException;

/**
 * Normalizes/denormalizes reference entity to CSL format.
 */
class CslReferenceNormalizer extends ReferenceNormalizerBase {

  /**
   * List of date fields.
   *
   * @var array
   */
  protected $dateFields = [
    'bibcite_year',
    'bibcite_access_date',
    'bibcite_date',
  ];

  /**
   * {@inheritdoc}
   */
  public function supportsDenormalization($data, $type, $format = NULL) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function denormalize($data, $class, $format = NULL, array $context = []) {
    throw new LogicException("Cannot denormalize from 'CSL' format.");
  }

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

    /** @var \Drupal\bibcite_entity\Entity\ReferenceInterface $reference */
    $attributes = parent::normalize($reference, $format, $context);
    $contributor_key = $this
      ->getContributorKey();
    if (isset($attributes[$contributor_key])) {
      $authors = $attributes[$contributor_key];
      foreach ($authors as $role => $contributors) {
        $attributes[$role] = $contributors;
      }
    }
    return $attributes;
  }

  /**
   * {@inheritdoc}
   */
  protected function extractFields(ReferenceInterface $reference, $format = NULL) {
    $attributes = [];
    $attributes['title'] = $this
      ->extractScalar($reference
      ->get('title'));
    foreach ($this->fieldsMapping[$this->format] as $csl_field => $entity_field) {
      if ($entity_field && $reference
        ->hasField($entity_field) && ($field = $reference
        ->get($entity_field)) && !$field
        ->isEmpty()) {
        if (in_array($entity_field, $this->dateFields)) {
          $attributes[$csl_field] = $this
            ->extractDate($field);
        }
        else {
          $attributes[$csl_field] = $this
            ->extractScalar($field);
        }
      }
    }
    return $attributes;
  }

  /**
   * Extract authors values from field.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $field_item_list
   *   List of field items.
   *
   * @return array
   *   Authors in CSL format.
   */
  protected function extractAuthors(FieldItemListInterface $field_item_list) {
    $authors = [];
    foreach ($field_item_list as $field) {

      /** @var \Drupal\bibcite_entity\Entity\ContributorInterface $contributor */
      if ($contributor = $field->entity) {
        switch ($field->role) {
          case 'editor':
          case 'series_editor':
            $authors['editor'][] = [
              'category' => $field->category,
              'role' => $field->role,
              'family' => $contributor
                ->getLastName(),
              'given' => $contributor
                ->getFirstName() . ' ' . $contributor
                ->getMiddleName(),
              'suffix' => $contributor
                ->getSuffix(),
              'literal' => $contributor
                ->getName(),
            ];
            break;
          case 'recipient':
          case 'translator':
            $authors[$field->role][] = [
              'category' => $field->category,
              'role' => $field->role,
              'family' => $contributor
                ->getLastName(),
              'given' => $contributor
                ->getFirstName() . ' ' . $contributor
                ->getMiddleName(),
              'suffix' => $contributor
                ->getSuffix(),
              'literal' => $contributor
                ->getName(),
            ];
            break;
          default:
            $authors['author'][] = [
              'category' => $field->category,
              'role' => $field->role,
              'family' => $contributor
                ->getLastName(),
              'given' => $contributor
                ->getFirstName() . ' ' . $contributor
                ->getMiddleName(),
              'suffix' => $contributor
                ->getSuffix(),
              'literal' => $contributor
                ->getName(),
            ];
            break;
        }
      }
    }
    return $authors;
  }

  /**
   * Extract date value to CSL format.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $date_field
   *   Date item list.
   *
   * @return array
   *   Date in CSL format.
   */
  protected function extractDate(FieldItemListInterface $date_field) {
    $value = $this
      ->extractScalar($date_field);
    return [
      'date-parts' => [
        [
          $value,
        ],
      ],
      'literal' => $value,
    ];
  }

}

Classes

Name	Description
CslReferenceNormalizer	Normalizes/denormalizes reference entity to CSL format.