Defines an AJAX command to open certain content in a dialog in a modal dialog.
Expanded class hierarchy of OpenModalDialogCommand
class OpenModalDialogCommand extends OpenDialogCommand {
/**
* Constructs an OpenModalDialog object.
*
* The modal dialog differs from the normal modal provided by
* OpenDialogCommand in that a modal prevents other interactions on the page
* until the modal has been completed. Drupal provides a built-in modal for
* this purpose, so no selector needs to be provided.
*
* @param string $title
* The title of the dialog.
* @param string $html
* HTML that will be placed in the dialog.
* @param array $dialog_options
* (optional) Settings to be passed to the dialog implementation. Any
* jQuery UI option can be used. See http://api.jqueryui.com/dialog.
* @param array|null $settings
* (optional) Custom settings that will be passed to the Drupal behaviors
* on the content of the dialog. If left empty, the settings will be
* populated automatically from the current request.
*/
public function __construct($title, $html, array $dialog_options = array(), $settings = NULL) {
$dialog_options['modal'] = TRUE;
parent::__construct('#drupal-modal', $title, $html, $dialog_options, $settings);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
OpenDialogCommand:: |
protected | property | Stores dialog-specific options passed directly to jQuery UI dialogs. Any jQuery UI option can be used. See http://api.jqueryui.com/dialog. | |
OpenDialogCommand:: |
protected | property | HTML content that will placed in the dialog. | |
OpenDialogCommand:: |
protected | property | The selector of the dialog. | |
OpenDialogCommand:: |
protected | property | Custom settings that will be passed to the Drupal behaviors on the content of the dialog. | |
OpenDialogCommand:: |
protected | property | The title of the dialog. | |
OpenDialogCommand:: |
public | function | Returns the dialog options. | |
OpenDialogCommand:: |
public | function |
Implements \Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface:: |
|
OpenDialogCommand:: |
public | function | Sets a single dialog option value. | |
OpenDialogCommand:: |
public | function | Sets the dialog options array. | |
OpenDialogCommand:: |
public | function | Sets the dialog title (an alias of setDialogOptions). | |
OpenModalDialogCommand:: |
public | function |
Constructs an OpenModalDialog object. Overrides OpenDialogCommand:: |