class WebformTable in Webform 8.5
Same name in this branch
- 8.5 src/Element/WebformTable.php \Drupal\webform\Element\WebformTable
- 8.5 src/Plugin/WebformElement/WebformTable.php \Drupal\webform\Plugin\WebformElement\WebformTable
Same name and namespace in other branches
- 6.x src/Plugin/WebformElement/WebformTable.php \Drupal\webform\Plugin\WebformElement\WebformTable
Provides a 'webform_table' element.
Plugin annotation
@WebformElement(
id = "webform_table",
label = @Translation("Table"),
description = @Translation("Provides an element to render a table."),
category = @Translation("Containers"),
)
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\WebformTable
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityInjectionTrait
Expanded class hierarchy of WebformTable
2 files declare their use of WebformTable
- WebformUiElementFormBase.php in modules/
webform_ui/ src/ Form/ WebformUiElementFormBase.php - WebformUiEntityElementsForm.php in modules/
webform_ui/ src/ WebformUiEntityElementsForm.php
File
- src/
Plugin/ WebformElement/ WebformTable.php, line 21
Namespace
Drupal\webform\Plugin\WebformElementView source
class WebformTable extends WebformElementBase {
/**
* {@inheritdoc}
*/
protected function defineDefaultProperties() {
$properties = parent::defineDefaultProperties() + [
'title' => [],
'header' => [],
'caption' => '',
'sticky' => FALSE,
'prefix_children' => TRUE,
];
unset($properties['format_items'], $properties['format_items_html'], $properties['format_items_text'], $properties['unique'], $properties['unique_user'], $properties['unique_entity'], $properties['unique_error'], $properties['disabled'], $properties['prepopulate']);
return $properties;
}
/**
* {@inheritdoc}
*/
protected function defineTranslatableProperties() {
return array_merge(parent::defineTranslatableProperties(), [
'header',
]);
}
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function isInput(array $element) {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function isContainer(array $element) {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
$this
->prepareTableHeader($element);
parent::prepare($element, $webform_submission);
}
/**
* Prepare webform talble header for rendering.
*
* @param array &$element
* A webform table element.
*/
protected function prepareTableHeader(array &$element) {
// Convert webform table header into a simple table header.
if (!isset($element['#header'])) {
return;
}
foreach ($element['#header'] as $index => $header) {
if (is_array($header) && isset($header['title'])) {
$attributes = isset($header['attributes']) ? $header['attributes'] : [];
$element['#header'][$index] = [
'data' => [
'#markup' => $header['title'],
],
] + $attributes;
}
}
}
/**
* {@inheritdoc}
*/
public function getItemDefaultFormat() {
return 'table';
}
/**
* {@inheritdoc}
*/
public function getItemFormats() {
return [
'table' => $this
->t('Table'),
'fieldset' => $this
->t('Fieldset'),
'details' => $this
->t('Details (opened)'),
'details-closed' => $this
->t('Details (closed)'),
];
}
/**
* {@inheritdoc}
*/
public function getTestValues(array $element, WebformInterface $webform, array $options = []) {
return NULL;
}
/**
* {@inheritdoc}
*/
protected function format($type, array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
$item_function = 'format' . $type . 'Item';
return $this
->{$item_function}($element, $webform_submission, $options);
}
/**
* {@inheritdoc}
*/
protected function formatHtmlItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemFormat($element);
switch ($format) {
case 'details':
case 'details-closed':
case 'fieldset':
$element['#type'] = 'container';
break;
case 'table':
default:
$this
->prepareTableHeader($element);
// Switch submission display back to a Drupal table.
$element['#type'] = 'table';
unset($element['#states']);
break;
}
// Build each individual table row.
foreach ($element as $row_key => $row_element) {
if (Element::child($row_key)) {
$row_element_plugin = $this->elementManager
->getElementInstance($row_element);
$element[$row_key] = $row_element_plugin
->buildHtml($row_element, $webform_submission, $options);
}
}
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 = [
'#prefix' => PHP_EOL,
];
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 form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
$form['table'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Table settings'),
];
$form['table']['header'] = [
'#title' => $this
->t('Table header'),
'#type' => 'webform_multiple',
'#header' => [
'title' => [
'data' => $this
->t('Header title'),
'width' => '50%',
],
'attributes' => [
'data' => $this
->t('Header attributes'),
'width' => '50%',
],
],
'#element' => [
'title' => [
'#type' => 'textfield',
'#title' => $this
->t('Header title'),
'#error_no_message' => TRUE,
],
'attributes' => [
'#type' => 'webform_codemirror',
'#mode' => 'yaml',
'#title' => $this
->t('Header attributes (YAML)'),
'#decode_value' => TRUE,
'#error_no_message' => TRUE,
],
],
];
$form['table']['caption'] = [
'#type' => 'textfield',
'#title' => $this
->t('Caption for the table'),
'#description' => $this
->t('A title semantically associated with your table for increased accessibility.'),
'#maxlength' => 255,
];
$form['table']['sticky'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable Drupal style "sticky" table headers (Javascript)'),
'#description' => $this
->t("If checked, the table's header will remain visible as the user scrolls through the table."),
'#return_value' => TRUE,
];
$form['table']['prefix_children'] = [
'#type' => 'checkbox',
'#title' => $this
->t("Automatically prefix and increment the table's rows and elements"),
'#description' => $this
->t("If checked, all rows and elements within the table will be prefixed with the table's element key and a incremented numeric value. (i.e. table_01_first_name)"),
'#return_value' => TRUE,
];
// Update #required label.
$form['validation']['required_container']['required']['#title'] .= ' <em>' . $this
->t('(Display purposes only)') . '</em>';
$form['validation']['required_container']['required']['#description'] = $this
->t('If checked, adds required indicator to the title, if visible. To require individual elements, also tick "Required" under each elements settings.');
return $form;
}
/**
* {@inheritdoc}
*/
public function preview() {
return [
'#type' => 'table',
'#header' => [
$this
->t('Header 1'),
$this
->t('Header 2'),
],
'#rows' => [
[
'Row 1 - Col 1',
'Row 1 - Col 2',
],
[
'Row 2 - Col 1',
'Row 2 - Col 2',
],
[
'Row 3 - Col 1',
'Row 3 - Col 2',
],
],
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. | ||
WebformCompositeFormElementTrait:: |
public static | function | Adds form element theming to an element if its title or description is set. | 1 |
WebformElementBase:: |
protected | property | The configuration factory. | |
WebformElementBase:: |
protected | property | The current user. | |
WebformElementBase:: |
protected | property | An associative array of an element's default properties names and values. | |
WebformElementBase:: |
protected | property | A element info manager. | |
WebformElementBase:: |
protected | property | The webform element manager. | |
WebformElementBase:: |
protected | property | The entity type manager. | |
WebformElementBase:: |
protected | property | The webform libraries manager. | |
WebformElementBase:: |
protected | property | A logger instance. | |
WebformElementBase:: |
protected | property | The webform submission storage. | |
WebformElementBase:: |
protected | property | The token manager. | |
WebformElementBase:: |
protected | property | An indexed array of an element's translated properties. | |
WebformElementBase:: |
public | function |
Alter an element's associated form. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Build an element as text or HTML. | 4 |
WebformElementBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
3 |
WebformElementBase:: |
protected | function | Build configuration form tabs. | 1 |
WebformElementBase:: |
public | function |
Build an element's export header. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Get an element's export options webform. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Build an element's export row. Overrides WebformElementInterface:: |
7 |
WebformElementBase:: |
public | function |
Build an element as HTML element. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Build an element as text element. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Checks an access rule against a user account's roles and id. | |
WebformElementBase:: |
public | function |
Check element access (rules). Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
WebformElementBase:: |
protected | function | Define default base properties used by all elements. | 4 |
WebformElementBase:: |
protected | function | Define default multiple properties used by most elements. | 1 |
WebformElementBase:: |
public | function |
Display element disabled warning. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Finalize an element to be rendered within a webform. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Format an element's item using custom HTML or plain text. | 2 |
WebformElementBase:: |
protected | function | Format an element's items using custom HTML or plain text. | |
WebformElementBase:: |
public | function |
Format an element's value as HTML. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
protected | function | Format an element's items as HTML. | 2 |
WebformElementBase:: |
public | function |
Format an element's table column value. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Format an element's value as plain text. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
protected | function | Format an element's items as text. | 2 |
WebformElementBase:: |
public | function |
Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an associative array of element properties from configuration webform. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
protected | function | Get configuration property value. | 1 |
WebformElementBase:: |
protected | function | Get default base properties used by all elements. | |
WebformElementBase:: |
public | function |
Gets the element's default key. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Get default multiple properties used by most elements. | |
WebformElementBase:: |
public | function |
Get default properties. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's default property value. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Get a render element's default property. | |
WebformElementBase:: |
public | function |
Get an element's property value. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Get an element's (sub)inputs selectors as options. | 9 |
WebformElementBase:: |
public | function |
Get an element's (sub)input selector value. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Get an element's selectors as options. Overrides WebformElementInterface:: |
11 |
WebformElementBase:: |
public | function |
Get an element's selectors source values. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Get an element's supported states as options. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Get an element's default export options. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Get the Webform element's form element class definition. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Get form--inline container which is used for side-by-side element layout. | |
WebformElementBase:: |
public | function |
Retrieves the default properties for the defined element type. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Get an element's default multiple value format name. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's available multiple value formats. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Get an element's key/name. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's label (#title or #webform_key). Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get configuration form's off-canvas width. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Get link to element's API documentation. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get the URL for the element's API documentation. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the category of the plugin instance. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the description of the plugin instance. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the label of the plugin instance. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Get an element's submission raw value. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get related element types. Overrides WebformElementInterface:: |
6 |
WebformElementBase:: |
public | function |
Get element's table column(s) settings. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Get translatable properties. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Get an element's submission value. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
protected | function | Determine if the element has a composite field wrapper. | |
WebformElementBase:: |
public | function |
Determine if the element is or includes a managed_file upload element. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element value has multiple values. Overrides WebformElementInterface:: |
6 |
WebformElementBase:: |
public | function |
Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Determine if the element supports a specified property. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Determine if an element's has a submission value. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element has a wrapper. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public static | function | Webform element #after_build callback. | |
WebformElementBase:: |
public | function |
Initialize an element to be displayed, rendered, or exported. Overrides WebformElementInterface:: |
8 |
WebformElementBase:: |
public | function |
Checks if the element is a composite element. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Checks if the element is disabled. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Checks if an empty element is excluded. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Checks if the element is enabled. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Checks if the element is excluded via webform.settings. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
public | function |
Checks if the element is hidden. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element value could contain multiple lines. Overrides WebformElementInterface:: |
2 |
WebformElementBase:: |
public | function |
Checks if the element is a root element. Overrides WebformElementInterface:: |
3 |
WebformElementBase:: |
public | function |
Acts on a webform submission element after it is created. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Delete any additional value associated with an element. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Acts on loaded webform submission. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function |
Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementInterface:: |
5 |
WebformElementBase:: |
public | function |
Changes the values of an entity before it is created. Overrides WebformElementInterface:: |
1 |
WebformElementBase:: |
public | function | 1 | |
WebformElementBase:: |
protected | function | Prefix an element's export header. | |
WebformElementBase:: |
protected | function | Replace Core's composite #pre_render with Webform's composite #pre_render. | |
WebformElementBase:: |
protected | function | Prepare an element's pre render callbacks. | 3 |
WebformElementBase:: |
protected | function | Prepare an element's validation callbacks. | 8 |
WebformElementBase:: |
protected | function | Set multiple element wrapper. | 1 |
WebformElementBase:: |
protected | function | Set an elements #states and flexbox wrapper. | 1 |
WebformElementBase:: |
public static | function | Fix flexbox wrapper. | |
WebformElementBase:: |
public static | function | Fix state wrapper. | |
WebformElementBase:: |
public | function |
Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface:: |
4 |
WebformElementBase:: |
public | function |
Replace tokens for all element properties. Overrides WebformElementInterface:: |
|
WebformElementBase:: |
protected | function | Set an element's configuration webform element default value. | 2 |
WebformElementBase:: |
protected | function | Set configuration webform default values recursively. | |
WebformElementBase:: |
public | function |
Set an element's default value using saved data. Overrides WebformElementInterface:: |
7 |
WebformElementBase:: |
protected | function | Set element's default callback. | |
WebformElementBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
|
WebformElementBase:: |
public | function |
Checks if the element supports multiple values. Overrides WebformElementInterface:: |
8 |
WebformElementBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
1 |
WebformElementBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
6 |
WebformElementBase:: |
public static | function | Form API callback. Validate element #minlength value. | |
WebformElementBase:: |
public static | function | Form API callback. Validate element #multiple > 1 value. | |
WebformElementBase:: |
public static | function | Form API callback. Validate element #unique value. | |
WebformElementBase:: |
public static | function | Form API callback. Validate element #unique multiple values. | |
WebformElementBase:: |
public | function |
Constructs a WebformElementBase object. Overrides PluginBase:: |
2 |
WebformEntityInjectionTrait:: |
protected | property | The webform. | |
WebformEntityInjectionTrait:: |
protected | property | The webform submission. | |
WebformEntityInjectionTrait:: |
public | function | Get the webform that this handler is attached to. | |
WebformEntityInjectionTrait:: |
public | function | Set webform and webform submission entity. | |
WebformEntityInjectionTrait:: |
public | function | Reset webform and webform submission entity. | |
WebformEntityInjectionTrait:: |
public | function | ||
WebformEntityInjectionTrait:: |
public | function | Set the webform that this is handler is attached to. | |
WebformEntityInjectionTrait:: |
public | function | Get the webform submission that this handler is handling. | |
WebformTable:: |
protected | function |
Define an element's default properties. Overrides WebformElementBase:: |
|
WebformTable:: |
protected | function |
Define an element's translatable properties. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Gets the actual configuration webform array to be built. Overrides WebformElementBase:: |
|
WebformTable:: |
protected | function |
Format an element's value as HTML or plain text. Overrides WebformElementBase:: |
|
WebformTable:: |
protected | function |
Format an element's value as HTML. Overrides WebformElementBase:: |
|
WebformTable:: |
protected | function |
Format an element's value as text. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Get an element's default single value format name. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Get an element's available single value formats. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Get test values for an element. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Checks if the element is a container that can contain elements. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Checks if the element carries a value. Overrides WebformElementBase:: |
|
WebformTable:: |
public | function |
Prepare an element to be rendered within a webform. Overrides WebformElementBase:: |
|
WebformTable:: |
protected | function | Prepare webform talble header for rendering. | |
WebformTable:: |
public | function |
Generate a renderable preview of the element. Overrides WebformElementBase:: |