class HighlightCommand in Drupal 9

Provides an AJAX command for highlighting a certain new piece of html.

This command is implemented in Drupal.AjaxCommands.prototype.viewsHighlight.

Hierarchy

• class \Drupal\views\Ajax\HighlightCommand implements CommandInterface

1 file declares its use of HighlightCommand

ViewsFormBase.php in core/modules/views_ui/src/Form/Ajax/ViewsFormBase.php

File

core/modules/views/src/Ajax/HighlightCommand.php, line 12

Namespace

Drupal\views\Ajax

class HighlightCommand implements CommandInterface {

  /**
   * A CSS selector string.
   *
   * @var string
   */
  protected $selector;

  /**
   * Constructs a \Drupal\views\Ajax\HighlightCommand object.
   *
   * @param string $selector
   *   A CSS selector.
   */
  public function __construct($selector) {
    $this->selector = $selector;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return [
      'command' => 'viewsHighlight',
      'selector' => $this->selector,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HighlightCommand::$selector	protected	property	A CSS selector string.
HighlightCommand::render	public	function	Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
HighlightCommand::__construct	public	function	Constructs a \Drupal\views\Ajax\HighlightCommand object.