class SetDialogTitleCommand

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Ajax/SetDialogTitleCommand.php \Drupal\Core\Ajax\SetDialogTitleCommand
  2. 10 core/lib/Drupal/Core/Ajax/SetDialogTitleCommand.php \Drupal\Core\Ajax\SetDialogTitleCommand
  3. 11.x core/lib/Drupal/Core/Ajax/SetDialogTitleCommand.php \Drupal\Core\Ajax\SetDialogTitleCommand

Defines an AJAX command that sets jQuery UI dialog properties.

Hierarchy

Expanded class hierarchy of 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
View source 
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

Title Modifiers Object type Summary Overriden Title
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.