class RestripeCommand

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Ajax/RestripeCommand.php \Drupal\Core\Ajax\RestripeCommand
  2. 8.9.x core/lib/Drupal/Core/Ajax/RestripeCommand.php \Drupal\Core\Ajax\RestripeCommand
  3. 10 core/lib/Drupal/Core/Ajax/RestripeCommand.php \Drupal\Core\Ajax\RestripeCommand

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

Expanded class hierarchy of RestripeCommand

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
Mock module for Ajax forms testing.

File

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

Namespace

Drupal\Core\Ajax
View source 
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

Title Modifiers Object type Summary Overriden Title
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.