class ClientSideFilterTable
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 \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\devel\Element\ClientSideFilterTable implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Render\Element\RenderElementBase
 
 
- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of 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.
File
- 
              src/Element/ ClientSideFilterTable.php, line 29 
Namespace
Drupal\devel\ElementView source
class ClientSideFilterTable extends RenderElementBase implements ContainerFactoryPluginInterface {
  // phpcs:ignore Generic.CodeAnalysis.UselessOverridingMethod.Found
  final public function __construct(array $configuration, string $plugin_id, string|array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
    $instance = new static($configuration, $plugin_id, $plugin_definition);
    $instance->stringTranslation = $container->get('string_translation');
    return $instance;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() : array {
    $class = static::class;
    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) : array {
    $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'])) {
          continue;
        }
        if (empty($cell['filter'])) {
          continue;
        }
        $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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| ClientSideFilterTable::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
| 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. | ||
| ClientSideFilterTable::__construct | final public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | |
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| 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. | ||
| RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
| RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
| RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
| RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
| RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 | 
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| 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. | 
