You are here

class CshsFullHierarchyFormatter in Client-side Hierarchical Select 8

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php \Drupal\cshs\Plugin\Field\FieldFormatter\CshsFullHierarchyFormatter
  2. 8.2 src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php \Drupal\cshs\Plugin\Field\FieldFormatter\CshsFullHierarchyFormatter

Plugin implementation of the "Full hierarchy" formatter.

Plugin annotation


@FieldFormatter(
  id = "cshs_full_hierarchy",
  label = @Translation("Full hierarchy"),
  description = @Translation("Display the full hierarchy of the taxonomy term."),
  field_types = {
    "entity_reference",
  },
)

Hierarchy

Expanded class hierarchy of CshsFullHierarchyFormatter

File

src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php, line 20

Namespace

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

}

Members

Namesort descending Modifiers Type Description Overrides
CshsFormatterBase::getTermParents protected function Returns an array of all parents for a given term.
CshsFormatterBase::getTermsLabels protected function Returns the list of terms labels.
CshsFullHierarchyFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides CshsFormatterBase::defaultSettings
CshsFullHierarchyFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides CshsFormatterBase::settingsForm
CshsFullHierarchyFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides CshsFormatterBase::settingsSummary
CshsFullHierarchyFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
IsApplicable::isApplicable public static function
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.
TaxonomyStorages::$entityRepository protected property An instance of the "entity.repository" service.
TaxonomyStorages::$entityTypeManager protected property An instance of the "entity_type.manager" service.
TaxonomyStorages::$needsTranslatedContent private property The state of whether content translation should be used.
TaxonomyStorages::getStorage private function Returns the entity storage.
TaxonomyStorages::getTermStorage protected function Returns storage of the "taxonomy_term" entities. 1
TaxonomyStorages::getTranslationFromContext protected function Returns the entity translation to be used in the given context.
TaxonomyStorages::getVocabularyStorage protected function Returns storage of the "taxonomy_vocabulary" entities. 1
TaxonomyStorages::needsTranslatedContent protected function Returns the state of whether content translation needed.