class RestripeCommand in Drupal 9

AJAX command for resetting the striping on a table.

The 'restripe' command instructs the client to restripe a table. This is usually used after a table has been modified by a replace or append command.

This command is implemented by Drupal.AjaxCommands.prototype.restripe() defined in misc/ajax.js.

Hierarchy

• class \Drupal\Core\Ajax\RestripeCommand implements CommandInterface

Related topics

Ajax API

Overview for Drupal's Ajax API.

2 files declare their use of RestripeCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module

Simpletest mock module for Ajax forms testing.

File

core/lib/Drupal/Core/Ajax/RestripeCommand.php, line 16

Namespace

Drupal\Core\Ajax

class RestripeCommand implements CommandInterface {

  /**
   * A CSS selector string.
   *
   * If the command is a response to a request from an #ajax form element then
   * this value can be NULL.
   *
   * @var string
   */
  protected $selector;

  /**
   * Constructs a RestripeCommand object.
   *
   * @param string $selector
   *   A CSS selector for the table to be restriped.
   */
  public function __construct($selector) {
    $this->selector = $selector;
  }

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return [
      'command' => 'restripe',
      'selector' => $this->selector,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RestripeCommand::$selector	protected	property	A CSS selector string.
RestripeCommand::render	public	function	Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface::render
RestripeCommand::__construct	public	function	Constructs a RestripeCommand object.