class CloseModalDialogCommand in Drupal 8

Defines an AJAX command that closes the currently visible modal dialog.

Hierarchy

• class \Drupal\Core\Ajax\CloseDialogCommand implements CommandInterface
  • class \Drupal\Core\Ajax\CloseModalDialogCommand

Related topics

Ajax API

Overview for Drupal's Ajax API.

5 files declare their use of CloseModalDialogCommand

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

EditorImageDialog.php in core/modules/editor/src/Form/EditorImageDialog.php

EditorLinkDialog.php in core/modules/editor/src/Form/EditorLinkDialog.php

EditorMediaDialog.php in core/modules/media/src/Form/EditorMediaDialog.php

ViewsFormBase.php in core/modules/views_ui/src/Form/Ajax/ViewsFormBase.php

File

core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php, line 10

Namespace

Drupal\Core\Ajax

class CloseModalDialogCommand extends CloseDialogCommand {

  /**
   * Constructs a CloseModalDialogCommand object.
   *
   * @param bool $persist
   *   (optional) Whether to persist the dialog in the DOM or not.
   */
  public function __construct($persist = FALSE) {
    $this->selector = '#drupal-modal';
    $this->persist = $persist;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CloseDialogCommand::$persist	protected	property	Whether to persist the dialog in the DOM or not.
CloseDialogCommand::$selector	protected	property	A CSS selector string of the dialog to close.
CloseDialogCommand::render	public	function	Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
CloseModalDialogCommand::__construct	public	function	Constructs a CloseModalDialogCommand object. Overrides CloseDialogCommand::__construct