Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

252 lines (227 sloc) 8.432 kb
<?php
namespace Guzzle\Http;
use Guzzle\Common\HasDispatcherInterface;
use Guzzle\Common\Collection;
use Guzzle\Http\Message\RequestInterface;
use Guzzle\Http\Message\RequestFactoryInterface;
use Guzzle\Parser\UriTemplate\UriTemplateInterface;
use Guzzle\Http\Curl\CurlMultiInterface;
/**
* Client interface for send HTTP requests
*/
interface ClientInterface extends HasDispatcherInterface
{
/**
* Set the configuration object to use with the client
*
* @param array|Collection|string $config Parameters that define how the client
* behaves and connects to a webservice.
* Pass an array or a Collection object.
*
* @return ClientInterface
*/
function setConfig($config);
/**
* Get a configuration setting or all of the configuration settings
*
* @param bool|string $key Configuration value to retrieve. Set to FALSE
* to retrieve all values of the client. The
* object return can be modified, and modifications
* will affect the client's config.
*
* @return mixed|Collection
*/
function getConfig($key = false);
/**
* Get the default HTTP headers to add to each request created by the client
*
* @return Collection
*/
function getDefaultHeaders();
/**
* Set the default HTTP headers to add to each request created by the client
*
* @param array|Collection $headers Default HTTP headers
*
* @return ClientInterface
*/
function setDefaultHeaders($headers);
/**
* Set the URI template expander to use with the client
*
* @param UriTemplateInterface $uriTemplate URI template expander
*
* @return ClientInterface
*/
function setUriTemplate(UriTemplateInterface $uriTemplate);
/**
* Get the URI template expander used by the client
*
* @return UriTemplate
*/
function getUriTemplate();
/**
* Expand a URI template using client configuration data
*
* @param string $template URI template to expand
* @param array $variables Additional variables to use in the expansion
*
* @return string
*/
function expandTemplate($template, array $variables = null);
/**
* Create and return a new {@see RequestInterface} configured for the client.
*
* Use an absolute path to override the base path of the client, or a
* relative path to append to the base path of the client. The URI can
* contain the query string as well. Use an array to provide a URI
* template and additional variables to use in the URI template expansion.
*
* @param string $method HTTP method. Defaults to GET
* @param string|array $uri Resource URI.
* @param array|Collection $headers HTTP headers
* @param string|resource|array|EntityBody $body Entity body of request (POST/PUT) or response (GET)
*
* @return RequestInterface
* @throws InvalidArgumentException if a URI array is passed that does not
* contain exactly two elements: the URI
* followed by template variables
*/
function createRequest($method = RequestInterface::GET, $uri = null, $headers = null, $body = null);
/**
* Get the client's base URL as either an expanded or raw URI template
*
* @param bool $expand Set to FALSE to get the raw base URL without URI
* template expansion
*
* @return string|null
*/
function getBaseUrl($expand = true);
/**
* Set the base URL of the client
*
* @param string $url The base service endpoint URL of the webservice
*
* @return ClientInterface
*/
function setBaseUrl($url);
/**
* Set the name of your application and application version that will be
* appended to the User-Agent header of all requests.
*
* @param string $userAgent User agent string
* @param bool $includeDefault Set to TRUE to append the default Guzzle use agent
*
* @return ClientInterface
*/
function setUserAgent($userAgent, $includeDefault = false);
/**
* Create a GET request for the client
*
* @param string|array $uri Resource URI
* @param array|Collection $headers HTTP headers
* @param string|resource|array|EntityBody $body Where to store the response entity body
*
* @return Request
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function get($uri = null, $headers = null, $body = null);
/**
* Create a HEAD request for the client
*
* @param string|array $uri Resource URI
* @param array|Collection $headers HTTP headers
*
* @return Request
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function head($uri = null, $headers = null);
/**
* Create a DELETE request for the client
*
* @param string|array $uri Resource URI
* @param array|Collection $headers HTTP headers
*
* @return Request
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function delete($uri = null, $headers = null);
/**
* Create a PUT request for the client
*
* @param string|array $uri Resource URI
* @param array|Collection $headers HTTP headers
* @param string|resource|EntityBody $body Body to send in the request
*
* @return EntityEnclosingRequest
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function put($uri = null, $headers = null, $body = null);
/**
* Create a PATCH request for the client
*
* @param string|array $uri Resource URI
* @param array|Collection $headers HTTP headers
* @param string|resource|EntityBody $body Body to send in the request
*
* @return EntityEnclosingRequest
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function patch($uri = null, $headers = null, $body = null);
/**
* Create a POST request for the client
*
* @param string|array $uri Resource URI
* @param array|Collection $headers HTTP headers
* @param array|Collection|string|EntityBody $postBody POST body. Can be a string, EntityBody,
* or associative array of POST fields to
* send in the body of the request. Prefix
* a value in the array with the @ symbol
* reference a file.
*
* @return EntityEnclosingRequest
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function post($uri = null, $headers = null, $postBody = null);
/**
* Create an OPTIONS request for the client
*
* @param string|array $uri Resource URI
*
* @return Request
* @see Guzzle\Http\ClientInterface::createRequest()
*/
function options($uri = null);
/**
* Sends a single request or an array of requests in parallel
*
* @param array $requests Request(s) to send
*
* @return array Returns the response(s)
*/
function send($requests);
/**
* Set a curl multi object to be used internally by the client for
* transferring requests.
*
* @param CurlMultiInterface $curlMulti Multi object
*
* @return ClientInterface
*/
function setCurlMulti(CurlMultiInterface $curlMulti);
/**
* Get the curl multi object to be used internally by the client for
* transferring requests.
*
* @return CurlMultiInterface
*/
function getCurlMulti();
/**
* Set the request factory to use with the client when creating requests
*
* @param RequestFactoryInterface $factory Request factory
*
* @return ClientInterface
*/
function setRequestFactory(RequestFactoryInterface $factory);
}
Jump to Line
Something went wrong with that request. Please try again.