You are here

Home » API reference » Twig Field 8 » TwigWidget.php

class TwigWidget in Twig Field 8

Defines the Twig field widget.

Plugin annotation


@FieldWidget(
  id = "twig",
  label = @Translation("Template editor"),
  field_types = {"twig"},
)

Hierarchy

Expanded class hierarchy of TwigWidget

1 file declares its use of TwigWidget
twig_field.module in ./twig_field.module
Primary module hooks for Twig field module.

File

src/Plugin/Field/FieldWidget/TwigWidget.php, line 20

Namespace

Drupal\twig_field\Plugin\Field\FieldWidget
View source 
class TwigWidget extends WidgetBase {
  use CodeMirrorPluginTrait;
  public const REQUIRED_CODEMIRROR_MODES = [
    'xml',
    'twig',
    'javascript',
    'css',
  ];

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = [
      'rows' => '5',
      'placeholder' => '',
      'mode' => 'html_twig',
    ];
    return $settings + self::getDefaultCodeMirrorSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['rows'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Rows'),
      '#default_value' => $this
        ->getSetting('rows'),
      '#required' => TRUE,
      '#min' => 1,
    ];
    $element['placeholder'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder'),
      '#default_value' => $this
        ->getSetting('placeholder'),
      '#description' => $this
        ->t('Text that will be shown inside the field until a value is entered.'),
    ];
    $element += self::buildCodeMirrorSettingsForm($this
      ->getSettings());
    unset($element['mode']);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Number of rows: @rows', [
      '@rows' => $settings['rows'],
    ]);
    if ($settings['placeholder'] != '') {
      $summary[] = $this
        ->t('Placeholder: @placeholder', [
        '@placeholder' => $settings['placeholder'],
      ]);
    }
    $summary[] = $this
      ->t('Load toolbar: @toolbar', [
      '@toolbar' => $this
        ->formatBoolean('toolbar'),
    ]);
    $summary[] = $this
      ->t('Line wrapping: @lineWrapping', [
      '@lineWrapping' => $this
        ->formatBoolean('lineWrapping'),
    ]);
    $summary[] = $this
      ->t('Line numbers: @lineNumbers', [
      '@lineNumbers' => $this
        ->formatBoolean('lineNumbers'),
    ]);
    $summary[] = $this
      ->t('Fold gutter: @foldGutter', [
      '@foldGutter' => $this
        ->formatBoolean('foldGutter'),
    ]);
    $summary[] = $this
      ->t('Auto close tags: @autoCloseTags', [
      '@autoCloseTags' => $this
        ->formatBoolean('autoCloseTags'),
    ]);
    $summary[] = $this
      ->t('Style active line: @styleActiveLine', [
      '@styleActiveLine' => $this
        ->formatBoolean('styleActiveLine'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $element['value'] = $element + [
      '#type' => 'codemirror',
      '#default_value' => isset($items[$delta]->value) ? $items[$delta]->value : NULL,
      '#rows' => $settings['rows'],
      '#placeholder' => $settings['placeholder'],
    ];

    // These options are not relevant to CodeMirror.
    unset($settings['rows'], $settings['placeholder']);
    $element['value']['#codemirror'] = $settings;
    $element['value']['#element_validate'] = [
      [
        get_class($this),
        'validateTemplate',
      ],
    ];
    $twig_field_name = $this->fieldDefinition
      ->getName();
    $widget_html_id = $twig_field_name . '-' . $delta;
    $element['value']['#attributes']['data-tf-textarea'] = $widget_html_id;
    $element['footer'] = [
      '#type' => 'container',
      '#title' => $this
        ->t('Twig context'),
      '#attributes' => [
        'class' => [
          'twig-field-editor-footer',
          'container-inline',
        ],
      ],
      '#weight' => 10,
    ];
    $options = [
      '' => $this
        ->t('- Select -'),
    ];
    $default_context_names = array_keys(twig_field_default_context());
    $options['Global'] = array_combine($default_context_names, $default_context_names);
    $display_mode_id = $this
      ->getFieldSetting('display_mode');
    $display_mode = EntityViewDisplay::load($display_mode_id);
    $components = $display_mode ? $display_mode
      ->getComponents() : [];
    ksort($components);
    foreach ($components as $field_name => $component) {

      // Skip components that has not type property like 'Links' as we are not
      // supporting them.
      if ($twig_field_name != $field_name && isset($component['type'])) {
        $options['Fields'][$field_name] = $field_name;
      }
    }
    $entity_type = $this->fieldDefinition
      ->getTargetEntityTypeId();
    $options['Other'][$entity_type] = $entity_type;
    $element['footer']['variables'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Variables'),
      '#options' => $options,
      '#attributes' => [
        'data-tf-variables' => $widget_html_id,
      ],
    ];
    $element['footer']['insert'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Insert'),
      '#attributes' => [
        'data-tf-insert' => $widget_html_id,
      ],
    ];
    $element['#attached']['library'][] = 'twig_field/editor';
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {

    // Footer is only used on client side. Unset it to avoid configuration
    // schema errors.
    foreach ($values as &$value) {
      unset($value['footer']);
    }
    return parent::massageFormValues($values, $form, $form_state);
  }

  /**
   * Validation callback for a Template element.
   */
  public static function validateTemplate(&$element, FormStateInterface $form_state) {
    $build = [
      '#type' => 'inline_template',
      '#template' => $element['#value'],
      '#context' => twig_field_default_context(),
    ];
    try {
      \Drupal::service('renderer')
        ->renderPlain($build);
    } catch (\Exception $exception) {
      $form_state
        ->setError($element, t('Template error: @error', [
        '@error' => $exception
          ->getMessage(),
      ]));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
CodeMirrorPluginTrait::buildCodeMirrorSettingsForm protected static function Returns a form to configure settings for the CodeMirror plugin.
CodeMirrorPluginTrait::formatBoolean protected function Returns formatted boolean setting value.
CodeMirrorPluginTrait::getAvailableButtons protected static function Returns a list of buttons available for CodeMirror.
CodeMirrorPluginTrait::getDefaultCodeMirrorSettings protected static function Returns the default settings for CodeMirror plugin.
CodeMirrorPluginTrait::normalizeMode protected static function Normalizes language mode.
CodeMirrorPluginTrait::setButtonsValue public static function Value callback for CodeMirror buttons.
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
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.
TwigWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TwigWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
TwigWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
TwigWidget::REQUIRED_CODEMIRROR_MODES public constant
TwigWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
TwigWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
TwigWidget::validateTemplate public static function Validation callback for a Template element.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5