class TablefieldWidget in TableField 8.2

Plugin implementation of the 'tablefield' widget.

@FieldWidget ( id = "tablefield", label =

Plugin annotation


@Translation("Table Field"),
  field_types = {
    "tablefield"
  },
)

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\tablefield\Plugin\Field\FieldWidget\TablefieldWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of TablefieldWidget

File

src/Plugin/Field/FieldWidget/TablefieldWidget.php, line 27

Namespace

Drupal\tablefield\Plugin\Field\FieldWidget

View source

class TablefieldWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal\Core\Session\AccountProxy definition.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $currentUser;

  /**
   * Drupal\Core\Config\ConfigFactoryInterface definition.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, ConfigFactoryInterface $configFactory, AccountProxy $current_user) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->configFactory = $configFactory;
    $this->currentUser = $current_user;
  }

  /**
   * {@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('config.factory'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'input_type' => 'textfield',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['input_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Input type'),
      '#default_value' => $this
        ->getSetting('input_type'),
      '#required' => TRUE,
      '#options' => [
        'textfield' => 'textfield',
        'textarea' => 'textarea',
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Using input type: @input_type', [
      '@input_type' => $this
        ->getSetting('input_type'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $is_field_settings_default_widget_form = $form_state
      ->getBuildInfo()['form_id'] == 'field_config_edit_form' ? 1 : 0;
    $field = $items[0]
      ->getFieldDefinition();
    $field_settings = $field
      ->getSettings();
    $field_widget_default = $field
      ->getDefaultValueLiteral();
    if (!empty($field_widget_default[$delta])) {
      $field_default = (object) $field_widget_default[$delta];
    }
    if (isset($items[$delta]->value)) {
      $default_value = $items[$delta];
    }
    elseif (!$is_field_settings_default_widget_form && !empty($field_default)) {

      // Load field settings defaults in case current item is empty.
      $default_value = $field_default;
    }
    else {
      $default_value = (object) [
        'value' => [],
        'rebuild' => [],
      ];
    }

    // Make sure rows and cols are set.
    $rows = isset($default_value->rebuild['rows']) ? $default_value->rebuild['rows'] : $this->configFactory
      ->get('tablefield.settings')
      ->get('rows');
    $cols = isset($default_value->rebuild['cols']) ? $default_value->rebuild['cols'] : $this->configFactory
      ->get('tablefield.settings')
      ->get('cols');
    $element['caption'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Table Caption'),
      '#default_value' => !empty($default_value->caption) ? $default_value->caption : NULL,
      '#size' => 60,
      '#description' => $this
        ->t('This brief caption will be associated with the table and will help screen reader better describe the content within.'),
    ];
    $element = [
      '#type' => 'tablefield',
      '#input_type' => $this
        ->getSetting('input_type'),
      '#description_display' => 'before',
      '#description' => $element['#description'] ?: $this
        ->t('The first row will appear as the table header. Leave the first row blank if you do not need a header.'),
      '#cols' => $cols,
      '#rows' => $rows,
      '#default_value' => $default_value->value,
      '#lock' => !$is_field_settings_default_widget_form && $field_settings['lock_values'],
      '#locked_cells' => !empty($field_default->value) ? $field_default->value : [],
      '#rebuild' => $this->currentUser
        ->hasPermission('rebuild tablefield'),
      '#import' => $this->currentUser
        ->hasPermission('import tablefield'),
      // Add permission.
      '#addrow' => $this->currentUser
        ->hasPermission('addrow tablefield'),
    ] + $element;
    if ($is_field_settings_default_widget_form) {
      $element['#description'] = $this
        ->t('This form defines the table field defaults, but the number of rows/columns and content can be overridden on a per-node basis. The first row will appear as the table header. Leave the first row blank if you do not need a header.');
    }
    if ($form_state
      ->getTriggeringElement()) {
      $element['#element_validate'][] = [
        $this,
        'validateTablefield',
      ];
    }

    // Allow the user to select input filters.
    if (!empty($field_settings['cell_processing'])) {
      $element['#base_type'] = $element['#type'];
      $element['#type'] = 'text_format';
      $element['#format'] = isset($default_value->format) ? $default_value->format : NULL;
      $element['#editor'] = FALSE;
    }
    return $element;
  }

  /**
   * Validation handler.
   */
  public function validateTablefield(array &$element, FormStateInterface &$form_state, array $form) {
    if ($element['#required'] && $form_state
      ->getTriggeringElement()['#type'] == 'submit') {
      $items = new FieldItemList($this->fieldDefinition);
      $this
        ->extractFormValues($items, $form, $form_state);
      $values = FALSE;
      if (isset($element['#value'])) {
        foreach ($element['#value']['tablefield']['table'] as $row) {
          foreach ($row as $cell) {
            if (empty($cell)) {
              $values = TRUE;
              break;
            }
          }
        }
      }
      if (!$items
        ->count() && $values == TRUE) {
        $form_state
          ->setError($element, $this
          ->t('@name field is required.', [
          '@name' => $this->fieldDefinition
            ->getLabel(),
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   *
   * Set error only on the first item in a multi-valued field.
   */
  public function errorElement(array $element, ConstraintViolationInterface $violation, array $form, FormStateInterface $form_state) {
    return $element[0];
  }

}

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
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.
TablefieldWidget::$configFactory	protected	property	Drupal\Core\Config\ConfigFactoryInterface definition.
TablefieldWidget::$currentUser	protected	property	Drupal\Core\Session\AccountProxy definition.
TablefieldWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
TablefieldWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TablefieldWidget::errorElement	public	function	Set error only on the first item in a multi-valued field. Overrides WidgetBase::errorElement
TablefieldWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
TablefieldWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
TablefieldWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
TablefieldWidget::validateTablefield	public	function	Validation handler.
TablefieldWidget::__construct	public	function	Constructs a WidgetBase object. Overrides WidgetBase::__construct
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::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

You are here

class TablefieldWidget in TableField 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation