class InvokeCommand

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

Expanded class hierarchy of InvokeCommand

Related topics

Ajax API
Overview for Drupal's Ajax API.
4 files declare their use of InvokeCommand
AddFormBase.php in core/modules/media_library/src/Form/AddFormBase.php
ckeditor5.module in core/modules/ckeditor5/ckeditor5.module
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
View source 
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

Title Modifiers Object type Summary Overriden Title
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.