Files
yookassa-sdk-php/docs/classes/YooKassa-Client-CurlClient.md
Евгений Ю. Лозный 260d13f890 Добавлен прием платежей через Alfa Pay. Добавлен новый тип ошибки RuleViolationError
Добавлены нулевые привязки по СБП
Добавлена причина отмены возвратов `payment_expired`
2026-06-29 17:46:40 +03:00

15 KiB

YooKassa API SDK

Class: \YooKassa\Client\CurlClient

Namespace: \YooKassa\Client


Summary:

Класс, представляющий модель CurlClient.

Description:

Класс клиента Curl запросов.


Constants

  • No constants found

Methods

Visibility Name Flag Summary
public __construct() CurlClient constructor.
public call() Создает CURL запрос, получает и возвращает обработанный ответ
public closeCurlConnection() Close connection.
public getConfig() Возвращает настройки.
public getConnectionTimeout() Возвращает значение параметра CURLOPT_CONNECTTIMEOUT.
public getProxy() Возвращает настройки прокси.
public getTimeout() Возвращает значение параметра CURLOPT_TIMEOUT.
public getUserAgent() Возвращает UserAgent.
public sendRequest() Выполняет запрос, получает и возвращает обработанный ответ
public setAdvancedCurlOptions() Устанавливает дополнительные настройки curl.
public setBearerToken() Устанавливает OAuth-токен магазина.
public setBody() Устанавливает тело запроса.
public setConfig() Устанавливает настройки.
public setConnectionTimeout() Устанавливает значение параметра CURLOPT_CONNECTTIMEOUT.
public setCurlOption() Устанавливает параметры CURL.
public setKeepAlive() Устанавливает флаг сохранения соединения.
public setLogger() Устанавливает объект для логирования.
public setProxy() Устанавливает настройки прокси.
public setShopId() Устанавливает shopId магазина.
public setShopPassword() Устанавливает секретный ключ магазина.
public setTimeout() Устанавливает значение параметра CURLOPT_TIMEOUT.

Details


Tags

Tag Version Description
category Class
author cms@yoomoney.ru

Methods

public __construct() : mixed

public __construct() : mixed

Summary

CurlClient constructor.

Details:

Returns: mixed -

public call() : \YooKassa\Common\ResponseObject

public call(string $path, string $method, array $queryParams, null|string $httpBody = null, array $headers = []) : \YooKassa\Common\ResponseObject

Summary

Создает CURL запрос, получает и возвращает обработанный ответ

Details:

Parameters:
Type Name Description
string path URL запроса
string method HTTP метод
array queryParams Массив GET параметров запроса
null OR string httpBody Тело запроса
array headers Массив заголовков запроса
Throws:
Type Description
\YooKassa\Common\Exceptions\ApiConnectionException
\YooKassa\Common\Exceptions\ApiException
\YooKassa\Common\Exceptions\AuthorizeException
\YooKassa\Common\Exceptions\ExtensionNotFoundException

Returns: \YooKassa\Common\ResponseObject -

public closeCurlConnection() : void

public closeCurlConnection() : void

Summary

Close connection.

Details:

Returns: void -

public getConfig() : array

public getConfig() : array

Summary

Возвращает настройки.

Details:

Returns: array -

public getConnectionTimeout() : int

public getConnectionTimeout() : int

Summary

Возвращает значение параметра CURLOPT_CONNECTTIMEOUT.

Details:

Returns: int -

public getProxy() : string

public getProxy() : string

Summary

Возвращает настройки прокси.

Details:

Returns: string -

public getTimeout() : int

public getTimeout() : int

Summary

Возвращает значение параметра CURLOPT_TIMEOUT.

Details:

Returns: int -

public getUserAgent() : \YooKassa\Client\UserAgent

public getUserAgent() : \YooKassa\Client\UserAgent

Summary

Возвращает UserAgent.

Details:

Returns: \YooKassa\Client\UserAgent -

public sendRequest() : array

public sendRequest() : array

Summary

Выполняет запрос, получает и возвращает обработанный ответ

Details:

Throws:
Type Description
\YooKassa\Common\Exceptions\ApiConnectionException

Returns: array -

public setAdvancedCurlOptions() : void

public setAdvancedCurlOptions() : void

Summary

Устанавливает дополнительные настройки curl.

Details:

Returns: void -

public setBearerToken() : $this

public setBearerToken(null|string $bearerToken) : $this

Summary

Устанавливает OAuth-токен магазина.

Details:

Parameters:
Type Name Description
null OR string bearerToken OAuth-токен магазина

Returns: $this -

public setBody() : void

public setBody(string $method, string|null $httpBody = null) : void

Summary

Устанавливает тело запроса.

Details:

Parameters:
Type Name Description
string method HTTP метод
string OR null httpBody Тело запроса

Returns: void -

public setConfig() : void

public setConfig(array $config) : void

Summary

Устанавливает настройки.

Details:

Parameters:
Type Name Description
array config Настройки клиента

Returns: void -

public setConnectionTimeout() : void

public setConnectionTimeout(int $connectionTimeout = 30) : void

Summary

Устанавливает значение параметра CURLOPT_CONNECTTIMEOUT.

Details:

Parameters:
Type Name Description
int connectionTimeout Число секунд ожидания при попытке подключения

Returns: void -

public setCurlOption() : bool

public setCurlOption(string $optionName, mixed $optionValue) : bool

Summary

Устанавливает параметры CURL.

Details:

Parameters:
Type Name Description
string optionName Имя параметра
mixed optionValue Значение параметра

Returns: bool -

public setKeepAlive() : $this

public setKeepAlive(bool $keepAlive) : $this

Summary

Устанавливает флаг сохранения соединения.

Details:

Parameters:
Type Name Description
bool keepAlive Флаг сохранения настроек

Returns: $this -

public setLogger() : void

public setLogger(?\Psr\Log\LoggerInterface $logger) : void

Summary

Устанавливает объект для логирования.

Details:

Parameters:
Type Name Description
?\Psr\Log\LoggerInterface logger Объект для логирования

Returns: void -

public setProxy() : void

public setProxy(string $proxy) : void

Summary

Устанавливает настройки прокси.

Details:

Parameters:
Type Name Description
string proxy Прокси сервер

Returns: void -

public setShopId() : $this

public setShopId(mixed $shopId) : $this

Summary

Устанавливает shopId магазина.

Details:

Parameters:
Type Name Description
mixed shopId shopId магазина

Returns: $this -

public setShopPassword() : $this

public setShopPassword(string|null $shopPassword) : $this

Summary

Устанавливает секретный ключ магазина.

Details:

Parameters:
Type Name Description
string OR null shopPassword Секретный ключ магазина

Returns: $this -

public setTimeout() : void

public setTimeout(int $timeout) : void

Summary

Устанавливает значение параметра CURLOPT_TIMEOUT.

Details:

Parameters:
Type Name Description
int timeout Максимальное количество секунд для выполнения функций cURL

Returns: void -


Top Namespaces


Reports


This document was automatically generated from source code comments on 2026-06-29 using phpDocumentor

© 2026 YooMoney