CshsFullHierarchyFormatter.php in Client-side Hierarchical Select 8.2

Namespace

Drupal\cshs\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php

<?php

namespace Drupal\cshs\Plugin\Field\FieldFormatter;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Field\FieldItemListInterface;

/**
 * Plugin implementation of the "Full hierarchy" formatter.
 *
 * @FieldFormatter(
 *   id = "cshs_full_hierarchy",
 *   label = @Translation("Full hierarchy"),
 *   description = @Translation("Display the full hierarchy of the taxonomy term."),
 *   field_types = {
 *     "entity_reference",
 *   },
 * )
 */
class CshsFullHierarchyFormatter extends CshsFormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() : array {
    return [
      'separator' => ' » ',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) : array {
    $element = parent::settingsForm($form, $form_state);
    $element['separator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Separator'),
      '#description' => $this
        ->t('Specify a separator which will be placed in between the different hierarchy levels.'),
      '#default_value' => $this
        ->getSetting('separator'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() : array {
    $summary = parent::settingsSummary();
    $separator = $this
      ->getSetting('separator');
    $summary[] = $this
      ->t('Separator: @separator', [
      '@separator' => empty($separator) ? $this
        ->t('None') : $separator,
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) : array {
    $linked = $this
      ->getSetting('linked');
    $reverse = $this
      ->getSetting('reverse');
    $separator = $this
      ->getSetting('separator') ?: ' ';
    $elements = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $term) {
      $terms = $this
        ->getTermsLabels($this
        ->getTermParents($term), $linked);
      $elements[$delta]['#markup'] = \implode($separator, $reverse ? \array_reverse($terms) : $terms);
    }
    return $elements;
  }

}

Classes

Name	Description
CshsFullHierarchyFormatter	Plugin implementation of the "Full hierarchy" formatter.