Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Ajax;
Chris@0: 
Chris@0: /**
Chris@0:  * AJAX command for adjusting Drupal's JavaScript settings.
Chris@0:  *
Chris@0:  * The 'settings' command instructs the client either to use the given array as
Chris@0:  * the settings for ajax-loaded content or to extend drupalSettings with the
Chris@0:  * given array, depending on the value of the $merge parameter.
Chris@0:  *
Chris@0:  * This command is implemented by Drupal.AjaxCommands.prototype.settings()
Chris@0:  * defined in misc/ajax.js.
Chris@0:  *
Chris@0:  * @ingroup ajax
Chris@0:  */
Chris@0: class SettingsCommand implements CommandInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of key/value pairs of JavaScript settings.
Chris@0:    *
Chris@0:    * This will be used for all commands after this if they do not include their
Chris@0:    * own settings array.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $settings;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether the settings should be merged into the global drupalSettings.
Chris@0:    *
Chris@0:    * By default (FALSE), the settings that are passed to Drupal.attachBehaviors
Chris@0:    * will not include the global drupalSettings.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   protected $merge;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a SettingsCommand object.
Chris@0:    *
Chris@0:    * @param array $settings
Chris@0:    *   An array of key/value pairs of JavaScript settings.
Chris@0:    * @param bool $merge
Chris@0:    *   Whether the settings should be merged into the global drupalSettings.
Chris@0:    */
Chris@0:   public function __construct(array $settings, $merge = FALSE) {
Chris@0:     $this->settings = $settings;
Chris@0:     $this->merge = $merge;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Implements Drupal\Core\Ajax\CommandInterface:render().
Chris@0:    */
Chris@0:   public function render() {
Chris@0: 
Chris@0:     return [
Chris@0:       'command' => 'settings',
Chris@0:       'settings' => $this->settings,
Chris@0:       'merge' => $this->merge,
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0: }