InvokeCommand.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Ajax/InvokeCommand.php
  2. 10 core/lib/Drupal/Core/Ajax/InvokeCommand.php
  3. 11.x core/lib/Drupal/Core/Ajax/InvokeCommand.php

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/InvokeCommand.php

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * 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.
 *
 * @ingroup 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,
        ];
    }

}

Classes

Title Deprecated Summary
InvokeCommand AJAX command for invoking an arbitrary jQuery method.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.