You are here

Home » API reference » Recipe 8.2 » IngredientFormatter.php

class IngredientFormatter in Recipe 8.2

Plugin implementation of the 'ingredient_default' formatter.

Plugin annotation


@FieldFormatter(
  id = "ingredient_default",
  module = "ingredient",
  label = @Translation("Default"),
  field_types = {
    "ingredient"
  }
)

Hierarchy

Expanded class hierarchy of IngredientFormatter

1 file declares its use of IngredientFormatter
IngredientRecipeMLFormatter.php in src/Plugin/Field/FieldFormatter/IngredientRecipeMLFormatter.php

File

modules/ingredient/src/Plugin/Field/FieldFormatter/IngredientFormatter.php, line 26

Namespace

Drupal\ingredient\Plugin\Field\FieldFormatter
View source 
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⁄%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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
IngredientFormatter::$ingredientQuantityUtility protected property The ingredient.quantity service.
IngredientFormatter::$ingredientUnitUtility protected property The ingredient.unit service.
IngredientFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
IngredientFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
IngredientFormatter::getUnitDisplayOptions protected function Returns an array of ingredient quantity unit display options.
IngredientFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 1
IngredientFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 1
IngredientFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements 1
IngredientFormatter::__construct public function Constructs a IngredientFormatter service. Overrides FormatterBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.