You are here

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

abstract class FieldGroupFormatterBase in Field Group 8.3

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

Base class for 'Fieldgroup formatter' plugin implementations.

Hierarchy

Expanded class hierarchy of FieldGroupFormatterBase

7 files declare their use of FieldGroupFormatterBase
Accordion.php in src/Plugin/field_group/FieldGroupFormatter/Accordion.php
AccordionItem.php in src/Plugin/field_group/FieldGroupFormatter/AccordionItem.php
Details.php in src/Plugin/field_group/FieldGroupFormatter/Details.php
Fieldset.php in src/Plugin/field_group/FieldGroupFormatter/Fieldset.php
HtmlElement.php in src/Plugin/field_group/FieldGroupFormatter/HtmlElement.php

... See full list

File

src/FieldGroupFormatterBase.php, line 13

Namespace

Drupal\field_group
View source 
abstract class FieldGroupFormatterBase extends PluginSettingsBase implements FieldGroupFormatterInterface {

  /**
   * The group this formatter needs to render.
   *
   * @var object
   */
  protected $group;

  /**
   * The formatter settings.
   *
   * @var array
   */
  protected $settings;

  /**
   * The label display setting.
   *
   * @var string
   */
  protected $label;

  /**
   * The view mode.
   *
   * @var string
   */
  protected $viewMode;

  /**
   * The context mode.
   *
   * @var string
   */
  protected $context;

  /**
   * Constructs a FieldGroupFormatterBase object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \stdClass $group
   *   The group object.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label.
   */
  public function __construct($plugin_id, $plugin_definition, \stdClass $group, array $settings, $label) {
    parent::__construct([], $plugin_id, $plugin_definition);
    $this->group = $group;
    $this->settings = $settings;
    $this->label = $label;
    $this->context = $group->context;
  }

  /**
   * Get the current label.
   *
   * @return string
   *   The current label.
   */
  public function getLabel() {
    return $this->label;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $class = get_class($this);
    $form = [];
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Field group label'),
      '#default_value' => $this->label,
      '#weight' => -5,
    ];
    $form['show_empty_fields'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display element also when empty'),
      '#description' => $this
        ->t('Display this field group even if the contained fields are currently empty.'),
      '#default_value' => $this
        ->getSetting('show_empty_fields'),
    ];
    $form['id'] = [
      '#title' => $this
        ->t('ID'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('id'),
      '#weight' => 10,
      '#element_validate' => [
        [
          $class,
          'validateId',
        ],
      ],
    ];
    $form['classes'] = [
      '#title' => $this
        ->t('Extra CSS classes'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('classes'),
      '#weight' => 11,
      '#element_validate' => [
        [
          $class,
          'validateCssClass',
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('formatter')) {
      $summary[] = $this->pluginDefinition['label'] . ': ' . $this
        ->getSetting('formatter');
    }
    if ($this
      ->getSetting('show_empty_fields')) {
      $summary[] = $this
        ->t('Show Empty Fields');
    }
    if ($this
      ->getSetting('id')) {
      $summary[] = $this
        ->t('Id: @id', [
        '@id' => $this
          ->getSetting('id'),
      ]);
    }
    if ($this
      ->getSetting('classes')) {
      $summary[] = \Drupal::translation()
        ->translate('Extra CSS classes: @classes', [
        '@classes' => $this
          ->getSetting('classes'),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return self::defaultContextSettings('view');
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultContextSettings($context) {
    return [
      'classes' => '',
      'id' => '',
    ];
  }

  /**
   * Get the classes to add to the group.
   */
  protected function getClasses() {
    $classes = [];

    // Add a required-fields class to trigger the js.
    if ($this
      ->getSetting('required_fields')) {
      $classes[] = 'required-fields';
      $classes[] = 'field-group-' . str_replace('_', '-', $this
        ->getBaseId());
    }
    if ($this
      ->getSetting('classes')) {
      $classes = array_merge($classes, explode(' ', trim($this
        ->getSetting('classes'))));
    }
    return $classes;
  }

  /**
   * {@inheritdoc}
   */
  public function preRender(&$element, $rendering_object) {
    $element['#group_name'] = $this->group->group_name;
    $element['#entity_type'] = $this->group->entity_type;
    $element['#bundle'] = $this->group->bundle;
    $element['#show_empty_fields'] = $this
      ->getSetting('show_empty_fields');
  }

  /**
   * {@inheritdoc}
   */
  public function process(&$element, $processed_object) {
    $element['#group_name'] = $this->group->group_name;
    $element['#entity_type'] = $this->group->entity_type;
    $element['#bundle'] = $this->group->bundle;

    // BC: Call the pre render layer to not break contrib plugins.
    return $this
      ->preRender($element, $processed_object);
  }

  /**
   * Validate the entered css class from the submitted format settings.
   *
   * @param array $element
   *   The validated element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of the form.
   */
  public static function validateCssClass(array $element, FormStateInterface $form_state) {
    $form_state_values = $form_state
      ->getValues();
    $plugin_name = $form_state
      ->get('plugin_settings_edit');
    if (!empty($form_state_values['fields'][$plugin_name]['settings_edit_form']['settings']['classes']) && !preg_match('!^[A-Za-z0-9-_ ]+$!', $form_state_values['fields'][$plugin_name]['settings_edit_form']['settings']['classes'])) {
      $form_state
        ->setError($element, t('The css class must include only letters, numbers, underscores and dashes.'));
    }
  }

  /**
   * Validate the entered id attribute from the submitted format settings.
   *
   * @param array $element
   *   The validated element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The state of the form.
   */
  public static function validateId(array $element, FormStateInterface $form_state) {
    $form_state_values = $form_state
      ->getValues();
    $plugin_name = $form_state
      ->get('plugin_settings_edit');
    if (!empty($form_state_values['fields'][$plugin_name]['settings_edit_form']['settings']['id']) && !preg_match('!^[A-Za-z0-9-_]+$!', $form_state_values['fields'][$plugin_name]['settings_edit_form']['settings']['id'])) {
      $form_state
        ->setError($element, t('The id must include only letters, numbers, underscores and dashes.'));
    }
  }

}

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::defaultContextSettings public static function Defines the default settings for this plugin. Overrides FieldGroupFormatterInterface::defaultContextSettings 7
FieldGroupFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FieldGroupFormatterBase::getClasses protected function Get the classes to add to the group. 1
FieldGroupFormatterBase::getLabel public function Get the current label.
FieldGroupFormatterBase::preRender public function Allows the field group formatter to manipulate the field group array and attach the formatters rendering element. Overrides FieldGroupFormatterInterface::preRender 7
FieldGroupFormatterBase::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 FieldGroupFormatterInterface::process 7
FieldGroupFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FieldGroupFormatterInterface::settingsForm 7
FieldGroupFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FieldGroupFormatterInterface::settingsSummary 6
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.