You are here

Home » API reference » Bibliography & Citation 8 » ContributorLabelFormatter.php

class ContributorLabelFormatter in Bibliography & Citation 8

Same name and namespace in other branches
  1. 2.0.x modules/bibcite_entity/src/Plugin/Field/FieldFormatter/ContributorLabelFormatter.php \Drupal\bibcite_entity\Plugin\Field\FieldFormatter\ContributorLabelFormatter

Plugin implementation of the 'entity reference label' formatter.

Plugin annotation


@FieldFormatter(
  id = "bibcite_contributor_label",
  label = @Translation("Label"),
  description = @Translation("Display the label of the contributors."),
  field_types = {
    "bibcite_contributor"
  }
)

Hierarchy

Expanded class hierarchy of ContributorLabelFormatter

File

modules/bibcite_entity/src/Plugin/Field/FieldFormatter/ContributorLabelFormatter.php, line 21

Namespace

Drupal\bibcite_entity\Plugin\Field\FieldFormatter
View source 
class ContributorLabelFormatter extends EntityReferenceLabelFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $show_role = $this
      ->getSetting('role');
    $show_category = $this
      ->getSetting('category');

    /* @var \Drupal\bibcite_entity\ContributorPropertiesServiceInterface $contributorPropertiesService */
    $contributorPropertiesService = \Drupal::service('bibcite_entity.contributor_properties_service');
    $roles = $contributorPropertiesService
      ->getRoles();
    $categories = $contributorPropertiesService
      ->getCategories();
    if ($show_role && !empty($roles) || $show_category && !empty($categories)) {
      $default_role_value = $contributorPropertiesService
        ->getDefaultRole();
      $default_role = isset($default_role_value) ? $roles[$default_role_value] : NULL;
      $default_category_value = $contributorPropertiesService
        ->getDefaultCategory();
      $default_category = isset($default_category_value) ? $categories[$default_category_value] : NULL;
      foreach ($items as $delta => $item) {
        $add = '';
        if ($show_role && !empty($roles)) {
          $role_value = $item
            ->get('role')
            ->getValue();
          if (isset($role_value, $roles[$role_value])) {
            $role = $roles[$role_value];
          }
          else {
            $role = $default_role;
          }
          if ($role) {
            $add .= ", {$role}";
          }
        }
        if ($show_category && !empty($categories)) {
          $category_value = $item
            ->get('category')
            ->getValue();
          if (isset($category_value, $categories[$category_value])) {
            $category = $categories[$category_value];
          }
          else {
            $category = $default_category;
          }
          if ($category) {
            $add .= ", {$category}";
          }
        }
        if (isset($elements[$delta]['#type']) && $elements[$delta]['#type'] == 'link') {
          $elements[$delta]['#title'] .= $add;
        }
        else {
          $elements[$delta]['#plain_text'] .= $add;
        }
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'role' => FALSE,
      'category' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['role'] = [
      '#title' => t('Show role'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('role'),
    ];
    $element['category'] = [
      '#title' => t('Show category'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('category'),
    ];
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContributorLabelFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceLabelFormatter::defaultSettings
ContributorLabelFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides EntityReferenceLabelFormatter::settingsForm
ContributorLabelFormatter::viewElements public function Builds a renderable array for a field value. Overrides EntityReferenceLabelFormatter::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::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
EntityReferenceLabelFormatter::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
EntityReferenceLabelFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
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.