Tableselect
class Tableselect extends Table (View source)
Provides a form element for a table with radios or checkboxes in left column.
Properties:
-
header: An array of table header labels.
-
options: An associative array where each key is the value returned when
a user selects the radio button or checkbox, and each value is the row of table data.
-
empty: The message to display if table does not have any options.
-
multiple: Set to FALSE to render the table with radios instead checkboxes.
-
js_select: Set to FALSE if you don't want the select all checkbox added to
the header.
Other properties of the \Drupal\Core\Render\Element\Table element are also available.
Usage example:
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
Methods
Constructs a \Drupal\Component\Plugin\PluginBase object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Sets a form element's class attribute.
Adds members of this group as actual elements for rendering.
Form element processing handler for the #ajax form property.
Adds Ajax information about an element to communicate with JavaScript.
Arranges elements into groups.
Determines how user input is mapped to an element's #value property.
process callback for #pattern form element property.
element_validate callback for #pattern form element property.
Adds autocomplete functionality to elements.
Returns the element properties for this element.
process callback for #type 'table' to add tableselect support.
element_validate callback for #type 'table'.
pre_render callback to transform children of an element of #type 'table'.
Prepares a 'tableselect' #type element for rendering.
Creates checkbox or radio elements to populate a tableselect table.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)
Constructs a \Drupal\Component\Plugin\PluginBase object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
static
setAttributes(array $element, array $class = [])
Sets a form element's class attribute.
Adds 'required' and 'error' classes as needed.
static array
preRenderGroup(array $element)
Adds members of this group as actual elements for rendering.
static array
processAjaxForm(array $element, FormStateInterface $form_state, array $complete_form)
Form element processing handler for the #ajax form property.
This method is useful for non-input elements that can be used in and outside the context of a form.
static array
preRenderAjaxForm(array $element)
Adds Ajax information about an element to communicate with JavaScript.
If #ajax is set on an element, this additional JavaScript is added to the page header to attach the Ajax behaviors. See ajax.js for more information.
static array
processGroup(array $element, FormStateInterface $form_state, array $complete_form)
Arranges elements into groups.
This method is useful for non-input elements that can be used in and outside the context of a form.
static mixed
valueCallback(array $element, mixed $input, FormStateInterface $form_state)
Determines how user input is mapped to an element's #value property.
static array
processPattern(array $element, FormStateInterface $form_state, array $complete_form)
process callback for #pattern form element property.
static
validatePattern($element, FormStateInterface $form_state, array $complete_form)
element_validate callback for #pattern form element property.
static array
processAutocomplete(array $element, FormStateInterface $form_state, array $complete_form)
Adds autocomplete functionality to elements.
This sets up autocomplete functionality for elements with an
autocomplete_route_name property, using the #autocomplete_route_parameters
property if present.
For example, suppose your autocomplete route name is 'mymodule.autocomplete' and its path is '/mymodule/autocomplete/{a}/{b}'. In a form array, you would create a text field with properties:
array
getInfo()
Returns the element properties for this element.
in
Table at line 134
static array
processTable(array $element, FormStateInterface $form_state, array $complete_form)
process callback for #type 'table' to add tableselect support.
in
Table at line 257
static
validateTable(array $element, FormStateInterface $form_state, array $complete_form)
element_validate callback for #type 'table'.
in
Table at line 339
static array
preRenderTable(array $element)
pre_render callback to transform children of an element of #type 'table'.
This function converts sub-elements of an element of #type 'table' to be suitable for table.html.twig:
- The first level of sub-elements are table rows. Only the #attributes property is taken into account.
- The second level of sub-elements is converted into columns for the corresponding first-level table row.
Simple example usage:
static array
preRenderTableselect(array $element)
Prepares a 'tableselect' #type element for rendering.
Adds a column of radio buttons or checkboxes for each row of a table.
static array
processTableselect(array $element, FormStateInterface $form_state, array $complete_form)
Creates checkbox or radio elements to populate a tableselect table.