You are here

Home » API reference » Field Group 8 » HtmlElement.php

class HtmlElement in Field Group 8

Same name in this branch
  1. 8 src/Element/HtmlElement.php \Drupal\field_group\Element\HtmlElement
  2. 8 src/Plugin/field_group/FieldGroupFormatter/HtmlElement.php \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\HtmlElement
Same name and namespace in other branches
  1. 8.3 src/Plugin/field_group/FieldGroupFormatter/HtmlElement.php \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\HtmlElement

Plugin implementation of the 'html_element' formatter.

Plugin annotation


@FieldGroupFormatter(
  id = "html_element",
  label = @Translation("HTML element"),
  description = @Translation("This fieldgroup renders the inner content in a HTML element with classes and attributes."),
  supported_contexts = {
    "form",
    "view",
  }
)

Hierarchy

Expanded class hierarchy of HtmlElement

File

src/Plugin/field_group/FieldGroupFormatter/HtmlElement.php, line 23

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function preRender(&$element, $rendering_object) {
    parent::preRender($element, $rendering_object);
    $element_attributes = new Attribute();
    if ($this
      ->getSetting('attributes')) {

      // This regex split the attributes string so that we can pass that
      // later to drupal_attributes().
      preg_match_all('/([^\\s=]+)="([^"]+)"/', $this
        ->getSetting('attributes'), $matches);

      // Put the attribute and the value together.
      foreach ($matches[1] as $key => $attribute) {
        $element_attributes[$attribute] = $matches[2][$key];
      }
    }

    // Add the id to the attributes array.
    if ($this
      ->getSetting('id')) {
      $element_attributes['id'] = Html::getId($this
        ->getSetting('id'));
    }

    // Add the classes to the attributes array.
    $classes = $this
      ->getClasses();
    if (!empty($classes)) {
      if (!isset($element_attributes['class'])) {
        $element_attributes['class'] = array();
      }
      else {
        $element_attributes['class'] = array(
          $element_attributes['class'],
        );
      }
      $element_attributes['class'] = array_merge($classes, $element_attributes['class']
        ->value());
    }
    $element['#effect'] = $this
      ->getSetting('effect');
    $element['#speed'] = $this
      ->getSetting('speed');
    $element['#type'] = 'field_group_html_element';
    $element['#wrapper_element'] = $this
      ->getSetting('element');
    $element['#attributes'] = $element_attributes;
    if ($this
      ->getSetting('show_label')) {
      $element['#title_element'] = $this
        ->getSetting('label_element');
      $element['#title'] = Html::escape($this
        ->t($this
        ->getLabel()));
    }
    $form_state = new FormState();
    \Drupal\field_group\Element\HtmlElement::processHtmlElement($element, $form_state);
    if ($this
      ->getSetting('required_fields')) {
      $element['#attributes']['class'][] = 'field-group-html-element';
      $element['#attached']['library'][] = 'field_group/formatter.html_element';
      $element['#attached']['library'][] = 'field_group/core';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $form = parent::settingsForm();
    $form['element'] = array(
      '#title' => $this
        ->t('Element'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('element'),
      '#description' => $this
        ->t('E.g. div, section, aside etc.'),
      '#weight' => 1,
    );
    $form['show_label'] = array(
      '#title' => $this
        ->t('Show label'),
      '#type' => 'select',
      '#options' => array(
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ),
      '#default_value' => $this
        ->getSetting('show_label'),
      '#weight' => 2,
      '#attributes' => array(
        'data-fieldgroup-selector' => 'show_label',
      ),
    );
    $form['label_element'] = array(
      '#title' => $this
        ->t('Label element'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('label_element'),
      '#weight' => 3,
      '#states' => array(
        'visible' => array(
          ':input[data-fieldgroup-selector="show_label"]' => array(
            'value' => 1,
          ),
        ),
      ),
    );
    if ($this->context == 'form') {
      $form['required_fields'] = array(
        '#title' => $this
          ->t('Mark group as required if it contains required fields.'),
        '#type' => 'checkbox',
        '#default_value' => $this
          ->getSetting('required_fields'),
        '#weight' => 4,
      );
    }
    $form['attributes'] = array(
      '#title' => $this
        ->t('Attributes'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('attributes'),
      '#description' => $this
        ->t('E.g. name="anchor"'),
      '#weight' => 5,
    );
    $form['effect'] = array(
      '#title' => $this
        ->t('Effect'),
      '#type' => 'select',
      '#options' => array(
        'none' => $this
          ->t('None'),
        'collapsible' => $this
          ->t('Collapsible'),
        'blind' => $this
          ->t('Blind'),
      ),
      '#default_value' => $this
        ->getSetting('effect'),
      '#weight' => 6,
      '#attributes' => array(
        'data-fieldgroup-selector' => 'effect',
      ),
    );
    $form['speed'] = array(
      '#title' => $this
        ->t('Speed'),
      '#type' => 'select',
      '#options' => array(
        'slow' => $this
          ->t('Slow'),
        'fast' => $this
          ->t('Fast'),
      ),
      '#default_value' => $this
        ->getSetting('speed'),
      '#weight' => 7,
      '#states' => array(
        '!visible' => array(
          ':input[data-fieldgroup-selector="effect"]' => array(
            'value' => 'none',
          ),
        ),
      ),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Element: @element', array(
      '@element' => $this
        ->getSetting('element'),
    ));
    if ($this
      ->getSetting('show_label')) {
      $summary[] = $this
        ->t('Label element: @element', array(
        '@element' => $this
          ->getSetting('label_element'),
      ));
    }
    if ($this
      ->getSetting('attributes')) {
      $summary[] = $this
        ->t('Attributes: @attributes', array(
        '@attributes' => $this
          ->getSetting('attributes'),
      ));
    }
    if ($this
      ->getSetting('required_fields')) {
      $summary[] = $this
        ->t('Mark as required');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultContextSettings($context) {
    $defaults = array(
      'element' => 'div',
      'show_label' => 0,
      'label_element' => 'h3',
      'effect' => 'none',
      'speed' => 'fast',
      'attributes' => '',
    ) + parent::defaultSettings($context);
    if ($context == 'form') {
      $defaults['required_fields'] = 1;
    }
    return $defaults;
  }

}

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