class ClientSideFilterTable

Same name in other branches
  1. 4.x src/Element/ClientSideFilterTable.php \Drupal\devel\Element\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

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.

... See full list

File

src/Element/ClientSideFilterTable.php, line 29

Namespace

Drupal\devel\Element
View source 
class ClientSideFilterTable extends RenderElementBase implements ContainerFactoryPluginInterface {
    // phpcs:ignore Generic.CodeAnalysis.UselessOverridingMethod.Found
    public final 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 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
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
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 Overrides ElementInterface::setAttributes 2