Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Ajax;
Chris@0: 
Chris@0: /**
Chris@0:  * AJAX command for invoking an arbitrary jQuery method.
Chris@0:  *
Chris@0:  * The 'invoke' command will instruct the client to invoke the given jQuery
Chris@0:  * method with the supplied arguments on the elements matched by the given
Chris@0:  * selector. Intended for simple jQuery commands, such as attr(), addClass(),
Chris@0:  * removeClass(), toggleClass(), etc.
Chris@0:  *
Chris@0:  * This command is implemented by Drupal.AjaxCommands.prototype.invoke()
Chris@0:  * defined in misc/ajax.js.
Chris@0:  *
Chris@0:  * @ingroup ajax
Chris@0:  */
Chris@0: class InvokeCommand implements CommandInterface {
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:    * A jQuery method to invoke.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $method;
Chris@0: 
Chris@0:   /**
Chris@0:    * An optional list of arguments to pass to the method.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $arguments;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs an InvokeCommand object.
Chris@0:    *
Chris@0:    * @param string $selector
Chris@0:    *   A jQuery selector.
Chris@0:    * @param string $method
Chris@0:    *   The name of a jQuery method to invoke.
Chris@0:    * @param array $arguments
Chris@0:    *   An optional array of arguments to pass to the method.
Chris@0:    */
Chris@0:   public function __construct($selector, $method, array $arguments = []) {
Chris@0:     $this->selector = $selector;
Chris@0:     $this->method = $method;
Chris@0:     $this->arguments = $arguments;
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' => 'invoke',
Chris@0:       'selector' => $this->selector,
Chris@0:       'method' => $this->method,
Chris@0:       'args' => $this->arguments,
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0: }