You are here

Home » API reference » Taxonomy Formatter 8 » TaxonomyTermReferenceCsv.php

class TaxonomyTermReferenceCsv in Taxonomy Formatter 8

Plugin annotation


@FieldFormatter(
 id = "taxonomy_term_reference_csv",
 label = @Translation("Delimited"),
 field_types = {
  "entity_reference"
 }
)

Hierarchy

Expanded class hierarchy of TaxonomyTermReferenceCsv

File

src/Plugin/Field/FieldFormatter/TaxonomyTermReferenceCsv.php, line 25
Contains \Drupal\taxonomy_formatter\Plugin\Field\FieldFormatter\TaxonomyTermReferenceCsv.

Namespace

Drupal\taxonomy_formatter\Plugin\Field\FieldFormatter
View source 
class TaxonomyTermReferenceCsv extends EntityReferenceFormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'links_option' => FALSE,
      'separator_option' => ', ',
      'element_option' => '- None -',
      'wrapper_option' => '- None -',
      'element_class' => '',
      'wrapper_class' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = array();
    $element['links_option'] = array(
      '#type' => 'checkbox',
      '#title' => t('Links'),
      '#description' => t('When checked terms will be displayed as links'),
      '#default_value' => $this
        ->getSetting('links_option'),
    );
    $element['separator_option'] = array(
      '#type' => 'textfield',
      '#title' => t('Separator'),
      '#description' => t('The separator to use, including leading and trailing spaces'),
      '#default_value' => $this
        ->getSetting('separator_option'),
    );
    $element['element_option'] = array(
      '#type' => 'select',
      '#title' => t('Element'),
      '#description' => t('The HTML element to wrap each tag in'),
      '#default_value' => $this
        ->getSetting('element_option'),
      '#options' => array(
        '- None -' => '- None -',
        'span' => 'span',
        'h1' => 'h1',
        'h2' => 'h2',
        'h3' => 'h3',
        'h4' => 'h4',
        'h5' => 'h5',
        'strong' => 'h6',
        'em' => 'h7',
      ),
    );
    $element['element_class'] = array(
      '#type' => 'textfield',
      '#title' => t('Element Class'),
      '#description' => t('The class assigned to the element'),
      '#default_value' => $this
        ->getSetting('element_class'),
    );
    $element['wrapper_option'] = array(
      '#type' => 'select',
      '#title' => t('Wrapper'),
      '#description' => t('The HTML element to wrap the entire collection in'),
      '#default_value' => $this
        ->getSetting('wrapper_option'),
      '#options' => array(
        '- None -' => '- None -',
        'div' => 'div',
        'span' => 'span',
        'h1' => 'h1',
        'h2' => 'h2',
        'h3' => 'h3',
        'h4' => 'h4',
        'h5' => 'h5',
        'p' => 'p',
        'strong' => 'strong',
        'em' => 'em',
      ),
    );
    $element['wrapper_class'] = array(
      '#type' => 'textfield',
      '#title' => t('Wrapper Class'),
      '#description' => t('The class assigned to the wrapper'),
      '#default_value' => $this
        ->getSetting('wrapper_class'),
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $summary[] = t('The Terms will be displayed separated by "@separator"', array(
      '@separator' => $this
        ->getSetting('separator_option'),
    ));
    if ($this
      ->getSetting('links_option')) {
      $summary[] = $this
        ->t('<br>The terms will link to the term pages');
    }
    if ($this
      ->getSetting('element_option') != "- None -") {
      $summary[] = t('<br>Elements will be wrapped in a "@element" tag', array(
        '@element' => $this
          ->getSetting('element_option'),
      ));
      if (!empty($settings['element_class'])) {
        $summary[] = t(' with the class of @elemclass', array(
          '@elemclass' => $this
            ->getSetting('element_class'),
        ));
      }
    }
    if ($this
      ->getSetting('wrapper_option') != "- None -") {
      $summary[] = t('<br>The entire list will be wrapped in a "@wrapper" tag', array(
        '@wrapper' => $this
          ->getSetting('wrapper_option'),
      ));
      if (!empty($settings['wrapper_class'])) {
        $summary[] = t(' with the class of @wrapclass', array(
          '@wrapclass' => $this
            ->getSetting('wrapper_class'),
        ));
      }
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = array();
    $separator = SafeMarkup::checkPlain($this
      ->getSetting('separator_option'));
    if ($this
      ->getSetting('element_option') != '- None -') {
      $elementwrap[0] = '<' . $this
        ->getSetting('element_option') . ' class="' . SafeMarkup::checkPlain($this
        ->getSetting('element_class')) . '">';
      $elementwrap[1] = '</' . $this
        ->getSetting('element_option') . '>';
    }
    else {
      $elementwrap[0] = '';
      $elementwrap[1] = '';
    }
    if ($this
      ->getSetting('wrapper_option') != '- None -') {
      $wrapper[0] = '<' . $this
        ->getSetting('wrapper_option') . ' class="' . \Drupal\Component\Utility\SafeMarkup::checkPlain($this
        ->getSetting('wrapper_class')) . '">';
      $wrapper[1] = '</' . $this
        ->getSetting('wrapper_option') . '>';
    }
    else {
      $wrapper[0] = '';
      $wrapper[1] = '';
    }
    $formatted = '';
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {
      if ($this
        ->getSetting('links_option')) {
        $formatted .= $elementwrap[0] . $entity
          ->toLink()
          ->toString() . $elementwrap[1] . $separator;
      }
      else {
        $formatted .= $elementwrap[0] . SafeMarkup::checkPlain($entity
          ->label()) . $elementwrap[1] . $separator;
      }
    }
    $length = strlen($separator);
    $formatted = substr($formatted, 0, -$length);
    $formatted = $wrapper[0] . $formatted . $wrapper[1];
    $element[0]['#markup'] = $formatted;
    return $element;
  }

}

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::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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.
TaxonomyTermReferenceCsv::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TaxonomyTermReferenceCsv::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TaxonomyTermReferenceCsv::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TaxonomyTermReferenceCsv::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements