HighlightCommand.php

Same filename in other branches
  1. 9 core/modules/views/src/Ajax/HighlightCommand.php
  2. 10 core/modules/views/src/Ajax/HighlightCommand.php
  3. 11.x core/modules/views/src/Ajax/HighlightCommand.php

Namespace

Drupal\views\Ajax

File

core/modules/views/src/Ajax/HighlightCommand.php

View source
<?php

namespace Drupal\views\Ajax;

use Drupal\Core\Ajax\CommandInterface;

/**
 * Provides an AJAX command for highlighting a certain new piece of html.
 *
 * This command is implemented in Drupal.AjaxCommands.prototype.viewsHighlight.
 */
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,
        ];
    }

}

Classes

Title Deprecated Summary
HighlightCommand Provides an AJAX command for highlighting a certain new piece of html.

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