You are here

Home » API reference » Field Group 8.3 » Tabs.php

class Tabs in Field Group 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/field_group/FieldGroupFormatter/Tabs.php \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\Tabs

Plugin implementation of the 'horizontal_tabs' formatter.

Plugin annotation


@FieldGroupFormatter(
  id = "tabs",
  label = @Translation("Tabs"),
  description = @Translation("This fieldgroup renders child groups in its own tabs wrapper."),
  supported_contexts = {
    "form",
    "view",
  }
)

Hierarchy

Expanded class hierarchy of Tabs

1 string reference to 'Tabs'
EntityDisplayTest::testTabs in tests/src/Functional/EntityDisplayTest.php
Test the tabs formatter.

File

src/Plugin/field_group/FieldGroupFormatter/Tabs.php, line 24

Namespace

Drupal\field_group\Plugin\field_group\FieldGroupFormatter
View source 
class Tabs extends FieldGroupFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function process(&$element, $processed_object) {

    // Keep using preRender parent for BC.
    parent::preRender($element, $processed_object);
    $element += [
      '#prefix' => '<div class=" ' . implode(' ', $this
        ->getClasses()) . '">',
      '#suffix' => '</div>',
      '#tree' => TRUE,
      '#parents' => [
        $this->group->group_name,
      ],
      '#default_tab' => '',
    ];
    if ($this
      ->getSetting('id')) {
      $element['#id'] = Html::getUniqueId($this
        ->getSetting('id'));
    }

    // By default tabs don't have titles but you can override it in the theme.
    if ($this
      ->getLabel()) {
      $element['#title'] = $this
        ->getLabel();
    }
    $element += [
      '#type' => $this
        ->getSetting('direction') . '_tabs',
      '#theme_wrappers' => [
        $this
          ->getSetting('direction') . '_tabs',
      ],
    ];

    // Add auto-disable breakpoint.
    if ($width_breakpoint = $this
      ->getSetting('width_breakpoint')) {
      $element['#attached']['drupalSettings']['widthBreakpoint'] = $width_breakpoint;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preRender(&$element, $rendering_object) {
    $this
      ->process($element, $rendering_object);
    if ($this
      ->getSetting('direction') == 'vertical') {
      $form_state = new FormState();
      $complete_form = [];
      $element = VerticalTabs::processVerticalTabs($element, $form_state, $complete_form);
    }
    else {
      $form_state = new FormState();
      $complete_form = [];
      $element = HorizontalTabs::processHorizontalTabs($element, $form_state, $complete_form);
    }

    // Make sure the group has 1 child. This is needed to succeed at form_pre_render_vertical_tabs().
    // Skipping this would force us to move all child groups to this array, making it an un-nestable.
    $element['group']['#groups'][$this->group->group_name] = [
      0 => [],
    ];
    $element['group']['#groups'][$this->group->group_name]['#group_exists'] = TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $form = parent::settingsForm();
    $form['direction'] = [
      '#title' => $this
        ->t('Direction'),
      '#type' => 'select',
      '#options' => [
        'vertical' => $this
          ->t('Vertical'),
        'horizontal' => $this
          ->t('Horizontal'),
      ],
      '#default_value' => $this
        ->getSetting('direction'),
      '#weight' => 1,
    ];
    $form['width_breakpoint'] = [
      '#title' => $this
        ->t('Width Breakpoint'),
      '#description' => $this
        ->t('Auto-disable the Tabs widget if the window width is equal or smaller than this breakpoint.'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('width_breakpoint'),
      '#weight' => 2,
      '#min' => 0,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Direction: @direction', [
      '@direction' => $this
        ->getSetting('direction'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultContextSettings($context) {
    return [
      'direction' => 'vertical',
      'width_breakpoint' => 640,
    ] + parent::defaultContextSettings($context);
  }

  /**
   * {@inheritdoc}
   */
  public function getClasses() {
    $classes = parent::getClasses();
    $classes[] = 'field-group-' . $this->group->format_type . '-wrapper';
    return $classes;
  }

}

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
FieldGroupFormatterBase::$context protected property The context mode.
FieldGroupFormatterBase::$group protected property The group this formatter needs to render.
FieldGroupFormatterBase::$label protected property The label display setting.
FieldGroupFormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FieldGroupFormatterBase::$viewMode protected property The view mode.
FieldGroupFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FieldGroupFormatterBase::getLabel public function Get the current label.
FieldGroupFormatterBase::validateCssClass public static function Validate the entered css class from the submitted format settings.
FieldGroupFormatterBase::validateId public static function Validate the entered id attribute from the submitted format settings.
FieldGroupFormatterBase::__construct public function Constructs a FieldGroupFormatterBase object. Overrides PluginBase::__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.
Tabs::defaultContextSettings public static function Defines the default settings for this plugin. Overrides FieldGroupFormatterBase::defaultContextSettings
Tabs::getClasses public function Get the classes to add to the group. Overrides FieldGroupFormatterBase::getClasses
Tabs::preRender public function Allows the field group formatter to manipulate the field group array and attach the formatters rendering element. Overrides FieldGroupFormatterBase::preRender
Tabs::process public function Allows the field group formatter to manipulate the field group array and attach the formatters elements. The process method is called in the #process part of theme layer, and is currently used for forms. The preRender method is called in the… Overrides FieldGroupFormatterBase::process
Tabs::settingsForm public function Returns a form to configure settings for the formatter. Overrides FieldGroupFormatterBase::settingsForm
Tabs::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FieldGroupFormatterBase::settingsSummary