Overview

Namespaces

  • Baguette
    • Mastodon
      • Config
      • Entity
      • Grant
      • Service
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
  • Psr
    • Http
      • Message
  • Teto
    • Object

Classes

  • Client
  • HandlerStack
  • MessageFormatter
  • Middleware
  • Pool
  • PrepareBodyMiddleware
  • RedirectMiddleware
  • RequestOptions
  • RetryMiddleware
  • TransferStats
  • UriTemplate

Interfaces

  • ClientInterface

Functions

  • choose_handler
  • debug_resource
  • default_ca_bundle
  • default_user_agent
  • describe_type
  • headers_from_lines
  • is_host_in_noproxy
  • json_decode
  • json_encode
  • normalize_header_keys
  • uri_template
  • Overview
  • Namespace
  • Class

Interface ClientInterface

Client interface for sending HTTP requests.

Direct known implementers

GuzzleHttp\Client
Namespace: GuzzleHttp
Located at ClientInterface.php
Methods summary
public Psr\Http\Message\ResponseInterface
# send( Psr\Http\Message\RequestInterface $request, array $options = [] )

Send an HTTP request.

Send an HTTP request.

Parameters

$request
Request to send
$options

Request options to apply to the given request and to the transfer.

Returns

Psr\Http\Message\ResponseInterface

Throws

GuzzleHttp\Exception\GuzzleException
public GuzzleHttp\Promise\PromiseInterface
# sendAsync( Psr\Http\Message\RequestInterface $request, array $options = [] )

Asynchronously send an HTTP request.

Asynchronously send an HTTP request.

Parameters

$request
Request to send
$options

Request options to apply to the given request and to the transfer.

Returns

GuzzleHttp\Promise\PromiseInterface
public Psr\Http\Message\ResponseInterface
# request( string $method, string|Psr\Http\Message\UriInterface $uri, array $options = [] )

Create and send an HTTP request.

Create and send an HTTP request.

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.

Parameters

$method
HTTP method.
$uri
URI object or string.
$options
Request options to apply.

Returns

Psr\Http\Message\ResponseInterface

Throws

GuzzleHttp\Exception\GuzzleException
public GuzzleHttp\Promise\PromiseInterface
# requestAsync( string $method, string|Psr\Http\Message\UriInterface $uri, array $options = [] )

Create and send an asynchronous HTTP request.

Create and send an asynchronous HTTP request.

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.

Parameters

$method
HTTP method
$uri
URI object or string.
$options
Request options to apply.

Returns

GuzzleHttp\Promise\PromiseInterface
public mixed
# getConfig( string|null $option = null )

Get a client configuration option.

Get a client configuration option.

These options include default request options of the client, a "handler" (if utilized by the concrete client), and a "base_uri" if utilized by the concrete client.

Parameters

$option
The config option to retrieve.

Returns

mixed
Constants summary
string VERSION
# '6.2.1'
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by ApiGen