ReplaceCommand.php

Definition of Drupal\Core\Ajax\ReplaceCommand.

Namespace

Drupal\Core\Ajax

File

drupal/core/lib/Drupal/Core/Ajax/ReplaceCommand.php
View source
<?php

/**
 * @file
 * Definition of Drupal\Core\Ajax\ReplaceCommand.
 */
namespace Drupal\Core\Ajax;

use Drupal\Core\Ajax\InsertCommand;

/**
 * AJAX command for calling the jQuery replace() method.
 *
 * The 'insert/replaceWith' command instructs the client to use jQuery's
 * replaceWith() method to replace each element matched matched by the given
 * selector with the given HTML.
 *
 * This command is implemented by Drupal.AjaxCommands.prototype.insert()
 * defined in misc/ajax.js.
 *
 * See
 * @link http://docs.jquery.com/Manipulation/replaceWith#content jQuery replaceWith command @endlink
 */
class ReplaceCommand extends InsertCommand {

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

}

Classes

Namesort descending Description
ReplaceCommand AJAX command for calling the jQuery replace() method.