class HtmlCommand

AJAX command for calling the jQuery html() method.

The 'insert/html' command instructs the client to use jQuery's html() method to set the HTML content of each element matched by the given selector while leaving the outer tags intact.

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

Hierarchy

Expanded class hierarchy of HtmlCommand

See also

http://docs.jquery.com/Attributes/html#val

1 file declares its use of HtmlCommand
AjaxCommandsUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Ajax/AjaxCommandsUnitTest.php
Definition of Drupal\system\Tests\Ajax\AjaxCommandsUnitTest.

File

drupal/core/lib/Drupal/Core/Ajax/HtmlCommand.php, line 24
Definition of Drupal\Core\Ajax\HtmlCommand.

Namespace

Drupal\Core\Ajax
View source
class HtmlCommand extends InsertCommand {

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return array(
      'command' => 'insert',
      'method' => 'html',
      'selector' => $this->selector,
      'data' => $this->html,
      'settings' => $this->settings,
    );
  }

}

Members

Name Modifierssort descending Type Description Overrides
InsertCommand::$selector protected property A CSS selector string.
InsertCommand::$html protected property The HTML content that will replace the matched element(s).
InsertCommand::$settings protected property A settings array to be passed to any any attached JavaScript behavior.
HtmlCommand::render public function Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides InsertCommand::render
InsertCommand::__construct public function Constructs an InsertCommand object.