RestripeCommand.php

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

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/RestripeCommand.php

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * 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.
 *
 * @ingroup 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,
        ];
    }

}

Classes

Title Deprecated Summary
RestripeCommand AJAX command for resetting the striping on a table.

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