IngredientFormatter.php in Recipe 8.2

Namespace

Drupal\ingredient\Plugin\Field\FieldFormatter

File

modules/ingredient/src/Plugin/Field/FieldFormatter/IngredientFormatter.php

<?php

namespace Drupal\ingredient\Plugin\Field\FieldFormatter;

use Drupal\Component\Utility\Xss;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\ingredient\Utility\IngredientUnitUtility;
use Drupal\ingredient\Utility\IngredientQuantityUtility;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Plugin implementation of the 'ingredient_default' formatter.
 *
 * @FieldFormatter(
 *   id = "ingredient_default",
 *   module = "ingredient",
 *   label = @Translation("Default"),
 *   field_types = {
 *     "ingredient"
 *   }
 * )
 */
class IngredientFormatter extends EntityReferenceFormatterBase {

  /**
   * The ingredient.unit service.
   *
   * @var \Drupal\ingredient\Utility\IngredientUnitUtility
   */
  protected $ingredientUnitUtility;

  /**
   * The ingredient.quantity service.
   *
   * @var \Drupal\ingredient\Utility\IngredientQuantityUtility
   */
  protected $ingredientQuantityUtility;

  /**
   * Constructs a IngredientFormatter service.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\ingredient\Utility\IngredientUnitUtility $ingredient_unit_utility
   *   The ingredient.unit service.
   * @param \Drupal\ingredient\Utility\IngredientQuantityUtility $ingredient_quantity_utility
   *   The ingredient.quantity service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, IngredientUnitUtility $ingredient_unit_utility, IngredientQuantityUtility $ingredient_quantity_utility) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->ingredientUnitUtility = $ingredient_unit_utility;
    $this->ingredientQuantityUtility = $ingredient_quantity_utility;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('ingredient.unit'), $container
      ->get('ingredient.quantity'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'fraction_format' => t('{%d }%d&frasl;%d'),
      'unit_display' => 0,
      'link' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['fraction_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fractions display string'),
      '#default_value' => $this
        ->getSetting('fraction_format'),
      '#size' => 35,
      '#maxlength' => 255,
      '#description' => $this
        ->t('How fractions should be displayed. Leave blank to display as decimals.<br />Each incidence of %d will be replaced by the whole number, the numerator, and the denominator in that order.<br />Anything between curly braces will not be displayed when the whole number is equal to 0.<br />Recommended settings are "{%d }%d&amp;frasl;%d" or "{%d }&lt;sup&gt;%d&lt;/sup&gt;/&lt;sub&gt;%d&lt;/sub&gt;"'),
    ];
    $element['unit_display'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Ingredient unit display'),
      '#default_value' => $this
        ->getSetting('unit_display'),
      '#options' => $this
        ->getUnitDisplayOptions(),
      '#description' => $this
        ->t('Display ingredient units like Tbsp or Tablespoon.'),
      '#required' => TRUE,
    ];
    $element['link'] = [
      '#title' => $this
        ->t('Link name to the referenced ingredient'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('link'),
    ];
    return $element;
  }

  /**
   * Returns an array of ingredient quantity unit display options.
   *
   * @return array
   *   The array of display options.
   */
  protected function getUnitDisplayOptions() {
    return [
      0 => $this
        ->t('Abbreviation'),
      1 => $this
        ->t('Full name'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary[] = $this
      ->t('Fractions display string: @fraction_format', [
      '@fraction_format' => $this
        ->getSetting('fraction_format'),
    ]);
    $unit_display_options = $this
      ->getUnitDisplayOptions();
    $unit_display_text = $unit_display_options[$this
      ->getSetting('unit_display')];
    $summary[] = $this
      ->t('Ingredient unit display: @unit_display_text', [
      '@unit_display_text' => $unit_display_text,
    ]);
    $link_display_text = $this
      ->getSetting('link') ? $this
      ->t('Yes') : $this
      ->t('No');
    $summary[] = $this
      ->t('Link to ingredient: @link_display_text', [
      '@link_display_text' => $link_display_text,
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $fraction_format = $this
      ->getSetting('fraction_format');
    $output_as_link = $this
      ->getSetting('link');
    $unit_list = $this->ingredientUnitUtility
      ->getConfiguredUnits();
    $elements = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {

      // Sanitize the name and note.
      $name = Xss::filter($entity
        ->label(), []);
      $note = Xss::filter($items[$delta]->note, []);

      // If the link should be displayed and the entity has a URI, display the
      // link.
      $url = $output_as_link && !$entity
        ->isNew() ? $entity
        ->toUrl() : NULL;
      if ($items[$delta]->quantity > 0) {
        $formatted_quantity = $this->ingredientQuantityUtility
          ->getQuantityFromDecimal($items[$delta]->quantity, $fraction_format);
      }
      else {
        $formatted_quantity = '&nbsp;';
      }

      // Print the unit unless it has no abbreviation. Those units do not get
      // printed in any case.
      $unit_name = '';
      $unit_abbreviation = '';
      $unit = isset($unit_list[$items[$delta]->unit_key]) ? $unit_list[$items[$delta]->unit_key] : [];
      if (!empty($unit['abbreviation'])) {
        $unit_name = $items[$delta]->quantity > 1 ? $unit['plural'] : $unit['name'];
        $unit_abbreviation = $unit['abbreviation'];
      }
      $elements[$delta] = [
        '#theme' => 'ingredient_formatter',
        '#ingredient' => $entity,
        '#url' => $url,
        '#name' => $name,
        '#quantity' => $formatted_quantity,
        '#unit_name' => $unit_name,
        '#unit_abbreviation' => $unit_abbreviation,
        '#unit_display' => $this
          ->getSetting('unit_display'),
        '#note' => $note,
      ];
    }
    return $elements;
  }

}

Classes

Name	Description
IngredientFormatter	Plugin implementation of the 'ingredient_default' formatter.