BaseCommand.php

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

Namespace

Drupal\Core\Ajax

File

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

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * Base command that only exists to simplify AJAX commands.
 */
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,
        ];
    }

}

Classes

Title Deprecated Summary
BaseCommand Base command that only exists to simplify AJAX commands.

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