Source for file transport.php

Documentation is available at transport.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  HTTP
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * HTTP transport class interface.
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  HTTP
  17.  * @since       11.3
  18.  */
  19. interface JHttpTransport
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   JRegistry  $options  Client options object.
  25.      *
  26.      * @since   11.3
  27.      */
  28.     public function __construct(JRegistry $options);
  29.  
  30.     /**
  31.      * Send a request to the server and return a JHttpResponse object with the response.
  32.      *
  33.      * @param   string   $method     The HTTP method for sending the request.
  34.      * @param   JUri     $uri        The URI to the resource to request.
  35.      * @param   mixed    $data       Either an associative array or a string to be sent with the request.
  36.      * @param   array    $headers    An array of request headers to send with the request.
  37.      * @param   integer  $timeout    Read timeout in seconds.
  38.      * @param   string   $userAgent  The optional user agent string to send with the request.
  39.      *
  40.      * @return  JHttpResponse 
  41.      *
  42.      * @since   11.3
  43.      */
  44.     public function request($method, JUri $uri, $data = null, array $headers = null, $timeout = null, $userAgent = null);
  45.  
  46.     /**
  47. /**
  48.      * Method to check if HTTP transport is available for use
  49.      *
  50.      * @return  boolean  True if available else false
  51.      *
  52.      * @since   12.1
  53.      */
  54.     public static function isSupported();
  55. }

Documentation generated on Tue, 19 Nov 2013 15:16:00 +0100 by phpDocumentor 1.4.3