mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-08-27 10:29:14 +00:00
Антон Н. Николаев
bd2a5b95fd
Обновлены описания классов, свойств и методов для документации Добавлена документация Добавлены примеры использования SDK
5.8 KiB
5.8 KiB
YooKassa API SDK
Interface: ApiClientInterface
Namespace: \YooKassa\Client
Summary:
Interface ApiClientInterface
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | call() | Создает CURL запрос, получает и возвращает обработанный ответ | |
| public | getUserAgent() | Возвращает UserAgent | |
| public | setBearerToken() | Устанавливает OAuth-токен магазина | |
| public | setConfig() | Устанавливает настройки | |
| public | setLogger() | Устанавливает объект для логирования | |
| public | setShopId() | Устанавливает shopId магазина | |
| public | setShopPassword() | Устанавливает секретный ключ магазина |
Details
- File: lib/Client/ApiClientInterface.php
- Package: \YooKassa
Methods
public call() : \YooKassa\Common\ResponseObject
public call(string path, string method, array queryParams, string|null httpBody = null, array headers = array()) : \YooKassa\Common\ResponseObject
Summary
Создает CURL запрос, получает и возвращает обработанный ответ
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
path | URL запроса |
string |
method | HTTP метод |
array |
queryParams | Массив GET параметров запроса |
string OR null |
httpBody | Тело запроса |
array |
headers | Массив заголовков запроса |
Returns: \YooKassa\Common\ResponseObject -
public setLogger() : mixed
public setLogger(\Psr\Log\LoggerInterface|null logger) : mixed
Summary
Устанавливает объект для логирования
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
\Psr\Log\LoggerInterface OR null |
logger | Объект для логирования |
Returns: mixed -
public getUserAgent() : \YooKassa\Client\UserAgent
public getUserAgent() : \YooKassa\Client\UserAgent
Summary
Возвращает UserAgent
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Returns: \YooKassa\Client\UserAgent -
public setShopId() : mixed
public setShopId(string|int shopId) : mixed
Summary
Устанавливает shopId магазина
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string OR int |
shopId | shopId магазина |
Returns: mixed -
public setShopPassword() : mixed
public setShopPassword(string shopPassword) : mixed
Summary
Устанавливает секретный ключ магазина
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
shopPassword |
Returns: mixed -
public setBearerToken() : mixed
public setBearerToken(string bearerToken) : mixed
Summary
Устанавливает OAuth-токен магазина
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
bearerToken |
Returns: mixed -
public setConfig() : mixed
public setConfig(array config) : mixed
Summary
Устанавливает настройки
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
array |
config |
Returns: mixed -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2021-04-21 using phpDocumentor
© 2021 YooMoney