class BaseCommand

Base command that only exists to simplify AJAX commands.

Hierarchy

Expanded class hierarchy of BaseCommand

File

View on git.drupalcode.org

core/lib/Drupal/Core/Ajax/BaseCommand.php, line 8

Namespace

Drupal\Core\Ajax
View source 
class BaseCommand implements CommandInterface {
  
  /**
   * The name of the command.
   *
   * @var string
   */
  protected $command;
  
  /**
   * The data to pass on to the client side.
   *
   * @var string
   */
  protected $data;
  
  /**
   * Constructs a BaseCommand object.
   *
   * @param string $command
   *   The name of the command.
   * @param string $data
   *   The data to pass on to the client side.
   */
  public function __construct($command, $data) {
    $this->command = $command;
    $this->data = $data;
  }
  
  /**
   * {@inheritdoc}
   */
  public function render() {
    return [
      'command' => $this->command,
      'data' => $this->data,
    ];
  }

}

Members

Title Modifiers Object type Summary Overriden Title
BaseCommand::$command protected property The name of the command.
BaseCommand::$data protected property The data to pass on to the client side.
BaseCommand::render public function Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
BaseCommand::__construct public function Constructs a BaseCommand object.

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