class CloseDialogCommand

Defines an AJAX command that closes the current active dialog.

Hierarchy

Expanded class hierarchy of CloseDialogCommand

3 files declare their use of CloseDialogCommand
AjaxCommandsUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Ajax/AjaxCommandsUnitTest.php
Definition of Drupal\system\Tests\Ajax\AjaxCommandsUnitTest.
ajax_test.module in drupal/core/modules/system/tests/modules/ajax_test/ajax_test.module
Helper module for Ajax framework tests.
CloseModalDialogCommand.php in drupal/core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php
Contains \Drupal\Core\Ajax\CloseModalDialogCommand.

File

drupal/core/lib/Drupal/Core/Ajax/CloseDialogCommand.php, line 13
Contains \Drupal\Core\Ajax\CloseDialogCommand.

Namespace

Drupal\Core\Ajax
View source
class CloseDialogCommand implements CommandInterface {

  /**
   * A CSS selector string of the dialog to close.
   *
   * @var string
   */
  protected $selector;

  /**
   * Constructs a CloseDialogCommand object.
   *
   * @param string $selector
   *   A CSS selector string of the dialog to close.
   */
  public function __construct($selector = NULL) {
    $this->selector = $selector ? $selector : '#drupal-modal';
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
CloseDialogCommand::$selector protected property A CSS selector string of the dialog to close.
CloseDialogCommand::render public function Implements \Drupal\Core\Ajax\CommandInterface::render(). Overrides CommandInterface::render
CloseDialogCommand::__construct public function Constructs a CloseDialogCommand object. 1