class CloseBootstrap4ModalDialogCommand in Bootstrap 4 Modal 2.x

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

Hierarchy

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

File

src/Ajax/CloseBootstrap4ModalDialogCommand.php, line 12

Namespace

Drupal\bootstrap4_modal\Ajax

class CloseBootstrap4ModalDialogCommand extends CloseModalDialogCommand {

  /**
   * Constructs a CloseModalDialogCommand 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 ?? '#drupal-bootstrap4-modal';
    $this->persist = $persist;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return [
      'command' => 'closeBootstrap4Dialog',
      'selector' => $this->selector,
      'persist' => $this->persist,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CloseBootstrap4ModalDialogCommand::render	public	function	Return an array to be run through json_encode and sent to the client. Overrides CloseDialogCommand::render
CloseBootstrap4ModalDialogCommand::__construct	public	function	Constructs a CloseModalDialogCommand object. Overrides CloseModalDialogCommand::__construct
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.