class HtmlElement in Field Group 8.3

Same name in this branch

8.3 src/Element/HtmlElement.php \Drupal\field_group\Element\HtmlElement
8.3 src/Plugin/field_group/FieldGroupFormatter/HtmlElement.php \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\HtmlElement

Same name and namespace in other branches

8 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

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\field_group\FieldGroupFormatterBase implements FieldGroupFormatterInterface
    class \Drupal\field_group\Plugin\field_group\FieldGroupFormatter\HtmlElement

Expanded class hierarchy of HtmlElement

File

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

Namespace

Drupal\field_group\Plugin\field_group\FieldGroupFormatter

View source

class HtmlElement extends FieldGroupFormatterBase {

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

    // Keep using preRender parent for BC.
    parent::preRender($element, $processed_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::getUniqueId($this
        ->getSetting('id'));
    }

    // Add the classes to the attributes array.
    $classes = $this
      ->getClasses();
    if (!empty($classes)) {
      if (!isset($element_attributes['class'])) {
        $element_attributes['class'] = [];
      }
      else {
        $element_attributes['class'] = [
          $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'] = $this
        ->getLabel();

      // Prevent \Drupal\content_translation\ContentTranslationHandler::addTranslatabilityClue()
      // from adding an incorrect suffix to the field group title.
      $element['#multilingual'] = TRUE;
      $element['#title_attributes'] = new Attribute();
      if (!empty($this
        ->getSetting('label_element_classes'))) {
        $element['#title_attributes']
          ->addClass(explode(' ', $this
          ->getSetting('label_element_classes')));
      }
      if (!empty($this
        ->getSetting('effect')) && $this
        ->getSetting('effect') !== 'none') {
        $element['#title_attributes']
          ->addClass('field-group-toggler');
      }
    }
    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 preRender(&$element, $rendering_object) {
    $this
      ->process($element, $rendering_object);
    $form_state = new FormState();
    HtmlElementRenderElement::processHtmlElement($element, $form_state);
  }

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

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

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

}

Members

Name	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::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
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::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
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.

You are here

class HtmlElement in Field Group 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation