class SetDialogOptionCommand in Drupal 9

Defines an AJAX command that sets jQuery UI dialog properties.

Hierarchy

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

Related topics

Ajax API

Overview for Drupal's Ajax API.

1 file declares its use of SetDialogOptionCommand

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

File

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

Namespace

Drupal\Core\Ajax

class SetDialogOptionCommand implements CommandInterface {

  /**
   * A CSS selector string.
   *
   * @var string
   */
  protected $selector;

  /**
   * A jQuery UI dialog option name.
   *
   * @var string
   */
  protected $optionName;

  /**
   * A jQuery UI dialog option value.
   *
   * @var mixed
   */
  protected $optionValue;

  /**
   * Constructs a SetDialogOptionCommand 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 $option_name
   *   The name of the option to set. May be any jQuery UI dialog option.
   *   See http://api.jqueryui.com/dialog.
   * @param mixed $option_value
   *   The value of the option to be passed to the dialog.
   */
  public function __construct($selector, $option_name, $option_value) {
    $this->selector = $selector ? $selector : '#drupal-modal';
    $this->optionName = $option_name;
    $this->optionValue = $option_value;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return [
      'command' => 'setDialogOption',
      'selector' => $this->selector,
      'optionName' => $this->optionName,
      'optionValue' => $this->optionValue,
    ];
  }

}

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
SetDialogOptionCommand::__construct	public	function	Constructs a SetDialogOptionCommand object.	1