annotate core/lib/Drupal/Core/Ajax/RemoveCommand.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Ajax;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * AJAX command for calling the jQuery remove() method.
Chris@0 7 *
Chris@0 8 * The 'remove' command instructs the client to use jQuery's remove() method
Chris@0 9 * to remove each of elements matched by the given selector, and everything
Chris@0 10 * within them.
Chris@0 11 *
Chris@0 12 * This command is implemented by Drupal.AjaxCommands.prototype.remove()
Chris@0 13 * defined in misc/ajax.js.
Chris@0 14 *
Chris@0 15 * @see http://docs.jquery.com/Manipulation/remove#expr
Chris@0 16 *
Chris@0 17 * @ingroup ajax
Chris@0 18 */
Chris@0 19 class RemoveCommand implements CommandInterface {
Chris@0 20
Chris@0 21 /**
Chris@0 22 * The CSS selector for the element(s) to be removed.
Chris@0 23 *
Chris@0 24 * @var string
Chris@0 25 */
Chris@0 26 protected $selector;
Chris@0 27
Chris@0 28 /**
Chris@0 29 * Constructs a RemoveCommand object.
Chris@0 30 *
Chris@0 31 * @param string $selector
Chris@0 32 */
Chris@0 33 public function __construct($selector) {
Chris@0 34 $this->selector = $selector;
Chris@0 35 }
Chris@0 36
Chris@0 37 /**
Chris@0 38 * Implements Drupal\Core\Ajax\CommandInterface:render().
Chris@0 39 */
Chris@0 40 public function render() {
Chris@0 41 return [
Chris@0 42 'command' => 'remove',
Chris@0 43 'selector' => $this->selector,
Chris@0 44 ];
Chris@0 45 }
Chris@0 46
Chris@0 47 }