[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/vendor/guzzlehttp/guzzle/src/ -> ClientInterface.php (summary)

(no description)

File Size: 150 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ClientInterface:: (12 methods):
  createRequest()
  get()
  head()
  delete()
  put()
  patch()
  post()
  options()
  send()
  getDefaultOption()
  setDefaultOption()
  getBaseUrl()


Interface: ClientInterface  - X-Ref

Client interface for sending HTTP requests

createRequest($method, $url = null, array $options = [])   X-Ref
Create and return a new {@see RequestInterface} object.

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 URL can
contain the query string as well. Use an array to provide a URL
template and additional variables to use in the URL template expansion.

param: string           $method  HTTP method
param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: RequestInterface

get($url = null, $options = [])   X-Ref
Send a GET request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

head($url = null, array $options = [])   X-Ref
Send a HEAD request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

delete($url = null, array $options = [])   X-Ref
Send a DELETE request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

put($url = null, array $options = [])   X-Ref
Send a PUT request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

patch($url = null, array $options = [])   X-Ref
Send a PATCH request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

post($url = null, array $options = [])   X-Ref
Send a POST request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

options($url = null, array $options = [])   X-Ref
Send an OPTIONS request

param: string|array|Url $url     URL or URI template
param: array            $options Array of request options to apply.
return: ResponseInterface

send(RequestInterface $request)   X-Ref
Sends a single request

param: RequestInterface $request Request to send
return: \GuzzleHttp\Message\ResponseInterface

getDefaultOption($keyOrPath = null)   X-Ref
Get default request options of the client.

param: string|null $keyOrPath The Path to a particular default request
return: mixed

setDefaultOption($keyOrPath, $value)   X-Ref
Set a default request option on the client so that any request created
by the client will use the provided default value unless overridden
explicitly when creating a request.

param: string|null $keyOrPath The Path to a particular configuration
param: mixed $value Default request option value to set

getBaseUrl()   X-Ref
Get the base URL of the client.

return: string Returns the base URL if present



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1