RemoveCommand.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Ajax/RemoveCommand.php
  2. 8.9.x core/lib/Drupal/Core/Ajax/RemoveCommand.php
  3. 11.x core/lib/Drupal/Core/Ajax/RemoveCommand.php

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/RemoveCommand.php

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * 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.
 *
 * @see http://docs.jquery.com/Manipulation/remove#expr
 *
 * @ingroup 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
     *   The selector.
     */
    public function __construct($selector) {
        $this->selector = $selector;
    }
    
    /**
     * Implements Drupal\Core\Ajax\CommandInterface:render().
     */
    public function render() {
        return [
            'command' => 'remove',
            'selector' => $this->selector,
        ];
    }

}

Classes

Title Deprecated Summary
RemoveCommand AJAX command for calling the jQuery remove() method.

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