class SettingsCommand

AjaxCommandsUnitTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Ajax/AjaxCommandsUnitTest.php

Definition of Drupal\system\Tests\Ajax\AjaxCommandsUnitTest.

CommandsTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Ajax/CommandsTest.php

Contains \Drupal\system\Tests\Ajax\CommandsTest.

FrameworkTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Ajax/FrameworkTest.php

Contains \Drupal\system\Tests\Ajax\FrameworkTest.

class SettingsCommand implements CommandInterface {

  /**
   * An array of key/value pairs of JavaScript settings.
   *
   * This will be utilized for all commands after this if they do not include
   * their own settings array.
   *
   * @var array
   */
  protected $settings;

  /**
   * Whether the settings should be merged into the global Drupal.settings.
   *
   * By default (FALSE), the settings that are passed to Drupal.attachBehaviors
   * will not include the global Drupal.settings.
   *
   * @var boolean
   */
  protected $merge;

  /**
   * Constructs a SettingsCommand object.
   *
   * @param array $settings
   *   An array of key/value pairs of JavaScript settings.
   * @param boolean $merge
   *   Whether the settings should be merged into the global Drupal.settings.
   */
  public function __construct(array $settings, $merge = FALSE) {
    $this->settings = $settings;
    $this->merge = $merge;
  }

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return array(
      'command' => 'settings',
      'settings' => $this->settings,
      'merge' => $this->merge,
    );
  }

}