[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Http Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Http;
  10  
  11  use Joomla\Uri\UriInterface;
  12  
  13  /**
  14   * HTTP transport class interface.
  15   *
  16   * @since  1.0
  17   */
  18  interface TransportInterface
  19  {
  20      /**
  21       * Send a request to the server and return a Response object with the response.
  22       *
  23       * @param   string        $method     The HTTP method for sending the request.
  24       * @param   UriInterface  $uri        The URI to the resource to request.
  25       * @param   mixed         $data       Either an associative array or a string to be sent with the request.
  26       * @param   array         $headers    An array of request headers to send with the request.
  27       * @param   integer       $timeout    Read timeout in seconds.
  28       * @param   string        $userAgent  The optional user agent string to send with the request.
  29       *
  30       * @return  Response
  31       *
  32       * @since   1.0
  33       */
  34  	public function request($method, UriInterface $uri, $data = null, array $headers = [], $timeout = null, $userAgent = null);
  35  
  36      /**
  37       * Method to check if HTTP transport layer available for using
  38       *
  39       * @return  boolean  True if available else false
  40       *
  41       * @since   1.0
  42       */
  43  	public static function isSupported();
  44  }