class RemoveCommand in Drupal 8

AJAX command for calling the jQuery remove() method.

The 'remove' command instructs the client to use jQuery's remove() method to remove each of elements matched by the given selector, and everything within them.

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

Hierarchy

• class \Drupal\Core\Ajax\RemoveCommand implements CommandInterface

See also

http://docs.jquery.com/Manipulation/remove#expr

Related topics

Ajax API

Overview for Drupal's Ajax API.

2 files declare their use of RemoveCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module

Simpletest mock module for Ajax forms testing.

File

core/lib/Drupal/Core/Ajax/RemoveCommand.php, line 19

Namespace

Drupal\Core\Ajax

class RemoveCommand implements CommandInterface {

  /**
   * The CSS selector for the element(s) to be removed.
   *
   * @var string
   */
  protected $selector;

  /**
   * Constructs a RemoveCommand object.
   *
   * @param string $selector
   */
  public function __construct($selector) {
    $this->selector = $selector;
  }

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return [
      'command' => 'remove',
      'selector' => $this->selector,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RemoveCommand::$selector	protected	property	The CSS selector for the element(s) to be removed.
RemoveCommand::render	public	function	Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface::render
RemoveCommand::__construct	public	function	Constructs a RemoveCommand object.