You are here

Home » API reference » Hierarchical Term Formatter 8 » HierarchicalFormatter.php

class HierarchicalFormatter in Hierarchical Term Formatter 8

Plugin implementation of the 'rating' formatter.

Plugin annotation


@FieldFormatter(
  id = "hierarchical_term_formatter",
  label = @Translation("Hierarchical Term Formatter"),
  description = @Translation("Provides hierarchical term formatters for taxonomy reference fields."),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of HierarchicalFormatter

File

src/Plugin/Field/FieldFormatter/HierarchicalFormatter.php, line 25

Namespace

Drupal\hierarchical_term_formatter\Plugin\Field\FieldFormatter
View source 
class HierarchicalFormatter extends EntityReferenceFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The image style entity storage.
   *
   * @var \Drupal\taxonomy\TermStorage
   */
  protected $taxonomyTermStorage;

  /**
   * Constructs a HierarchicalFormatter object.
   *
   * @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 settings.
   * @param \Drupal\Core\Entity\EntityStorageInterface $taxonomy_term_storage
   *   The Taxonomy Term storage.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityStorageInterface $taxonomy_term_storage) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->taxonomyTermStorage = $taxonomy_term_storage;
  }

  /**
   * {@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('entity_type.manager')
      ->getStorage('taxonomy_term'));
  }

  /**
   * Returns a list of supported display options.
   *
   * @return array
   *   An array whose keys are display machine names
   *   and whose values are their labels.
   */
  private function displayOptions() {
    return [
      'all' => $this
        ->t('The selected term and all of its parents'),
      'parents' => $this
        ->t('Just the parent terms'),
      'root' => $this
        ->t('Just the topmost/root term'),
      'nonroot' => $this
        ->t('Any non-topmost/root terms'),
      'leaf' => $this
        ->t('Just the selected term'),
    ];
  }

  /**
   * Returns a list of supported wrapping options.
   *
   * @return array
   *   An array whose keys are wrapper machine names
   *   and whose values are their labels.
   */
  private function wrapOptions() {
    return [
      'none' => $this
        ->t('None'),
      'span' => $this
        ->t('@tag elements', [
        '@tag' => '<span>',
      ]),
      'div' => $this
        ->t('@tag elements', [
        '@tag' => '<div>',
      ]),
      'ul' => $this
        ->t('@tag elements surrounded by a @parent_tag', [
        '@tag' => '<li>',
        '@parent_tag' => '<ul>',
      ]),
      'ol' => $this
        ->t('@tag elements surrounded by a @parent_tag', [
        '@tag' => '<li>',
        '@parent_tag' => '<ol>',
      ]),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'display' => 'all',
      'link' => FALSE,
      'wrap' => 'none',
      'separator' => ' » ',
      'reverse' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {

    // This formatter is only available for taxonomy terms.
    return $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type') == 'taxonomy_term';
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['display'] = [
      '#title' => $this
        ->t('Terms to display'),
      '#description' => $this
        ->t('Choose what terms to display.'),
      '#type' => 'select',
      '#options' => $this
        ->displayOptions(),
      '#default_value' => $this
        ->getSetting('display'),
      '#required' => FALSE,
    ];
    $form['link'] = [
      '#title' => $this
        ->t('Link each term'),
      '#description' => $this
        ->t('If checked, the terms will link to their corresponding term pages.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('link'),
    ];
    $form['reverse'] = [
      '#title' => $this
        ->t('Reverse order'),
      '#description' => $this
        ->t('If checked, children display first, parents last.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('reverse'),
    ];
    $form['wrap'] = [
      '#title' => $this
        ->t('Wrap each term'),
      '#description' => $this
        ->t('Choose what type of html elements you would like to wrap the terms in, if any.'),
      '#type' => 'select',
      '#options' => $this
        ->wrapOptions(),
      '#default_value' => $this
        ->getSetting('wrap'),
      '#required' => FALSE,
    ];
    $form['separator'] = [
      '#title' => $this
        ->t('Separator'),
      '#description' => $this
        ->t('Enter some text or markup that will separate each term in the hierarchy. Leave blank for no separator. Example: <em>»</em>'),
      '#type' => 'textfield',
      '#size' => 20,
      '#default_value' => $this
        ->getSetting('separator'),
      '#required' => FALSE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $display_options = $this
      ->displayOptions();
    $order = $this
      ->getSetting('reverse') ? $this
      ->t('Reverse') : $this
      ->t('Natural');
    $summary = [];
    $summary[] = $this
      ->t('Display: %display as %format.', [
      '%display' => $display_options[$this
        ->getSetting('display')],
      '%format' => $this
        ->getSetting('link') ? $this
        ->t('links') : $this
        ->t('plain text'),
    ]);
    $summary[] = $this
      ->t('Wrapper: @wrapper.', [
      '@wrapper' => $this
        ->getSetting('wrap'),
    ]);
    $summary[] = $this
      ->t('Order: %order.', [
      '%order' => $order,
    ]);
    $summary[] = $this
      ->t('Separator: "%separator".', [
      '%separator' => $this
        ->getSetting('separator'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = $used = [];
    foreach ($items as $delta => $item) {
      $item_value = $item
        ->getValue();
      $tid = $item_value['target_id'];
      $term_tree = [];
      switch ($this
        ->getSetting('display')) {
        case 'leaf':
          $term = $this->taxonomyTermStorage
            ->load($tid);
          $term_tree = [
            $term,
          ];
          break;
        case 'root':
          $parents = $this->taxonomyTermStorage
            ->loadAllParents($tid);
          if (!empty($parents)) {
            $term_tree = [
              array_pop($parents),
            ];
            if (isset($used[$term_tree[0]
              ->id()])) {
              $term_tree = [];
              break;
            }
            $used[$term_tree[0]
              ->id()] = TRUE;
          }
          break;
        case 'parents':
          $term_tree = array_reverse($this->taxonomyTermStorage
            ->loadAllParents($tid));
          array_pop($term_tree);
          break;
        case 'nonroot':
          $parents = $this->taxonomyTermStorage
            ->loadAllParents($tid);
          if (count($parents) > 1) {
            $term_tree = array_reverse($parents);

            // This gets rid of the first topmost term.
            array_shift($term_tree);

            // Terms can have multiple parents. Now remove any remaining topmost
            // terms.
            foreach ($term_tree as $key => $term) {
              $has_parents = $this->taxonomyTermStorage
                ->loadAllParents($term
                ->id());

              // This has no parents and is topmost.
              if (empty($has_parents)) {
                unset($term_tree[$key]);
              }
            }
          }
          break;
        default:
          $term_tree = array_reverse($this->taxonomyTermStorage
            ->loadAllParents($tid));
          break;
      }

      // Change output order if Reverse order is checked.
      if ($this
        ->getSetting('reverse') && count($term_tree)) {
        $term_tree = array_reverse($term_tree);
      }

      // Remove empty elements caused by discarded items.
      $term_tree = array_filter($term_tree);
      if (!$term_tree) {
        break;
      }
      foreach ($term_tree as $index => $term) {
        if ($term
          ->hasTranslation($langcode)) {
          $term_tree[$index] = $term
            ->getTranslation($langcode);
        }
      }
      $elements[$delta] = [
        '#theme' => 'hierarchical_term_formatter',
        '#terms' => $term_tree,
        '#wrapper' => $this
          ->getSetting('wrap'),
        '#separator' => $this
          ->getSetting('separator'),
        '#link' => $this
          ->getSetting('link') ? TRUE : FALSE,
      ];
    }
    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.
HierarchicalFormatter::$taxonomyTermStorage protected property The image style entity storage.
HierarchicalFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
HierarchicalFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
HierarchicalFormatter::displayOptions private function Returns a list of supported display options.
HierarchicalFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
HierarchicalFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
HierarchicalFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
HierarchicalFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
HierarchicalFormatter::wrapOptions private function Returns a list of supported wrapping options.
HierarchicalFormatter::__construct public function Constructs a HierarchicalFormatter object. 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.