You are here

Home » API reference » Formatter Field 8 » FormatterWidget.php

class FormatterWidget in Formatter Field 8

Defines the 'formatter' field widget.

Plugin annotation


@FieldWidget(
  id = "formatter_field_formatter",
  label = @Translation("Formatter"),
  field_types = {"formatter_field_formatter"},
  multiple_values = TRUE,
)

Hierarchy

Expanded class hierarchy of FormatterWidget

File

src/Plugin/Field/FieldWidget/FormatterWidget.php, line 25

Namespace

Drupal\formatter_field\Plugin\Field\FieldWidget
View source 
class FormatterWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * Formatter plugin manager.
   *
   * @var \Drupal\Core\Field\FormatterPluginManager
   */
  protected $formatterManager;

  /**
   * Entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $fieldManager;

  /**
   * Constructs a new ModerationStateWidget object.
   *
   * @param string $plugin_id
   *   Plugin id.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   Field definition.
   * @param array $settings
   *   Field settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Field\FormatterPluginManager $formatter_manager
   *   Formatter plugin manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $field_manager
   *   Entity field manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, FormatterPluginManager $formatter_manager, EntityFieldManagerInterface $field_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->formatterManager = $formatter_manager;
    $this->fieldManager = $field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('plugin.manager.field.formatter'), $container
      ->get('entity_field.manager'));
  }

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

    // This setting may not be configured yet when the widget is rendered for
    // default value form.
    if (!$this->fieldDefinition
      ->getSetting('field')) {
      return [];
    }
    $target_field_name = $this->fieldDefinition
      ->getSetting('field');
    $definitions = $this->fieldManager
      ->getFieldDefinitions($this->fieldDefinition
      ->getTargetEntityTypeId(), $this->fieldDefinition
      ->getTargetBundle());
    if (!isset($definitions[$target_field_name])) {
      drupal_set_message($this
        ->t('Field %field_name does not exist.', [
        '%field_name' => $target_field_name,
      ]), 'warning');
      return [];
    }
    $target_definition = $definitions[$this->fieldDefinition
      ->getSetting('field')];
    $element['container'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Display settings for @field_name field', [
        '@field_name' => $target_definition
          ->getLabel(),
      ]),
      '#open' => TRUE,
    ];

    // Find all available formatters for this field type.
    $options = $this->formatterManager
      ->getOptions($target_definition
      ->getType());
    $applicable_options = [
      '' => $this
        ->t('- Hidden -'),
    ];
    foreach ($options as $option => $label) {
      $plugin_class = DefaultFactory::getPluginClass($option, $this->formatterManager
        ->getDefinition($option));
      if ($plugin_class::isApplicable($target_definition) && $option != 'formatter_field_from') {
        $applicable_options[$option] = $label;
      }
    }

    // Consider first available option as default formatter.
    $type = '';
    $settings = [];
    if (isset($items[0]->type)) {
      $type = $items[0]->type;
      $settings = unserialize($items[0]->settings);
    }
    $id = 'formatter-settings-form-' . $target_field_name;
    $element['container']['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Formatter'),
      '#options' => $applicable_options,
      '#ajax' => [
        'callback' => [
          $this,
          'settingsFormAjax',
        ],
        'wrapper' => $id,
        'effect' => 'fade',
      ],
      '#default_value' => $type,
    ];

    // Formatter type may come from ajax request.
    $field_name = $this->fieldDefinition
      ->getName();
    $value = $form_state
      ->getValue($field_name);

    // Form structure is different on field settings edit form.
    if (!$value && ($default_value_input = $form_state
      ->getValue('default_value_input'))) {
      $value = $default_value_input[$field_name];
    }
    if (isset($value['container']['type'])) {
      $type = $value['container']['type'];
    }
    if ($type) {
      $options = [
        'field_definition' => $target_definition,
        'configuration' => [
          'type' => $type,
          'settings' => $settings,
          'label' => '',
          'weight' => 0,
        ],
        'view_mode' => '_custom',
      ];
      $formatter = $this->formatterManager
        ->getInstance($options);
      $element['container']['settings'] = $formatter
        ->settingsForm($form, $form_state);
    }
    $element['container']['settings']['#prefix'] = sprintf('<div id="%s">', $id);
    $element['container']['settings']['#suffix'] = '</div>';
    return $element;
  }

  /**
   * Ajax handler for settings form.
   */
  public function settingsFormAjax($form, FormStateInterface $form_state) {
    $parent_element = $form['#form_id'] == 'field_config_edit_form' ? 'default_value' : $this->fieldDefinition
      ->getName();
    return $form[$parent_element]['widget']['container']['settings'];
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    $settings = isset($values['container']['settings']) ? $values['container']['settings'] : [];
    return [
      'type' => $values['container']['type'],
      'settings' => serialize($settings),
    ];
  }

}

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.
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
FormatterWidget::$fieldManager protected property Entity field manager.
FormatterWidget::$formatterManager protected property Formatter plugin manager.
FormatterWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
FormatterWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
FormatterWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
FormatterWidget::settingsFormAjax public function Ajax handler for settings form.
FormatterWidget::__construct public function Constructs a new ModerationStateWidget object. Overrides WidgetBase::__construct
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
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::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::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState