Provides a render element for a table.
Note: Although this extends FormElement, it can be used outside the context of a form.
Properties:
- #header: An array of table header labels.
- #rows: An array of the rows to be displayed. Each row is either an array of cell contents or an array of properties as described in table.html.twig Alternatively specify the data for the table as child elements of the table element. Table elements would contain rows elements that would in turn contain column elements.
- #empty: Text to display when no rows are present.
- #responsive: Indicates whether to add the drupal.responsive_table library providing responsive tables. Defaults to TRUE.
- #sticky: Indicates whether to add the drupal.tableheader library that makes table headers always visible at the top of the page. Defaults to FALSE.
Usage example:
$form['contacts'] = array( '#type' => 'table', '#caption' => $this->t('Sample Table'), '#header' => array($this->t('Name'), $this->t('Phone')), ); for ($i = 1; $i <= 4; $i++) { $form['contacts'][$i]['#attributes'] = array('class' => array('foo', 'baz')); $form['contacts'][$i]['name'] = array( '#type' => 'textfield', '#title' => $this->t('Name'), '#title_display' => 'invisible', ); $form['contacts'][$i]['phone'] = array( '#type' => 'tel', '#title' => $this->t('Phone'), '#title_display' => 'invisible', ); } $form['contacts'][]['colspan_example'] = array( '#plain_text' => 'Colspan Example', '#wrapper_attributes' => array('colspan' => 2, 'class' => array('foo', 'bar')), );
Plugin annotation
@FormElement("table")
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\Table
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
See also
\Drupal\Core\Render\Element\Tableselect
File
- core/lib/Drupal/Core/Render/Element/Table.php, line 60
Namespace
Drupal\Core\Render\Element
Members
Name | Modifiers | Type | Description |
---|---|---|---|
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
DependencySerializationTrait::__sleep | public | function | |
DependencySerializationTrait::__wakeup | public | function | |
FormElement::processAutocomplete | public static | function | Adds autocomplete functionality to elements. |
FormElement::processPattern | public static | function | #process callback for #pattern form element property. |
FormElement::validatePattern | public static | function | #element_validate callback for #pattern form element property. |
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. |
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. |
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 |
PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
PluginBase::__construct | public | function | Constructs a Drupal\Component\Plugin\PluginBase object. |
RenderElement::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. |
RenderElement::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. |
RenderElement::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. |
RenderElement::processGroup | public static | function | Arranges elements into groups. |
RenderElement::setAttributes | public static | function | Sets a form element's class attribute. Overrides ElementInterface::setAttributes |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
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. |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Table::getInfo | public | function | Returns the element properties for this element. Overrides ElementInterface::getInfo |
Table::preRenderTable | public static | function | #pre_render callback to transform children of an element of #type 'table'. |
Table::processTable | public static | function | #process callback for #type 'table' to add tableselect support. |
Table::validateTable | public static | function | #element_validate callback for #type 'table'. |
Table::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback |
Please login to continue.