CloseDialogCommand.php

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

Namespace

Drupal\Core\Ajax

File

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

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * Defines an AJAX command that closes the current active dialog.
 *
 * @ingroup ajax
 */
class CloseDialogCommand implements CommandInterface {
    
    /**
     * A CSS selector string of the dialog to close.
     *
     * @var string
     */
    protected $selector;
    
    /**
     * Whether to persist the dialog in the DOM or not.
     *
     * @var bool
     */
    protected $persist;
    
    /**
     * Constructs a CloseDialogCommand object.
     *
     * @param string $selector
     *   A CSS selector string of the dialog to close.
     * @param bool $persist
     *   (optional) Whether to persist the dialog in the DOM or not.
     */
    public function __construct($selector = NULL, $persist = FALSE) {
        $this->selector = $selector ? $selector : '#drupal-modal';
        $this->persist = $persist;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        return [
            'command' => 'closeDialog',
            'selector' => $this->selector,
            'persist' => $this->persist,
        ];
    }

}

Classes

Title Deprecated Summary
CloseDialogCommand Defines an AJAX command that closes the current active dialog.

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