The end user interface for doing HTTP requests.
If you're doing multiple requests to the same hostname it's often convenient to use the constructor arguments to create a scoped client. This allows you to keep your code DRY and not repeat hostnames, authentication, and other options.
Once you've created an instance of Client you can do requests using several methods. Each corresponds to a different HTTP method.
Client will maintain cookies from the responses done with a client instance. These cookies will be automatically added to future requests to matching hosts. Cookies will respect the Expires
, Path
and Domain
attributes. You can get the client's CookieCollection using cookies()
You can use the 'cookieJar' constructor option to provide a custom cookie jar instance you've restored from cache/disk. By default an empty instance of Cake\Http\Client\CookieCollection will be created.
By default any POST/PUT/PATCH/DELETE request with $data will send their data as application/x-www-form-urlencoded
unless there are attached files. In that case multipart/form-data
will be used.
When sending request bodies you can use the type
option to set the Content-Type for the request:
$http->get('/users', [], ['type' => 'json']);
The type
option sets both the Content-Type
and Accept
header, to the same mime type. When using type
you can use either a full mime type or an alias. If you need different types in the Accept and Content-Type headers you should set them manually and not use type
By using the auth
key you can use authentication. The type sub option can be used to specify which authentication strategy you want to use. CakePHP comes with a few built-in strategies:
By using the proxy
key you can set authentication credentials for a proxy if you need to use one. The type sub option can be used to specify which authentication strategy you want to use. CakePHP comes with built-in support for basic authentication.
\Cake\Http\Client\AdapterInterface
Adapter for sending requests.
array
Runtime config
bool
Whether the config property has already been configured with defaults
\Cake\Http\Cookie\CookieCollection
List of cookies from responses made with this client.
array
Default configuration for the client.
Returns headers for Accept/Content-Type based on a short type or full mime-type.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
__construct(array $config)
Create a new HTTP Client.
You can set the following options when creating a client:
curl
extension is loaded else \Cake\Http\Client\Adapter\Stream.array
$config optional Config options for scoped clients.
InvalidArgumentException
_addAuthentication(\Cake\Http\Client\Request $request, array $options)
Add authentication headers to the request.
Uses the authentication type to choose the correct strategy and use its methods to add headers.
\Cake\Http\Client\Request
$request The request to modify.
array
$options Array of options containing the 'auth' key.
\Cake\Http\Client\Request
The updated request object.
_addProxy(\Cake\Http\Client\Request $request, array $options)
Add proxy authentication headers.
Uses the authentication type to choose the correct strategy and use its methods to add headers.
\Cake\Http\Client\Request
$request The request to modify.
array
$options Array of options containing the 'proxy' key.
\Cake\Http\Client\Request
The updated request object.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
_createAuth(array $auth, array $options)
Create the authentication strategy.
Use the configuration options to create the correct authentication strategy handler.
array
$auth The authentication options to use.
array
$options The overall request options to use.
object
Authentication strategy instance.
Cake\Core\Exception\Exception
_createRequest(string $method, string $url, mixed $data, mixed $options)
Creates a new request object based on the parameters.
string
$method HTTP method name.
string
$url The url including query string.
mixed
$data The request body.
array
$options The options to use. Contains auth, proxy, etc.
\Cake\Http\Client\Request
_doRequest(string $method, string $url, mixed $data, mixed $options)
Helper method for doing non-GET requests.
string
$method HTTP method.
string
$url URL to request.
mixed
$data The request body.
array
$options The options to use. Contains auth, proxy, etc.
\Cake\Http\Client\Response
_mergeOptions(array $options)
Does a recursive merge of the parameter with the scope config.
array
$options Options to merge.
array
Options merged with set config.
_sendRequest(\Psr\Http\Message\RequestInterface $request, array $options)
Send a request without redirection.
\Psr\Http\Message\RequestInterface
$request The request to send.
array
$options Additional options to use.
\Cake\Http\Client\Response
_typeHeaders(string $type)
Returns headers for Accept/Content-Type based on a short type or full mime-type.
string
$type short type alias or full mimetype.
string[]
Headers to set on the request.
Cake\Core\Exception\Exception
addCookie(\Cake\Http\Cookie\CookieInterface $cookie)
Adds a cookie to the Client collection.
\Cake\Http\Cookie\CookieInterface
$cookie Cookie object.
$this
InvalidArgumentException
buildUrl(string $url, mixed $query, array $options)
Generate a URL based on the scoped client options.
string
$url Either a full URL or just the path.
string|array
$query optional The query data for the URL.
array
$options optional The config options stored with Client::config()
string
A complete url with scheme, port, host, and path.
configShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
cookies()
Get the cookies stored in the Client.
\Cake\Http\Cookie\CookieCollection
delete(string $url, mixed $data, array $options)
Do a DELETE request.
string
$url The url or path you want to request.
mixed
$data optional The request data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
get(string $url, mixed $data, array $options)
Do a GET request.
The $data argument supports a special _content
key for providing a request body in a GET request. This is generally not used, but services like ElasticSearch use this feature.
string
$url The url or path you want to request.
array|string
$data optional The query data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
head(string $url, array $data, array $options)
Do a HEAD request.
string
$url The url or path you want to request.
array
$data optional The query string data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
options(string $url, mixed $data, array $options)
Do an OPTIONS request.
string
$url The url or path you want to request.
mixed
$data optional The request data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
patch(string $url, mixed $data, array $options)
Do a PATCH request.
string
$url The url or path you want to request.
mixed
$data optional The request data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
post(string $url, mixed $data, array $options)
Do a POST request.
string
$url The url or path you want to request.
mixed
$data optional The post data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
put(string $url, mixed $data, array $options)
Do a PUT request.
string
$url The url or path you want to request.
mixed
$data optional The request data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
send(\Psr\Http\Message\RequestInterface $request, array $options)
Send a request.
Used internally by other methods, but can also be used to send handcrafted Request objects.
\Psr\Http\Message\RequestInterface
$request The request to send.
array
$options optional Additional options to use.
\Cake\Http\Client\Response
sendRequest(\Psr\Http\Message\RequestInterface $request)
Sends a PSR-7 request and returns a PSR-7 response.
\Psr\Http\Message\RequestInterface
$request Request instance.
\Psr\Http\Message\ResponseInterface
Response instance.
Psr\Http\Client\ClientExceptionInterface
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
trace(string $url, mixed $data, array $options)
Do a TRACE request.
string
$url The url or path you want to request.
mixed
$data optional The request data you want to send.
array
$options optional Additional options for the request.
\Cake\Http\Client\Response
Adapter for sending requests.
\Cake\Http\Client\AdapterInterface
Runtime config
array
Whether the config property has already been configured with defaults
bool
List of cookies from responses made with this client.
Cookies are indexed by the cookie's domain or request host name.
\Cake\Http\Cookie\CookieCollection
Default configuration for the client.
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Http.Client.html