PrivateMessageMembersAutocompleteResponseCommand.php in Private Message 8

Namespace

Drupal\private_message\Ajax

File

src/Ajax/PrivateMessageMembersAutocompleteResponseCommand.php

<?php

namespace Drupal\private_message\Ajax;

use Drupal\Core\Ajax\CommandInterface;

/**
 * Ajax command to return autocomplete member results to the browser.
 */
class PrivateMessageMembersAutocompleteResponseCommand implements CommandInterface {

  /**
   * The string for which results should be returned.
   *
   * @var string
   */
  protected $string;

  /**
   * The user information to be sent to the browser.
   *
   * @var array
   *   An array of user info, with each element of the array containing the
   *   following keys:
   *   - uid: The User ID of the user
   *   - username: The username of the user
   */
  protected $userInfo;

  /**
   * Constructs a PrivateMessageMembersAutocompleteResponseCommand object.
   *
   * @param string $string
   *   The string that was searched for.
   * @param array $userInfo
   *   An array of user info, with each element of the array containing the
   *   following keys:
   *   - uid: The User ID of the user
   *   - username: The username of the user.
   */
  public function __construct($string, array $userInfo) {
    $this->userInfo = $userInfo;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return [
      'command' => 'privateMessageMembersAutocompleteResponse',
      'string' => $this->string,
      'userInfo' => $this->userInfo,
    ];
  }

}

Classes

Name	Description
PrivateMessageMembersAutocompleteResponseCommand	Ajax command to return autocomplete member results to the browser.