class Client in Little helpers 7

This a simple JSON REST Client based on drupal_http_request().

Hierarchy

• class \Drupal\little_helpers\Rest\Client

File

src/Rest/Client.php, line 8

Namespace

Drupal\little_helpers\Rest

class Client {
  protected $endpoint;
  protected $options;

  /**
   * Constructor.
   *
   * @param string $endpoint
   *   The base-URL for this API.
   * @param array $options
   *   Default options for all requests ie. credentials for Basic Auth.
   */
  public function __construct($endpoint, array $options = []) {
    $this->endpoint = $endpoint;
    $this->options = $options;
  }

  /**
   * Send a GET request to the API.
   *
   * @param string $path
   *   The path to call.
   * @param array $query
   *   An array of query parameters.
   * @param array $options
   *   Options for @see drupal_http_request().
   *
   * @return array
   *   The decoded data from the response.
   */
  public function get($path, array $query = [], array $options = []) {
    $options['method'] = 'GET';
    return $this
      ->send($path, $query, NULL, $options);
  }

  /**
   * Send a POST request to the API.
   *
   * @param string $path
   *   The path to call.
   * @param array $query
   *   An array of query parameters.
   * @param mixed $data
   *   JSON encodeable data.
   * @param array $options
   *   Options for @see drupal_http_request().
   *
   * @return array
   *   The decoded data from the response.
   */
  public function post($path, array $query = [], $data = NULL, array $options = []) {
    $options['method'] = 'POST';
    return $this
      ->send($path, $query, $data, $options);
  }

  /**
   * Send a PUT request to the API.
   *
   * @param string $path
   *   The path to call.
   * @param array $query
   *   An array of query parameters.
   * @param mixed $data
   *   JSON encodeable data.
   * @param array $options
   *   Options for @see drupal_http_request().
   *
   * @return array
   *   The decoded data from the response.
   */
  public function put($path, array $query = [], $data = NULL, array $options = []) {
    $options['method'] = 'PUT';
    return $this
      ->send($path, $query, $data, $options);
  }

  /**
   * Send a DELETE request to the API.
   *
   * @param string $path
   *   The path to call.
   * @param array $query
   *   An array of query parameters.
   * @param array $options
   *   Options for @see drupal_http_request().
   *
   * @return array
   *   The decoded data from the response.
   */
  public function delete($path, array $query = [], array $options = []) {
    $options['method'] = 'DELETE';
    return $this
      ->send($path, $query, NULL, $options);
  }

  /**
   * This method does the actual hard-work in this class.
   */
  protected function send($path, array $query = [], $data = NULL, array $options = []) {
    if (!$path || $path[0] != '/') {
      $path = '/' . $path;
    }
    if ($query) {
      $path .= '?' . http_build_query($query);
    }

    // Encode data if needed.
    if ($data) {
      $options['headers']['Content-Type'] = 'application/json';
      $options['headers']['Accept'] = 'application/json';
      if (!is_string($data)) {
        $data = drupal_json_encode($data);
      }
      $options['data'] = $data;
    }
    $url = $this->endpoint . $path;
    $options += $this->options;
    $result = $this
      ->sendRequest($url, $options);

    // Turn errors into exceptions.
    if (!empty($result->error)) {
      throw new HttpError($result);
    }
    return drupal_json_decode($result->data);
  }

  /**
   * Call @see drupal_http_request().
   *
   * Having this in it's own method is useful for testing and extensibility.
   *
   * @param string $url
   *   The URL.
   * @param array $options
   *   Options for drupal_http_request().
   *
   * @return object
   *   Result object as returned by drupal_http_request().
   */
  protected function sendRequest($url, array $options) {
    return drupal_http_request($url, $options);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Client::$endpoint	protected	property
Client::$options	protected	property
Client::delete	public	function	Send a DELETE request to the API.
Client::get	public	function	Send a GET request to the API.
Client::post	public	function	Send a POST request to the API.
Client::put	public	function	Send a PUT request to the API.
Client::send	protected	function	This method does the actual hard-work in this class.
Client::sendRequest	protected	function	Call Having this in it's own method is useful for testing and extensibility.
Client::__construct	public	function	Constructor.