class CloseModalDialogCommand

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php \Drupal\Core\Ajax\CloseModalDialogCommand
  2. 10 core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php \Drupal\Core\Ajax\CloseModalDialogCommand
  3. 11.x core/lib/Drupal/Core/Ajax/CloseModalDialogCommand.php \Drupal\Core\Ajax\CloseModalDialogCommand

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

Hierarchy

Expanded class hierarchy of 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
View source 
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

Title Modifiers Object type Summary Overriden Title
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

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