You are here

Home » API reference » Field Collection Tab formatter 8 » FieldCollectionTabsFormatter.php

class FieldCollectionTabsFormatter in Field Collection Tab formatter 8

Plugin implementation of the 'tabs' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_collection_tabs",
  label = @Translation("Tabs"),
  field_types = {
    "field_collection"
  }
)

Hierarchy

Expanded class hierarchy of FieldCollectionTabsFormatter

File

src/Plugin/Field/FieldFormatter/FieldCollectionTabsFormatter.php, line 26

Namespace

Drupal\field_collection_tabs\Plugin\Field\FieldFormatter
View source 
class FieldCollectionTabsFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity display repository
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The entity field manager
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The entity type manager
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityDisplayRepositoryInterface $entity_display_repository, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityDisplayRepository = $entity_display_repository;

    // Used to get all view modes for all entity types
    $this->entityFieldManager = $entity_field_manager;

    // Used to get all fields of the entity type
    $this->entityTypeManager = $entity_type_manager;

    // Used to get the render array of the entity
  }
  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_display.repository'), $container
      ->get('entity_field.manager'), $container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = array();
    $options = array(
      $this
        ->t('No titles'),
    );
    $field_definition = $this->fieldDefinition;
    $fields = $this->entityFieldManager
      ->getFieldDefinitions('field_collection_item', $field_definition
      ->getName());
    foreach ($fields as $field_name => $field) {
      if ($field
        ->getFieldStorageDefinition()
        ->isBaseField() == FALSE && $field
        ->getType() == 'string') {
        $options[$field_name] = $this
          ->t($field
          ->getLabel());
      }
    }
    $elements['title_field'] = array(
      '#type' => 'select',
      '#title' => 'Field to use for tab titles',
      '#description' => t('Select the field to use for tab titles'),
      '#default_value' => $this
        ->getSetting('title_field'),
      '#options' => $options,
    );
    $displays = $this->entityDisplayRepository
      ->getAllViewModes();
    if (isset($displays['field_collection_item']) && !empty($displays['field_collection_item'])) {
      $displays = $displays['field_collection_item'];
      $options = array(
        $this
          ->t('Default'),
      );
      foreach ($displays as $view_mode => $info) {
        $options[$view_mode] = $info['label'];
      }
      $elements['view_mode'] = array(
        '#type' => 'select',
        '#title' => t('View mode'),
        '#options' => $options,
        '#default_value' => $this
          ->getSetting('view_mode'),
        '#description' => t('Select the view mode'),
      );
    }
    else {
      $elements['view_mode'] = array(
        '#markup' => $this
          ->t('No custom view modes for Field Collection Items'),
      );
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];

    // Implement settings summary.
    $summary[] = $this
      ->getSetting('title_field') ? $this
      ->t('Title field: ' . $this
      ->getSetting('title_field')) : $this
      ->t('Numbered Tabs');
    $summary[] = $this
      ->getsetting('view_mode') ? $this
      ->t('View Mode: ' . $this
      ->getSetting('view_mode')) : $this
      ->t('View Mode: Full');
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $titles = [];
    $tabs = [];
    $title_field = !empty($this
      ->getSetting('title_field')) ? $this
      ->getSetting('title_field') : FALSE;
    $view_mode = !empty($this
      ->getSetting('view_mode')) ? $this
      ->getSetting('view_mode') : 'full';
    foreach ($items as $delta => $item) {
      if ($item->value !== NULL) {
        $field_collection_item = $item
          ->getFieldCollectionItem();
        $title = $field_collection_item
          ->get($title_field)->value;

        // Preventing a tab from not having a title, seems bad to not have a title for a tab.
        if ($title == '' || $title_field == FALSE) {
          $title = "Tab " . ($delta + 1);
        }
        $titles[] = $title;
        $render_item = $this->entityTypeManager
          ->getViewBuilder('field_collection_item')
          ->view($field_collection_item, $view_mode);
        $tabs[] = $render_item;
      }
    }
    $render_array = [
      '#theme' => 'field_collection_tabs',
      '#titles' => $titles,
      '#tabs' => $tabs,
      '#field_name' => $title_field,
      '#attached' => [
        'library' => [
          'field_collection_tabs/field_collection_tabs',
        ],
      ],
    ];
    return $render_array;
  }

}

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
FieldCollectionTabsFormatter::$entityDisplayRepository protected property The entity display repository
FieldCollectionTabsFormatter::$entityFieldManager protected property The entity field manager
FieldCollectionTabsFormatter::$entityTypeManager protected property The entity type manager
FieldCollectionTabsFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FieldCollectionTabsFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FieldCollectionTabsFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FieldCollectionTabsFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FieldCollectionTabsFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FieldCollectionTabsFormatter::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct
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.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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.