You are here

HttpClientInterface.php in Bibliography Module 7.2

File

modules/CiteProc/Github/HttpClientInterface.php
View source
<?php

/**
 * Performs requests on GitHub API. API documentation should be self-explanatory.
 *
 * @author    Thibault Duplessis <thibault.duplessis at gmail dot com>
 * @license   MIT License
 */
interface Github_HttpClientInterface {

  /**
   * Send a GET request
   *
   * @param  string   $path            Request path
   * @param  array    $parameters     GET Parameters
   * @param  string   $httpMethod     HTTP method to use
   * @param  array    $options        reconfigure the request for this call only
   *
   * @return array                    Data
   */
  public function get($path, array $parameters = array(), array $options = array());

  /**
   * Send a POST request
   *
   * @param  string   $path            Request path
   * @param  array    $parameters     POST Parameters
   * @param  string   $httpMethod     HTTP method to use
   * @param  array    $options        reconfigure the request for this call only
   *
   * @return array                    Data
   */
  public function post($path, array $parameters = array(), array $options = array());

  /**
   * Change an option value.
   *
   * @param string $name   The option name
   * @param mixed  $value  The value
   *
   * @return Github_HttpClientInterface The current object instance
   */
  public function setOption($name, $value);

}

Interfaces

Namesort descending Description
Github_HttpClientInterface Performs requests on GitHub API. API documentation should be self-explanatory.