class InvokeCommand in Drupal 9

AJAX command for invoking an arbitrary jQuery method.

The 'invoke' command will instruct the client to invoke the given jQuery method with the supplied arguments on the elements matched by the given selector. Intended for simple jQuery commands, such as attr(), addClass(), removeClass(), toggleClass(), etc.

This command is implemented by Drupal.AjaxCommands.prototype.invoke() defined in misc/ajax.js.

Hierarchy

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

Related topics

Ajax API

Overview for Drupal's Ajax API.

5 files declare their use of InvokeCommand

AddFormBase.php in core/modules/media_library/src/Form/AddFormBase.php

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

ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module

Simpletest mock module for Ajax forms testing.

MediaLibraryFieldWidgetOpener.php in core/modules/media_library/src/MediaLibraryFieldWidgetOpener.php

MediaLibraryWidget.php in core/modules/media_library/src/Plugin/Field/FieldWidget/MediaLibraryWidget.php

File

core/lib/Drupal/Core/Ajax/InvokeCommand.php, line 18

Namespace

Drupal\Core\Ajax

class InvokeCommand implements CommandInterface {

  /**
   * A CSS selector string.
   *
   * If the command is a response to a request from an #ajax form element then
   * this value can be NULL.
   *
   * @var string
   */
  protected $selector;

  /**
   * A jQuery method to invoke.
   *
   * @var string
   */
  protected $method;

  /**
   * An optional list of arguments to pass to the method.
   *
   * @var array
   */
  protected $arguments;

  /**
   * Constructs an InvokeCommand object.
   *
   * @param string $selector
   *   A jQuery selector.
   * @param string $method
   *   The name of a jQuery method to invoke.
   * @param array $arguments
   *   An optional array of arguments to pass to the method.
   */
  public function __construct($selector, $method, array $arguments = []) {
    $this->selector = $selector;
    $this->method = $method;
    $this->arguments = $arguments;
  }

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return [
      'command' => 'invoke',
      'selector' => $this->selector,
      'method' => $this->method,
      'args' => $this->arguments,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
InvokeCommand::$arguments	protected	property	An optional list of arguments to pass to the method.
InvokeCommand::$method	protected	property	A jQuery method to invoke.
InvokeCommand::$selector	protected	property	A CSS selector string.
InvokeCommand::render	public	function	Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface::render
InvokeCommand::__construct	public	function	Constructs an InvokeCommand object.