class FaqFieldDefaultWidget in FAQ Field 8

Same name and namespace in other branches

2.0.x src/Plugin/Field/FieldWidget/FaqFieldDefaultWidget.php \Drupal\faqfield\Plugin\Field\FieldWidget\FaqFieldDefaultWidget

Plugin implementation of the 'faqfield_default' widget.

Plugin annotation


@FieldWidget(
  id = "faqfield_default",
  label = @Translation("FAQ Field"),
  field_types = {
    "faqfield"
  }
)

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\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\faqfield\Plugin\Field\FieldWidget\FaqFieldDefaultWidget

Expanded class hierarchy of FaqFieldDefaultWidget

File

src/Plugin/Field/FieldWidget/FaqFieldDefaultWidget.php, line 21

Namespace

Drupal\faqfield\Plugin\Field\FieldWidget

View source

class FaqFieldDefaultWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'answer_widget' => 'text_format',
      'question_title' => t('Question'),
      'answer_title' => t('Answer'),
      'question_field_required' => FALSE,
      'answer_field_required' => FALSE,
      'advanced' => [
        'question_length' => 255,
        'question_size' => 100,
        'question_rows' => 0,
        'answer_rows' => 3,
      ],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    // Add textfield for question.
    $element['question'] = [
      '#title' => Html::escape($this
        ->getSetting('question_title')),
      '#type' => 'textfield',
      '#default_value' => isset($items[$delta]->question) ? $items[$delta]->question : '',
      '#required' => $this
        ->getSetting('question_field_required'),
      '#maxlength' => $this
        ->getSetting('advanced')['question_length'],
      '#size' => $this
        ->getSetting('advanced')['question_size'],
      '#delta' => $delta,
      '#weight' => 0,
    ];

    // Question textfield can be configured to be a textarea.
    $question_rows = $this
      ->getSetting('advanced')['question_rows'];
    if ($question_rows > 0) {
      $element['question']['#type'] = 'textarea';
      $element['question']['#rows'] = $question_rows;
    }

    // Add textarea / formatable textarea / textfield for answer.
    $element['answer'] = [
      '#title' => Html::escape($this
        ->getSetting('answer_title')),
      '#type' => $this
        ->getSetting('answer_widget'),
      '#default_value' => isset($items[$delta]->answer) ? $items[$delta]->answer : '',
      '#required' => $this
        ->getSetting('answer_field_required'),
      '#delta' => $delta,
      '#weight' => 1,
      '#rows' => $this
        ->getSetting('advanced')['answer_rows'],
    ];

    // We choose the source output format depending on the input type.
    if ($this
      ->getSetting('answer_widget') == 'text_format') {
      $default_format = $this
        ->getFieldSetting('default_format');
      $element['answer']['#format'] = isset($items[$delta]->answer_format) ? $items[$delta]->answer_format : $default_format;
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);

    // Input for the count of rows for the answer field.
    $elements['answer_widget'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Answer widget'),
      '#default_value' => $this
        ->getSetting('answer_widget'),
      '#options' => [
        'textarea' => $this
          ->t('Textarea'),
        'text_format' => $this
          ->t('Formatable textarea'),
        'textfield' => $this
          ->t('Textfield'),
      ],
      '#required' => TRUE,
      '#description' => $this
        ->t('What form widget to use for answer input. Formatable textarea is needed for WYSIWYG editors.'),
    ];

    // Input for custom title of questions.
    $elements['question_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Question widget title'),
      '#placeholder' => $this
        ->t('Question'),
      '#default_value' => $this
        ->getSetting('question_title'),
      '#description' => $this
        ->t('Custom title of question widget.'),
      '#maxlength' => 50,
      '#size' => 20,
    ];

    // Input for custom title of answers.
    $elements['answer_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Answer widget title'),
      '#placeholder' => $this
        ->t('Answer'),
      '#default_value' => $this
        ->getSetting('answer_title'),
      '#description' => $this
        ->t('Custom title of answer widget.'),
      '#maxlength' => 50,
      '#size' => 20,
    ];

    // Set required field for questions.
    $elements['question_field_required'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Required Field Question'),
      '#default_value' => $this
        ->getSetting('question_field_required'),
      '#description' => $this
        ->t('Set field question required.'),
    ];

    // Set required field for answers.
    $elements['answer_field_required'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Required Field Answer'),
      '#default_value' => $this
        ->getSetting('answer_field_required'),
      '#description' => $this
        ->t('Set field answer required .'),
    ];

    // We put more advanced settings into a collapsed fieldset.
    $elements['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
      '#collapsed' => TRUE,
    ];

    // Input for the maximum length of questions.
    $elements['advanced']['question_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Question length'),
      '#placeholder' => 255,
      '#default_value' => $this
        ->getSetting('advanced')['question_length'],
      '#description' => $this
        ->t('Maximum length of questions (Between 1 and 255).'),
      '#min' => 1,
      '#max' => 255,
      '#step' => 1,
    ];

    // Input for the size of the question input.
    $elements['advanced']['question_size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Question field size'),
      '#placeholder' => 100,
      '#default_value' => $this
        ->getSetting('advanced')['question_size'],
      '#description' => $this
        ->t('Width of the question widget.'),
      '#min' => 10,
      '#max' => 255,
      '#step' => 1,
    ];

    // Input for the count of rows for the answer field.
    $elements['advanced']['question_rows'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Question widget'),
      '#default_value' => $this
        ->getSetting('advanced')['question_rows'],
      '#options' => [
        $this
          ->t('Fieldset'),
        $this
          ->t('Textarea, 1 row'),
        $this
          ->t('Textarea, 2 row'),
        $this
          ->t('Textarea, 3 row'),
        $this
          ->t('Textarea, 4 row'),
      ],
      '#required' => TRUE,
      '#description' => $this
        ->t('Number of rows used for the question textfield/textarea.'),
    ];

    // Input for the count of rows for the answer field.
    $elements['advanced']['answer_rows'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Answer rows'),
      '#placeholder' => 3,
      '#default_value' => $this
        ->getSetting('advanced')['answer_rows'],
      '#description' => $this
        ->t('Number of rows used for the answer textarea.'),
      '#required' => TRUE,
      '#states' => [
        'invisible' => [
          ':input[id="edit-fields-field-faq-settings-edit-form-settings-answer-widget"]' => [
            'value' => 'textfield',
          ],
        ],
      ],
      '#min' => 1,
      '#step' => 1,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];

    // Answer widget setting.
    $answer_widget_options = [
      'textarea' => $this
        ->t('Textarea'),
      'text_format' => $this
        ->t('Formatable textarea'),
      'textfield' => $this
        ->t('Textfield'),
    ];
    $answer_widget = $this
      ->getSetting('answer_widget');
    if (isset($answer_widget_options[$answer_widget])) {
      $summary[] = $this
        ->t('Answer widget : @answer', [
        '@answer' => $answer_widget_options[$answer_widget],
      ]);
    }
    $summary[] = $this
      ->t('Answer widget title: @title', [
      '@title' => $this
        ->getSetting('answer_title'),
    ]);
    $summary[] = $this
      ->t('Question widget title: @title', [
      '@title' => $this
        ->getSetting('question_title'),
    ]);
    return $summary;
  }

}

Members

Name	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.
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
FaqFieldDefaultWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FaqFieldDefaultWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
FaqFieldDefaultWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
FaqFieldDefaultWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::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.
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::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
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

You are here

class FaqFieldDefaultWidget in FAQ Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation