1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Ajax
  7. \
  8. OpenDialogCommand

OpenDialogCommand

class OpenDialogCommand implements CommandInterface, CommandWithAttachedAssetsInterface (View source)

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

Traits

CommandWithAttachedAssetsTrait

Trait for Ajax commands that render content and attach assets.

Properties

protected AttachedAssets $attachedAssets

The attached assets for this Ajax command.

 from  CommandWithAttachedAssetsTrait
protected string $selector

The selector of the dialog.
protected string $title

The title of the dialog.
protected string|array $content

The content for the dialog.
protected array $dialogOptions

Stores dialog-specific options passed directly to jQuery UI dialogs. Any jQuery UI option can be used. See http://api.jqueryui.com/dialog.
protected array $settings

Custom settings that will be passed to the Drupal behaviors on the content of the dialog.

Methods

string|MarkupInterface
getRenderedContent()

Processes the content for output.

from  CommandWithAttachedAssetsTrait
AttachedAssets|null
getAttachedAssets()

Gets the attached assets.

from  CommandWithAttachedAssetsTrait
__construct(string $selector, string $title, string|array $content, array $dialog_options = [], array|null $settings = NULL)

Constructs an OpenDialogCommand object.

array
getDialogOptions()

Returns the dialog options.

setDialogOptions(array $dialog_options)

Sets the dialog options array.

setDialogOption(string $key, mixed $value)

Sets a single dialog option value.

setDialogTitle(string $title)

Sets the dialog title (an alias of setDialogOptions).

render()

Implements \Drupal\Core\Ajax\CommandInterface:render().

Details

in CommandWithAttachedAssetsTrait at line 30
protected string|MarkupInterface getRenderedContent()

Processes the content for output.

If content is a render array, it may contain attached assets to be processed.

Return Value

string|MarkupInterface

HTML rendered content.

in CommandWithAttachedAssetsTrait at line 51
AttachedAssets|null getAttachedAssets()

Gets the attached assets.

Return Value

AttachedAssets|null

The attached assets for this command.

at line 73
__construct(string $selector, string $title, string|array $content, array $dialog_options = [], array|null $settings = NULL)

Constructs an OpenDialogCommand object.

Parameters

string $selector

The selector of the dialog.
string $title

The title of the dialog.
string|array $content

The content that will be placed in the dialog, either a render array or an HTML string.
array $dialog_options

(optional) Options 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.

at line 87
array getDialogOptions()

Returns the dialog options.

Return Value

array

at line 98
setDialogOptions(array $dialog_options)

Sets the dialog options array.

Parameters

array $dialog_options

Options to be passed to the dialog implementation. Any jQuery UI option can be used. See http://api.jqueryui.com/dialog.

at line 111
setDialogOption(string $key, mixed $value)

Sets a single dialog option value.

Parameters

string $key

Key of the dialog option. Any jQuery UI option can be used. See http://api.jqueryui.com/dialog.
mixed $value

Option to be passed to the dialog implementation.

at line 121
setDialogTitle(string $title)

Sets the dialog title (an alias of setDialogOptions).

Parameters

string $title

The new title of the dialog.

at line 128
render()

Implements \Drupal\Core\Ajax\CommandInterface:render().