Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Ajax;
Chris@0: 
Chris@0: /**
Chris@0:  * Generic AJAX command for inserting content.
Chris@0:  *
Chris@0:  * This command instructs the client to insert the given HTML using whichever
Chris@0:  * jQuery DOM manipulation method has been specified in the #ajax['method']
Chris@0:  * variable of the element that triggered the request.
Chris@0:  *
Chris@0:  * This command is implemented by Drupal.AjaxCommands.prototype.insert()
Chris@0:  * defined in misc/ajax.js.
Chris@0:  *
Chris@0:  * @ingroup ajax
Chris@0:  */
Chris@0: class InsertCommand implements CommandInterface, CommandWithAttachedAssetsInterface {
Chris@0: 
Chris@0:   use CommandWithAttachedAssetsTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * A CSS selector string.
Chris@0:    *
Chris@0:    * If the command is a response to a request from an #ajax form element then
Chris@0:    * this value can be NULL.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $selector;
Chris@0: 
Chris@0:   /**
Chris@0:    * The content for the matched element(s).
Chris@0:    *
Chris@0:    * Either a render array or an HTML string.
Chris@0:    *
Chris@0:    * @var string|array
Chris@0:    */
Chris@0:   protected $content;
Chris@0: 
Chris@0:   /**
Chris@0:    * A settings array to be passed to any attached JavaScript behavior.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $settings;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs an InsertCommand object.
Chris@0:    *
Chris@0:    * @param string $selector
Chris@0:    *   A CSS selector.
Chris@0:    * @param string|array $content
Chris@0:    *   The content that will be inserted in the matched element(s), either a
Chris@0:    *   render array or an HTML string.
Chris@0:    * @param array $settings
Chris@0:    *   An array of JavaScript settings to be passed to any attached behaviors.
Chris@0:    */
Chris@0:   public function __construct($selector, $content, array $settings = NULL) {
Chris@0:     $this->selector = $selector;
Chris@0:     $this->content = $content;
Chris@0:     $this->settings = $settings;
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' => 'insert',
Chris@0:       'method' => NULL,
Chris@0:       'selector' => $this->selector,
Chris@0:       'data' => $this->getRenderedContent(),
Chris@0:       'settings' => $this->settings,
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0: }