class Fieldset in Field Group 8

Plugin implementation of the 'fieldset' formatter.

Plugin annotation

@FieldGroupFormatter(
  id = "fieldset",
  label = @Translation("Fieldset"),
  description = @Translation("This fieldgroup renders the inner content in a fieldset with the title as legend."),
  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\Fieldset

File

src/Plugin/field_group/FieldGroupFormatter/Fieldset.php, line 21

Namespace

Drupal\field_group\Plugin\field_group\FieldGroupFormatter

class Fieldset extends FieldGroupFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function preRender(&$element, $rendering_object) {
    $element += array(
      '#type' => 'fieldset',
      '#title' => Html::escape($this
        ->t($this
        ->getLabel())),
      '#pre_render' => array(),
      '#attributes' => array(),
    );
    if ($this
      ->getSetting('description')) {
      $element += array(
        '#description' => $this
          ->getSetting('description'),
      );

      // When a fieldset has a description, an id is required.
      if (!$this
        ->getSetting('id')) {
        $element['#id'] = Html::getId($this->group->group_name);
      }
    }
    if ($this
      ->getSetting('id')) {
      $element['#id'] = Html::getId($this
        ->getSetting('id'));
    }
    $classes = $this
      ->getClasses();
    if (!empty($classes)) {
      $element['#attributes'] += array(
        'class' => $classes,
      );
    }
    if ($this
      ->getSetting('required_fields')) {
      $element['#attached']['library'][] = 'field_group/formatter.fieldset';
      $element['#attached']['library'][] = 'field_group/core';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $form = parent::settingsForm();
    $form['description'] = array(
      '#title' => $this
        ->t('Description'),
      '#type' => 'textarea',
      '#default_value' => $this
        ->getSetting('description'),
      '#weight' => -4,
    );
    if ($this->context == 'form') {
      $form['required_fields'] = array(
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Mark group as required if it contains required fields.'),
        '#default_value' => $this
          ->getSetting('required_fields'),
        '#weight' => 2,
      );
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($this
      ->getSetting('required_fields')) {
      $summary[] = $this
        ->t('Mark as required');
    }
    if ($this
      ->getSetting('description')) {
      $summary[] = $this
        ->t('Description : @description', array(
        '@description' => $this
          ->getSetting('description'),
      ));
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultContextSettings($context) {
    $defaults = array(
      'description' => '',
    ) + 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::__construct	public	function	Constructs a FieldGroupFormatterBase object. Overrides PluginBase::__construct
Fieldset::defaultContextSettings	public static	function	Defines the default settings for this plugin. Overrides FieldGroupFormatterBase::defaultContextSettings
Fieldset::preRender	public	function	Allows the field group formatter to manipulate the field group array and attach the formatters rendering element. Overrides FieldGroupFormatterBase::preRender
Fieldset::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FieldGroupFormatterBase::settingsForm
Fieldset::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.