Drupal 8  8.0.2
OpenModalDialogCommand Class Reference
Inheritance diagram for OpenModalDialogCommand:

Public Member Functions

 __construct ($title, $content, array $dialog_options=array(), $settings=NULL)
 
- Public Member Functions inherited from OpenDialogCommand
 __construct ($selector, $title, $content, array $dialog_options=array(), $settings=NULL)
 
 getDialogOptions ()
 
 setDialogOptions ($dialog_options)
 
 setDialogOption ($key, $value)
 
 setDialogTitle ($title)
 
 render ()
 
- Public Member Functions inherited from CommandInterface
 render ()
 
 __construct ($selector)
 
 render ()
 
- Public Member Functions inherited from CommandWithAttachedAssetsInterface
 getAttachedAssets ()
 

Additional Inherited Members

- Protected Attributes inherited from OpenDialogCommand
 $selector
 
 $title
 
 $content
 
 $dialogOptions
 
 $settings
 
- Protected Attributes inherited from CommandInterface
 $selector
 

Detailed Description

Defines an AJAX command to open certain content in a dialog in a modal dialog.

Constructor & Destructor Documentation

__construct (   $title,
  $content,
array  $dialog_options = array(),
  $settings = NULL 
)

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.

Parameters
string$titleThe title of the dialog.
string | array$contentThe content that will be placed in the dialog, either a render array or an HTML string.
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.
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.

The documentation for this class was generated from the following file: