class SetDialogTitleCommand in Drupal 9

Defines an AJAX command that sets jQuery UI dialog properties.

Hierarchy

• class \Drupal\Core\Ajax\SetDialogOptionCommand implements CommandInterface
  • class \Drupal\Core\Ajax\SetDialogTitleCommand

Related topics

Ajax API

Overview for Drupal's Ajax API.

1 file declares its use of SetDialogTitleCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

File

core/lib/Drupal/Core/Ajax/SetDialogTitleCommand.php, line 10

Namespace

Drupal\Core\Ajax

class SetDialogTitleCommand extends SetDialogOptionCommand {

  /**
   * Constructs a SetDialogTitleCommand object.
   *
   * @param string $selector
   *   The selector of the dialog whose title will be set. If set to an empty
   *   value, the default modal dialog will be selected.
   * @param string $title
   *   The title that will be set on the dialog.
   */
  public function __construct($selector, $title) {
    $this->selector = $selector ? $selector : '#drupal-modal';
    $this->optionName = 'title';
    $this->optionValue = $title;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SetDialogOptionCommand::$optionName	protected	property	A jQuery UI dialog option name.
SetDialogOptionCommand::$optionValue	protected	property	A jQuery UI dialog option value.
SetDialogOptionCommand::$selector	protected	property	A CSS selector string.
SetDialogOptionCommand::render	public	function	Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
SetDialogTitleCommand::__construct	public	function	Constructs a SetDialogTitleCommand object. Overrides SetDialogOptionCommand::__construct