class ClientSideFilterTable in Devel 4.x

Provides a render element for filterable table data.

Usage example:

$build['item'] = [
  '#type' => 'devel_table_filter',
  '#filter_label' => $this
    ->t('Search'),
  '#filter_placeholder' => $this
    ->t('Enter element name.'),
  '#filter_description' => $this
    ->t('Enter a part of name to filter by.'),
  '#header' => $headers,
  '#rows' => $rows,
  '#empty' => $this
    ->t('No element found.'),
];

Plugin annotation

@RenderElement("devel_table_filter");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\devel\Element\ClientSideFilterTable

1 file declares its use of ClientSideFilterTable

DevelClientSideFilterTableTest.php in tests/src/Unit/DevelClientSideFilterTableTest.php

8 #type uses of ClientSideFilterTable

ContainerInfoController::parameterList in src/Controller/ContainerInfoController.php

Builds the parameters overview page.

ContainerInfoController::serviceList in src/Controller/ContainerInfoController.php

Builds the services overview page.

DevelClientSideFilterTableTest::providerPreRenderTable in tests/src/Unit/DevelClientSideFilterTableTest.php

Data provider for preRenderHtmlTag test.

DevelController::stateSystemPage in src/Controller/DevelController.php

Builds the state variable overview page.

ElementInfoController::elementList in src/Controller/ElementInfoController.php

Builds the element overview page.

... See full list

File

src/Element/ClientSideFilterTable.php, line 27

Namespace

Drupal\devel\Element

class ClientSideFilterTable extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#filter_label' => $this
        ->t('Search'),
      '#filter_placeholder' => $this
        ->t('Search'),
      '#filter_description' => $this
        ->t('Search'),
      '#header' => [],
      '#rows' => [],
      '#empty' => '',
      '#sticky' => FALSE,
      '#responsive' => TRUE,
      '#attributes' => [],
      '#pre_render' => [
        [
          $class,
          'preRenderTable',
        ],
      ],
    ];
  }

  /**
   * Pre-render callback: Assemble render array for the filterable table.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *
   * @return array
   *   The $element with prepared render array ready for rendering.
   */
  public static function preRenderTable(array $element) {
    $build['#attached']['library'][] = 'devel/devel-table-filter';
    $identifier = Html::getUniqueId('js-devel-table-filter');
    $build['filters'] = [
      '#type' => 'container',
      '#weight' => -1,
      '#attributes' => [
        'class' => [
          'table-filter',
          'js-show',
        ],
      ],
    ];
    $build['filters']['name'] = [
      '#type' => 'search',
      '#size' => 30,
      '#title' => $element['#filter_label'],
      '#placeholder' => $element['#filter_placeholder'],
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => ".{$identifier}",
        'autocomplete' => 'off',
        'title' => $element['#filter_description'],
      ],
    ];
    foreach ($element['#rows'] as &$row) {
      foreach ($row as &$cell) {
        if (isset($cell['data']) && !empty($cell['filter'])) {
          $cell['class'][] = 'table-filter-text-source';
        }
      }
    }
    $build['table'] = [
      '#type' => 'table',
      '#header' => $element['#header'],
      '#rows' => $element['#rows'],
      '#empty' => $element['#empty'],
      '#sticky' => $element['#sticky'],
      '#responsive' => $element['#responsive'],
      '#attributes' => $element['#attributes'],
    ];
    $build['table']['#attributes']['class'][] = $identifier;
    $build['table']['#attributes']['class'][] = 'devel-table-filter';
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClientSideFilterTable::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
ClientSideFilterTable::preRenderTable	public static	function	Pre-render callback: Assemble render array for the filterable table.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
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.	1
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.	4
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.