class WebformTableRow in Webform 8.5

Same name in this branch

8.5 src/Element/WebformTableRow.php \Drupal\webform\Element\WebformTableRow
8.5 src/Plugin/WebformElement/WebformTableRow.php \Drupal\webform\Plugin\WebformElement\WebformTableRow

Same name and namespace in other branches

6.x src/Plugin/WebformElement/WebformTableRow.php \Drupal\webform\Plugin\WebformElement\WebformTableRow

Provides a 'webform_table_row' element.

Plugin annotation


@WebformElement(
  id = "webform_table_row",
  label = @Translation("Table row"),
  description = @Translation("Provides an element to render a table row."),
  category = @Translation("Containers"),
  hidden = TRUE,
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityInjectionTrait
  - class \Drupal\webform\Plugin\WebformElement\WebformTableRow

Expanded class hierarchy of WebformTableRow

1 file declares its use of WebformTableRow

WebformUiElementFormBase.php in modules/webform_ui/src/Form/WebformUiElementFormBase.php

File

src/Plugin/WebformElement/WebformTableRow.php, line 24

Namespace

Drupal\webform\Plugin\WebformElement

View source

class WebformTableRow extends WebformElementBase {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    $properties = [
      'title' => '',
      'attributes' => [],
    ] + $this
      ->defineDefaultBaseProperties();
    unset($properties['prepopulate']);
    return $properties;
  }

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function isInput(array $element) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isContainer(array $element) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getItemDefaultFormat() {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  public function getItemFormats() {
    return [
      '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function build($format, array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $format_function = 'format' . ucfirst($format);
    return $this
      ->{$format_function}($element, $webform_submission, $options);
  }

  /**
   * {@inheritdoc}
   */
  public function buildHtml(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $webform = $webform_submission
      ->getWebform();
    $parent_key = $element['#webform_parent_key'];
    $parent_element = $webform
      ->getElement($parent_key);
    $parent_format = isset($parent_element['#format']) ? $parent_element['#format'] : 'table';

    // Remove #states.
    unset($element['#states']);
    switch ($parent_format) {
      case 'details-closed':
      case 'details':
      case 'fieldset':
        $webform_plugin_id = $parent_format === 'details-closed' ? 'details' : $parent_format;
        $element['#webform_plugin_id'] = $webform_plugin_id;
        $element['#type'] = $webform_plugin_id;
        $element['#format_item'] = $parent_format;
        $element_plugin = $this->elementManager
          ->getElementInstance($element);
        return $element_plugin
          ->buildHtml($element, $webform_submission, $options);
      case 'table':
      default:
        foreach ($element as $column_key => $column_element) {
          if (WebformElementHelper::property($column_key)) {
            continue;
          }
          $column_element_plugin = $this->elementManager
            ->getElementInstance($column_element);
          if ($column_element_plugin
            ->isContainer($column_element)) {
            $column_build = $column_element_plugin
              ->buildHtml($column_element, $webform_submission, $options);
            $element[$column_key] = [
              'data' => $column_build,
            ];
          }
          elseif (!$column_element_plugin
            ->isInput($column_element)) {
            $element[$column_key] = [
              'data' => $column_element,
            ];
          }
          else {
            $column_value = $column_element_plugin
              ->format('html', $column_element, $webform_submission, $options);
            $element[$column_key] = is_array($column_value) ? [
              'data' => $column_value,
            ] : [
              'data' => [
                '#markup' => $column_value,
              ],
            ];
          }
        }
        return $element;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function formatTextItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {

    /** @var \Drupal\webform\WebformSubmissionViewBuilderInterface $view_builder */
    $view_builder = \Drupal::entityTypeManager()
      ->getViewBuilder('webform_submission');
    $children = $view_builder
      ->buildElements($element, $webform_submission, $options, 'text');
    if (empty($children)) {
      return [];
    }
    $build = [];
    if (!empty($element['#title'])) {
      $build['title'] = [
        '#markup' => $element['#title'],
        '#suffix' => PHP_EOL,
      ];
      $build['divider'] = [
        '#markup' => str_repeat('-', mb_strlen($element['#title'])),
        '#suffix' => PHP_EOL,
      ];
    }
    $build['children'] = $children;
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getTestValues(array $element, WebformInterface $webform, array $options = []) {
    return NULL;
  }

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

    /** @var \Drupal\webform_ui\Form\WebformUiElementFormInterface $form_object */
    $form_object = $form_state
      ->getFormObject();

    // Handle new row being added to a table.
    if ($form_object
      ->isNew()) {
      $parent_key = $form_object
        ->getParentKey();

      // Make sure the new row is being inserted into a table.
      $table_element = $form_object
        ->getWebform()
        ->getElement($parent_key);
      if (!$table_element || $table_element['#type'] !== 'webform_table') {
        throw new NotFoundHttpException();
      }

      // Make sure the table support prefixing.
      $prefix_children = !isset($table_element['#prefix_children']) || $table_element['#prefix_children'] === TRUE;
      if (!$prefix_children) {
        return $form;
      }
      $form['element']['table_message'] = [
        '#type' => 'webform_message',
        '#message_message' => $this
          ->t("Row keys are the tables's key with an incremented value."),
        '#message_type' => 'warning',
        '#message_close' => TRUE,
        '#message_storage' => WebformMessageElement::STORAGE_SESSION,
        '#weight' => -98,
        '#access' => TRUE,
      ];
      $element_properties = $form_state
        ->get('element_properties');

      // Set duplicate and incremented title element properties.
      if ($table_element['#webform_children']) {
        $first_row_key = reset($table_element['#webform_children']);
        $first_row_element = $this
          ->getWebform()
          ->getElement($first_row_key);
        if ($this
          ->hasIncrementalChildrenElements($first_row_key)) {
          $form['table_settings'] = [
            '#type' => 'fieldset',
            '#title' => $this
              ->t('Table row settings'),
          ];
          $form['table_settings']['duplicate'] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t("Duplicate the table's first row"),
            '#return_value' => TRUE,
          ];
          $element_properties['duplicate'] = TRUE;
        }
        $element_properties['title'] = preg_replace('/\\d+/', $this
          ->getNextIncrement(), $first_row_element['#title']);
      }
      else {
        $element_properties['title'] = $table_element['#title'] . ' (1)';
      }
      $form_state
        ->set('element_properties', $element_properties);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultKey() {
    $webform = $this
      ->getWebform();
    $parent_key = \Drupal::request()->query
      ->get('parent');
    $table_element = $webform
      ->getElement($parent_key);

    // Make sure prefixing elements is enabled for the table.
    $prefix_children = !isset($table_element['#prefix_children']) || $table_element['#prefix_children'] === TRUE;
    if (!$prefix_children) {
      return NULL;
    }

    // Return the first rows keys based on the parent title.
    if (empty($table_element['#webform_children'])) {
      return $parent_key . '_01';
    }

    // Replace increment in first row.
    $first_row_key = reset($table_element['#webform_children']);
    $increment = $this
      ->getNextIncrement();
    $increment = str_pad($increment, 2, '0', STR_PAD_LEFT);
    return preg_replace('/\\d+/', $increment, $first_row_key);
  }

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

    /** @var \Drupal\webform_ui\Form\WebformUiElementFormInterface $form_object */
    $form_object = $form_state
      ->getFormObject();
    if (!$form_object
      ->isNew()) {
      return $properties;
    }

    // Get and unset the #duplicate property.
    $duplicate = !empty($properties['#duplicate']);
    unset($properties['#duplicate']);

    // If $duplicate is FALSE don't duplicate the child elements.
    if (!$duplicate) {
      return $properties;
    }

    // This is the only way to get the row key for a new element.
    $key = $_POST['key'];
    $parent_key = \Drupal::request()->query
      ->get('parent');
    if (!$form_object
      ->isNew() || !$parent_key) {
      return $properties;
    }
    $row_index = preg_match('/\\d+/', $key, $match) ? intval($match[0]) : NULL;
    $table_element = $this
      ->getWebform()
      ->getElement($parent_key);
    if (!$table_element['#webform_children']) {
      return $properties;
    }
    $row_key = reset($table_element['#webform_children']);
    $children_elements = $this
      ->getChildrenElements($row_key, $row_index);
    if ($children_elements === FALSE) {
      $this
        ->messenger()
        ->addWarning("Unable to append child elements from @row because a child element's key do not include any index/number.", [
        '@row' => $row_key,
      ]);
    }
    else {
      $properties += $children_elements;
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorOptions(array $element) {
    return [];
  }

  /****************************************************************************/

  // Helper function.

  /****************************************************************************/

  /**
   * Get the parent table's next row increment.
   *
   * @return int
   *   The parent table's next row increment.
   */
  protected function getNextIncrement() {
    $webform = $this
      ->getWebform();
    $parent_key = \Drupal::request()->query
      ->get('parent');
    $table_element = $webform
      ->getElement($parent_key);
    if (!$table_element['#webform_children']) {
      return 1;
    }

    // Get next row increment.
    $indexes = [];
    foreach ($table_element['#webform_children'] as $child_key) {
      preg_match('/\\d+/', $child_key, $match);
      $indexes[] = intval($match[0]);
    }
    return max($indexes) + 1;
  }

  /**
   * Determine if an element and its use incremental keys.
   *
   * @param string $key
   *   An element key.
   *
   * @return bool
   *   TRUE if an element and its use incremental keys.
   */
  protected function hasIncrementalChildrenElements($key) {

    // Return FALSE if the key is not incremental.
    if (!preg_match('/\\d+/', $key, $match)) {
      return FALSE;
    }
    $element = $this
      ->getWebform()
      ->getElement($key);
    foreach ($element['#webform_children'] as $child_key) {

      // Return FALSE if any child element key is not incremental.
      if (!$this
        ->hasIncrementalChildrenElements($child_key)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    return [];
  }

  /**
   * Get child elements incremented with a new index.
   *
   * @param string $element_key
   *   The element key.
   * @param int $index
   *   The index for all child elements.
   *
   * @return array|bool
   *   Child elements or FALSE is child element keys are not incremental.
   */
  protected function getChildrenElements($element_key, $index) {
    $webform = $this
      ->getWebform();
    $element = $webform
      ->getElement($element_key);
    $elements = [];
    foreach ($element['#webform_children'] as $child_key) {

      // Return FALSE if the child key is not incremental.
      if (!preg_match('/\\d+/', $child_key, $match)) {
        return FALSE;
      }

      // Set incremented key.
      $increment = str_pad($index, 2, '0', STR_PAD_LEFT);
      $increment_key = preg_replace('/\\d+/', $increment, $child_key);

      // Return FALSE if the sub element already exists.
      if ($webform
        ->getElement($increment_key)) {
        return FALSE;
      }

      // Get the decoded element.
      $element = $webform
        ->getElementDecoded($child_key);

      // Increment the element's #title and #admin_title.
      $increment_properties = [
        '#title',
        '#admin_title',
      ];
      foreach ($increment_properties as $increment_property) {
        if (isset($element[$increment_property])) {
          $element[$increment_property] = preg_replace('/\\d+/', $index, $element[$increment_property]);
        }
      }

      // Get child elements.
      $child_elements = $this
        ->getChildrenElements($child_key, $index);

      // Return FALSE if any child element is not incremented.
      if ($child_elements === FALSE) {
        return FALSE;
      }

      // Set new incremented element with child elements.
      $elements[$increment_key] = $element + $child_elements;
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set.	1
WebformElementBase::$configFactory	protected	property	The configuration factory.
WebformElementBase::$currentUser	protected	property	The current user.
WebformElementBase::$defaultProperties	protected	property	An associative array of an element's default properties names and values.
WebformElementBase::$elementInfo	protected	property	A element info manager.
WebformElementBase::$elementManager	protected	property	The webform element manager.
WebformElementBase::$entityTypeManager	protected	property	The entity type manager.
WebformElementBase::$librariesManager	protected	property	The webform libraries manager.
WebformElementBase::$logger	protected	property	A logger instance.
WebformElementBase::$submissionStorage	protected	property	The webform submission storage.
WebformElementBase::$tokenManager	protected	property	The token manager.
WebformElementBase::$translatableProperties	protected	property	An indexed array of an element's translated properties.
WebformElementBase::alterForm	public	function	Alter an element's associated form. Overrides WebformElementInterface::alterForm	1
WebformElementBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	3
WebformElementBase::buildConfigurationFormTabs	protected	function	Build configuration form tabs.	1
WebformElementBase::buildExportHeader	public	function	Build an element's export header. Overrides WebformElementInterface::buildExportHeader	4
WebformElementBase::buildExportOptionsForm	public	function	Get an element's export options webform. Overrides WebformElementInterface::buildExportOptionsForm	4
WebformElementBase::buildExportRecord	public	function	Build an element's export row. Overrides WebformElementInterface::buildExportRecord	7
WebformElementBase::buildText	public	function	Build an element as text element. Overrides WebformElementInterface::buildText	1
WebformElementBase::checkAccessRule	protected	function	Checks an access rule against a user account's roles and id.
WebformElementBase::checkAccessRules	public	function	Check element access (rules). Overrides WebformElementInterface::checkAccessRules
WebformElementBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
WebformElementBase::defineDefaultBaseProperties	protected	function	Define default base properties used by all elements.	4
WebformElementBase::defineDefaultMultipleProperties	protected	function	Define default multiple properties used by most elements.	1
WebformElementBase::defineTranslatableProperties	protected	function	Define an element's translatable properties.	15
WebformElementBase::displayDisabledWarning	public	function	Display element disabled warning. Overrides WebformElementInterface::displayDisabledWarning	1
WebformElementBase::finalize	public	function	Finalize an element to be rendered within a webform. Overrides WebformElementInterface::finalize	1
WebformElementBase::format	protected	function	Format an element's value as HTML or plain text.	2
WebformElementBase::formatCustomItem	protected	function	Format an element's item using custom HTML or plain text.	2
WebformElementBase::formatCustomItems	protected	function	Format an element's items using custom HTML or plain text.
WebformElementBase::formatHtml	public	function	Format an element's value as HTML. Overrides WebformElementInterface::formatHtml	2
WebformElementBase::formatHtmlItem	protected	function	Format an element's value as HTML.	19
WebformElementBase::formatHtmlItems	protected	function	Format an element's items as HTML.	2
WebformElementBase::formatTableColumn	public	function	Format an element's table column value. Overrides WebformElementInterface::formatTableColumn	4
WebformElementBase::formatText	public	function	Format an element's value as plain text. Overrides WebformElementInterface::formatText	2
WebformElementBase::formatTextItems	protected	function	Format an element's items as text.	2
WebformElementBase::getAdminLabel	public	function	Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface::getAdminLabel
WebformElementBase::getConfigurationFormProperty	protected	function	Get configuration property value.	1
WebformElementBase::getDefaultBaseProperties Deprecated	protected	function	Get default base properties used by all elements.
WebformElementBase::getDefaultMultipleProperties Deprecated	protected	function	Get default multiple properties used by most elements.
WebformElementBase::getDefaultProperties	public	function	Get default properties. Overrides WebformElementInterface::getDefaultProperties
WebformElementBase::getDefaultProperty	public	function	Get an element's default property value. Overrides WebformElementInterface::getDefaultProperty
WebformElementBase::getElementInfoDefaultProperty	protected	function	Get a render element's default property.
WebformElementBase::getElementProperty	public	function	Get an element's property value. Overrides WebformElementInterface::getElementProperty
WebformElementBase::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options.	9
WebformElementBase::getElementSelectorInputValue	public	function	Get an element's (sub)input selector value. Overrides WebformElementInterface::getElementSelectorInputValue	5
WebformElementBase::getElementSelectorSourceValues	public	function	Get an element's selectors source values. Overrides WebformElementInterface::getElementSelectorSourceValues	3
WebformElementBase::getElementStateOptions	public	function	Get an element's supported states as options. Overrides WebformElementInterface::getElementStateOptions	1
WebformElementBase::getExportDefaultOptions	public	function	Get an element's default export options. Overrides WebformElementInterface::getExportDefaultOptions	5
WebformElementBase::getFormElementClassDefinition	public	function	Get the Webform element's form element class definition. Overrides WebformElementInterface::getFormElementClassDefinition
WebformElementBase::getFormInlineContainer	protected	function	Get form--inline container which is used for side-by-side element layout.
WebformElementBase::getInfo	public	function	Retrieves the default properties for the defined element type. Overrides WebformElementInterface::getInfo
WebformElementBase::getItemFormat	public	function	Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemFormat	1
WebformElementBase::getItemsDefaultFormat	public	function	Get an element's default multiple value format name. Overrides WebformElementInterface::getItemsDefaultFormat	2
WebformElementBase::getItemsFormat	public	function	Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemsFormat
WebformElementBase::getItemsFormats	public	function	Get an element's available multiple value formats. Overrides WebformElementInterface::getItemsFormats	2
WebformElementBase::getKey	public	function	Get an element's key/name. Overrides WebformElementInterface::getKey
WebformElementBase::getLabel	public	function	Get an element's label (#title or #webform_key). Overrides WebformElementInterface::getLabel
WebformElementBase::getOffCanvasWidth	public	function	Get configuration form's off-canvas width. Overrides WebformElementInterface::getOffCanvasWidth	1
WebformElementBase::getPluginApiLink	public	function	Get link to element's API documentation. Overrides WebformElementInterface::getPluginApiLink
WebformElementBase::getPluginApiUrl	public	function	Get the URL for the element's API documentation. Overrides WebformElementInterface::getPluginApiUrl
WebformElementBase::getPluginCategory	public	function	Gets the category of the plugin instance. Overrides WebformElementInterface::getPluginCategory
WebformElementBase::getPluginDescription	public	function	Gets the description of the plugin instance. Overrides WebformElementInterface::getPluginDescription
WebformElementBase::getPluginLabel	public	function	Gets the label of the plugin instance. Overrides WebformElementInterface::getPluginLabel	3
WebformElementBase::getRawValue	public	function	Get an element's submission raw value. Overrides WebformElementInterface::getRawValue
WebformElementBase::getRelatedTypes	public	function	Get related element types. Overrides WebformElementInterface::getRelatedTypes	6
WebformElementBase::getTableColumn	public	function	Get element's table column(s) settings. Overrides WebformElementInterface::getTableColumn	4
WebformElementBase::getTranslatableProperties	public	function	Get translatable properties. Overrides WebformElementInterface::getTranslatableProperties
WebformElementBase::getTypeName	public	function	Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface::getTypeName
WebformElementBase::getValue	public	function	Get an element's submission value. Overrides WebformElementInterface::getValue	1
WebformElementBase::hasCompositeFormElementWrapper	protected	function	Determine if the element has a composite field wrapper.
WebformElementBase::hasManagedFiles	public	function	Determine if the element is or includes a managed_file upload element. Overrides WebformElementInterface::hasManagedFiles	2
WebformElementBase::hasMultipleValues	public	function	Checks if the element value has multiple values. Overrides WebformElementInterface::hasMultipleValues	6
WebformElementBase::hasMultipleWrapper	public	function	Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface::hasMultipleWrapper	3
WebformElementBase::hasProperty	public	function	Determine if the element supports a specified property. Overrides WebformElementInterface::hasProperty
WebformElementBase::hasValue	public	function	Determine if an element's has a submission value. Overrides WebformElementInterface::hasValue	2
WebformElementBase::hasWrapper	public	function	Checks if the element has a wrapper. Overrides WebformElementInterface::hasWrapper
WebformElementBase::hiddenElementAfterBuild	public static	function	Webform element #after_build callback.
WebformElementBase::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides WebformElementInterface::initialize	8
WebformElementBase::isComposite	public	function	Checks if the element is a composite element. Overrides WebformElementInterface::isComposite
WebformElementBase::isDisabled	public	function	Checks if the element is disabled. Overrides WebformElementInterface::isDisabled
WebformElementBase::isEmptyExcluded	public	function	Checks if an empty element is excluded. Overrides WebformElementInterface::isEmptyExcluded	1
WebformElementBase::isEnabled	public	function	Checks if the element is enabled. Overrides WebformElementInterface::isEnabled	1
WebformElementBase::isExcluded	public	function	Checks if the element is excluded via webform.settings. Overrides WebformElementInterface::isExcluded
WebformElementBase::isHidden	public	function	Checks if the element is hidden. Overrides WebformElementInterface::isHidden	2
WebformElementBase::isMultiline	public	function	Checks if the element value could contain multiple lines. Overrides WebformElementInterface::isMultiline	2
WebformElementBase::isRoot	public	function	Checks if the element is a root element. Overrides WebformElementInterface::isRoot	3
WebformElementBase::postCreate	public	function	Acts on a webform submission element after it is created. Overrides WebformElementInterface::postCreate	1
WebformElementBase::postDelete	public	function	Delete any additional value associated with an element. Overrides WebformElementInterface::postDelete	5
WebformElementBase::postLoad	public	function	Acts on loaded webform submission. Overrides WebformElementInterface::postLoad	1
WebformElementBase::postSave	public	function	Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementInterface::postSave	5
WebformElementBase::preCreate	public	function	Changes the values of an entity before it is created. Overrides WebformElementInterface::preCreate	1
WebformElementBase::preDelete	public	function		1
WebformElementBase::prefixExportHeader	protected	function	Prefix an element's export header.
WebformElementBase::prepare	public	function	Prepare an element to be rendered within a webform. Overrides WebformElementInterface::prepare	22
WebformElementBase::prepareCompositeFormElement	protected	function	Replace Core's composite #pre_render with Webform's composite #pre_render.
WebformElementBase::prepareElementPreRenderCallbacks	protected	function	Prepare an element's pre render callbacks.	3
WebformElementBase::prepareElementValidateCallbacks	protected	function	Prepare an element's validation callbacks.	8
WebformElementBase::prepareMultipleWrapper	protected	function	Set multiple element wrapper.	1
WebformElementBase::prepareWrapper	protected	function	Set an elements #states and flexbox wrapper.	1
WebformElementBase::preRenderFixFlexboxWrapper	public static	function	Fix flexbox wrapper.
WebformElementBase::preRenderFixStatesWrapper	public static	function	Fix state wrapper.
WebformElementBase::preSave	public	function	Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface::preSave	4
WebformElementBase::replaceTokens	public	function	Replace tokens for all element properties. Overrides WebformElementInterface::replaceTokens
WebformElementBase::setConfigurationFormDefaultValue	protected	function	Set an element's configuration webform element default value.	2
WebformElementBase::setConfigurationFormDefaultValueRecursive	protected	function	Set configuration webform default values recursively.
WebformElementBase::setDefaultValue	public	function	Set an element's default value using saved data. Overrides WebformElementInterface::setDefaultValue	7
WebformElementBase::setElementDefaultCallback	protected	function	Set element's default callback.
WebformElementBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
WebformElementBase::supportsMultipleValues	public	function	Checks if the element supports multiple values. Overrides WebformElementInterface::supportsMultipleValues	8
WebformElementBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	1
WebformElementBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	6
WebformElementBase::validateMinlength	public static	function	Form API callback. Validate element #minlength value.
WebformElementBase::validateMultiple	public static	function	Form API callback. Validate element #multiple > 1 value.
WebformElementBase::validateUnique	public static	function	Form API callback. Validate element #unique value.
WebformElementBase::validateUniqueMultiple	public static	function	Form API callback. Validate element #unique multiple values.
WebformElementBase::__construct	public	function	Constructs a WebformElementBase object. Overrides PluginBase::__construct	2
WebformEntityInjectionTrait::$webform	protected	property	The webform.
WebformEntityInjectionTrait::$webformSubmission	protected	property	The webform submission.
WebformEntityInjectionTrait::getWebform	public	function	Get the webform that this handler is attached to.
WebformEntityInjectionTrait::getWebformSubmission	public	function	Set webform and webform submission entity.
WebformEntityInjectionTrait::resetEntities	public	function	Reset webform and webform submission entity.
WebformEntityInjectionTrait::setEntities	public	function
WebformEntityInjectionTrait::setWebform	public	function	Set the webform that this is handler is attached to.
WebformEntityInjectionTrait::setWebformSubmission	public	function	Get the webform submission that this handler is handling.
WebformTableRow::build	protected	function	Build an element as text or HTML. Overrides WebformElementBase::build
WebformTableRow::buildHtml	public	function	Build an element as HTML element. Overrides WebformElementBase::buildHtml
WebformTableRow::defineDefaultProperties	protected	function	Define an element's default properties. Overrides WebformElementBase::defineDefaultProperties
WebformTableRow::form	public	function	Gets the actual configuration webform array to be built. Overrides WebformElementBase::form
WebformTableRow::formatTextItem	protected	function	Format an element's value as text. Overrides WebformElementBase::formatTextItem
WebformTableRow::getChildrenElements	protected	function	Get child elements incremented with a new index.
WebformTableRow::getConfigurationFormProperties	public	function	Get an associative array of element properties from configuration webform. Overrides WebformElementBase::getConfigurationFormProperties
WebformTableRow::getDefaultKey	public	function	Gets the element's default key. Overrides WebformElementBase::getDefaultKey
WebformTableRow::getElementSelectorOptions	public	function	Get an element's selectors as options. Overrides WebformElementBase::getElementSelectorOptions
WebformTableRow::getItemDefaultFormat	public	function	Get an element's default single value format name. Overrides WebformElementBase::getItemDefaultFormat
WebformTableRow::getItemFormats	public	function	Get an element's available single value formats. Overrides WebformElementBase::getItemFormats
WebformTableRow::getNextIncrement	protected	function	Get the parent table's next row increment.
WebformTableRow::getTestValues	public	function	Get test values for an element. Overrides WebformElementBase::getTestValues
WebformTableRow::hasIncrementalChildrenElements	protected	function	Determine if an element and its use incremental keys.
WebformTableRow::isContainer	public	function	Checks if the element is a container that can contain elements. Overrides WebformElementBase::isContainer
WebformTableRow::isInput	public	function	Checks if the element carries a value. Overrides WebformElementBase::isInput
WebformTableRow::preview	public	function	Generate a renderable preview of the element. Overrides WebformElementBase::preview

You are here

class WebformTableRow in Webform 8.5

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation