diff --git a/CHANGELOG.md b/CHANGELOG.md index aed1f5b8..bbe7eff8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +### v2.1.0 от 21.04.2021 +* Добавлены новые методы +* Изменены некоторые методы +* Обновлены описания классов, свойств и методов для документации +* Добавлена документация +* Добавлены примеры использования SDK + ### v2.0.7 от 03.03.2021 * Исправлена ошибка в обработчике кода товара diff --git a/README.en.md b/README.en.md index 07b12650..f680991f 100644 --- a/README.en.md +++ b/README.en.md @@ -60,4 +60,37 @@ use YooKassa\Client; $client = new Client(); $client->setAuth('shopId', 'secretKey'); ``` -3. Call the required API method. [More details in our documentation for the YooKassa API](https://yookassa.ru/en/developers/api#create_payment) +3. Call the required API method. + + [More details in our documentation for the YooKassa API](https://yookassa.ru/en/developers/api#create_payment). + + [More details in our documentation for the YooKassa SDK](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/readme.md). + +## Examples of using the API SDK + +#### [YooKassa SDK Settings](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md) +* [Authentication](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Аутентификация) +* [Statistics about the environment used](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Статистические-данные-об-используемом-окружении) +* [Getting information about the store](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Получение-информации-о-магазине) +* [Working with Webhook](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Работа-с-Webhook) +* [Notifications](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Входящие-уведомления) + +#### [Working with payments](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md) +* [Request to create a payment](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-создание-платежа) +* [Request to create a payment via the builder](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-создание-платежа-через-билдер) +* [Request for partial payment confirmation](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-частичное-подтверждение-платежа) +* [Request to cancel an incomplete payment](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-отмену-незавершенного-платежа) +* [Get payment information](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Получить-информацию-о-платеже) +* [Get a list of payments with filtering](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Получить-список-платежей-с-фильтрацией) + +#### [Working with refunds](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md) +* [Request to create a refund](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Запрос-на-создание-возврата) +* [Request to create a refund via the builder](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Запрос-на-создание-возврата-через-билдер) +* [Get refund information](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Получить-информацию-о-возврате) +* [Get a list of returns with filtering](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Получить-список-возвратов-с-фильтрацией) + +#### [Working with receipts](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md) +* [Request to create a receipt](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Запрос-на-создание-чека) +* [Request to create a receipt via the builder](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Запрос-на-создание-чека-через-билдер) +* [Get information about the receipt](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Получить-информацию-о-чеке) +* [Get a list of receipts with filtering](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Получить-список-чеков-с-фильтрацией) diff --git a/README.md b/README.md index 0cbbdafa..4e3221fe 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ Russian | [English](https://github.com/yoomoney/yookassa-sdk-php/blob/master/REA Клиент для работы с платежами по [API ЮKassa](https://yookassa.ru/developers/api) Подходит тем, у кого способ подключения к ЮKassa называется API. +[Документация по данному SDK](docs/readme.md). + ## Требования PHP 5.3.2 (и выше) с расширением libcurl @@ -60,4 +62,37 @@ use YooKassa\Client; $client = new Client(); $client->setAuth('shopId', 'secretKey'); ``` -3. Вызовите нужный метод API. [Подробнее в документации к API ЮKassa](https://yookassa.ru/developers/api#create_payment) +3. Вызовите нужный метод API. + + [Подробнее в документации к API ЮKassa](https://yookassa.ru/developers/api#create_payment). + + [Подробнее в документации к SDK ЮKassa](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/readme.md). + +## Примеры использования SDK + +#### [Настройки SDK API ЮKassa](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md) +* [Аутентификация](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Аутентификация) +* [Статистические данные об используемом окружении](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Статистические-данные-об-используемом-окружении) +* [Получение информации о магазине](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Получение-информации-о-магазине) +* [Работа с Webhook](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Работа-с-Webhook) +* [Входящие уведомления](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/01-configuration.md#Входящие-уведомления) + +#### [Работа с платежами](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md) +* [Запрос на создание платежа](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-создание-платежа) +* [Запрос на создание платежа через билдер](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-создание-платежа-через-билдер) +* [Запрос на частичное подтверждение платежа](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-частичное-подтверждение-платежа) +* [Запрос на отмену незавершенного платежа](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Запрос-на-отмену-незавершенного-платежа) +* [Получить информацию о платеже](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Получить-информацию-о-платеже) +* [Получить список платежей с фильтрацией](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/02-payments.md#Получить-список-платежей-с-фильтрацией) + +#### [Работа с возвратами](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md) +* [Запрос на создание возврата](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Запрос-на-создание-возврата) +* [Запрос на создание возврата через билдер](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Запрос-на-создание-возврата-через-билдер) +* [Получить информацию о возврате](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Получить-информацию-о-возврате) +* [Получить список возвратов с фильтрацией](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/03-refunds.md#Получить-список-возвратов-с-фильтрацией) + +#### [Работа с чеками](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md) +* [Запрос на создание чека](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Запрос-на-создание-чека) +* [Запрос на создание чека через билдер](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Запрос-на-создание-чека-через-билдер) +* [Получить информацию о чеке](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Получить-информацию-о-чеке) +* [Получить список чеков с фильтрацией](https://github.com/yoomoney/yookassa-sdk-php/blob/master/docs/examples/04-receipts.md#Получить-список-чеков-с-фильтрацией) diff --git a/composer.json b/composer.json index 69e08e8b..80e5f192 100644 --- a/composer.json +++ b/composer.json @@ -11,7 +11,7 @@ "email": "cms@yoomoney.ru" } ], - "version": "2.0.7", + "version": "2.1.0", "require": { "php": ">=5.3.0", "ext-curl": "*", diff --git a/docs/classes/JsonSerializable.md b/docs/classes/JsonSerializable.md new file mode 100644 index 00000000..17f91435 --- /dev/null +++ b/docs/classes/JsonSerializable.md @@ -0,0 +1,53 @@ +# [YooKassa API SDK](../home.md) + +# Interface: JsonSerializable +### Namespace: [\](../namespaces/default.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [jsonSerialize()](../classes/JsonSerializable.md#method_jsonSerialize) | | | + +--- +### Details +* File: [lib/Common/legacy_json_serializable.php](../../lib/Common/legacy_json_serializable.php) +* Package: \Default +--- +## Methods + +#### public jsonSerialize() : mixed + +```php +public jsonSerialize() : mixed +``` + +**Details:** +* Inherited From: [\JsonSerializable](../classes/JsonSerializable.md) + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-ApiClientInterface.md b/docs/classes/YooKassa-Client-ApiClientInterface.md new file mode 100644 index 00000000..a5304760 --- /dev/null +++ b/docs/classes/YooKassa-Client-ApiClientInterface.md @@ -0,0 +1,197 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ApiClientInterface +### Namespace: [\YooKassa\Client](../namespaces/yookassa-client.md) +--- +**Summary:** + +Interface ApiClientInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [call()](../classes/YooKassa-Client-ApiClientInterface.md#method_call) | | Создает CURL запрос, получает и возвращает обработанный ответ | +| public | [getUserAgent()](../classes/YooKassa-Client-ApiClientInterface.md#method_getUserAgent) | | Возвращает UserAgent | +| public | [setBearerToken()](../classes/YooKassa-Client-ApiClientInterface.md#method_setBearerToken) | | Устанавливает OAuth-токен магазина | +| public | [setConfig()](../classes/YooKassa-Client-ApiClientInterface.md#method_setConfig) | | Устанавливает настройки | +| public | [setLogger()](../classes/YooKassa-Client-ApiClientInterface.md#method_setLogger) | | Устанавливает объект для логирования | +| public | [setShopId()](../classes/YooKassa-Client-ApiClientInterface.md#method_setShopId) | | Устанавливает shopId магазина | +| public | [setShopPassword()](../classes/YooKassa-Client-ApiClientInterface.md#method_setShopPassword) | | Устанавливает секретный ключ магазина | + +--- +### Details +* File: [lib/Client/ApiClientInterface.php](../../lib/Client/ApiClientInterface.php) +* Package: \YooKassa +--- +## Methods + +#### public call() : \YooKassa\Common\ResponseObject + +```php +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](../classes/YooKassa-Client-ApiClientInterface.md) +##### 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 + +```php +public setLogger(\Psr\Log\LoggerInterface|null logger) : mixed +``` + +**Summary** + +Устанавливает объект для логирования + +**Details:** +* Inherited From: [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \Psr\Log\LoggerInterface OR null | logger | Объект для логирования | + +**Returns:** mixed - + + + +#### public getUserAgent() : \YooKassa\Client\UserAgent + +```php +public getUserAgent() : \YooKassa\Client\UserAgent +``` + +**Summary** + +Возвращает UserAgent + +**Details:** +* Inherited From: [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) + +**Returns:** \YooKassa\Client\UserAgent - + + + +#### public setShopId() : mixed + +```php +public setShopId(string|int shopId) : mixed +``` + +**Summary** + +Устанавливает shopId магазина + +**Details:** +* Inherited From: [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR int | shopId | shopId магазина | + +**Returns:** mixed - + + + +#### public setShopPassword() : mixed + +```php +public setShopPassword(string shopPassword) : mixed +``` + +**Summary** + +Устанавливает секретный ключ магазина + +**Details:** +* Inherited From: [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | shopPassword | | + +**Returns:** mixed - + + + +#### public setBearerToken() : mixed + +```php +public setBearerToken(string bearerToken) : mixed +``` + +**Summary** + +Устанавливает OAuth-токен магазина + +**Details:** +* Inherited From: [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | bearerToken | | + +**Returns:** mixed - + + + +#### public setConfig() : mixed + +```php +public setConfig(array config) : mixed +``` + +**Summary** + +Устанавливает настройки + +**Details:** +* Inherited From: [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | config | | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-BaseClient.md b/docs/classes/YooKassa-Client-BaseClient.md new file mode 100644 index 00000000..1c20447e --- /dev/null +++ b/docs/classes/YooKassa-Client-BaseClient.md @@ -0,0 +1,602 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Client\BaseClient +### Namespace: [\YooKassa\Client](../namespaces/yookassa-client.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [ME_PATH](../classes/YooKassa-Client-BaseClient.md#constant_ME_PATH) | | Точка входа для запроса к API по магазину | +| public | [PAYMENTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PAYMENTS_PATH) | | Точка входа для запросов к API по платежам | +| public | [REFUNDS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_REFUNDS_PATH) | | Точка входа для запросов к API по возвратам | +| public | [WEBHOOKS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_WEBHOOKS_PATH) | | Точка входа для запросов к API по вебхукам | +| public | [RECEIPTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_RECEIPTS_PATH) | | Точка входа для запросов к API по чекам | +| public | [IDEMPOTENCY_KEY_HEADER](../classes/YooKassa-Client-BaseClient.md#constant_IDEMPOTENCY_KEY_HEADER) | | Имя HTTP заголовка, используемого для передачи idempotence key | +| public | [DEFAULT_DELAY](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_DELAY) | | Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202 | +| public | [DEFAULT_TRIES_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_TRIES_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 | +| public | [DEFAULT_ATTEMPTS_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_ATTEMPTS_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$apiClient](../classes/YooKassa-Client-BaseClient.md#property_apiClient) | | CURL клиент | +| protected | [$attempts](../classes/YooKassa-Client-BaseClient.md#property_attempts) | | Количество повторных запросов при ответе API статусом 202 | +| protected | [$config](../classes/YooKassa-Client-BaseClient.md#property_config) | | Настройки для CURL клиента | +| protected | [$logger](../classes/YooKassa-Client-BaseClient.md#property_logger) | | Объект для логирования работы SDK | +| protected | [$login](../classes/YooKassa-Client-BaseClient.md#property_login) | | shopId магазина | +| protected | [$password](../classes/YooKassa-Client-BaseClient.md#property_password) | | Секретный ключ магазина | +| protected | [$timeout](../classes/YooKassa-Client-BaseClient.md#property_timeout) | | Время через которое будут осуществляться повторные запросы | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Client-BaseClient.md#method___construct) | | Constructor | +| public | [getApiClient()](../classes/YooKassa-Client-BaseClient.md#method_getApiClient) | | Возвращает CURL клиента для работы с API | +| public | [getConfig()](../classes/YooKassa-Client-BaseClient.md#method_getConfig) | | Возвращает настройки клиента | +| public | [setApiClient()](../classes/YooKassa-Client-BaseClient.md#method_setApiClient) | | Устанавливает CURL клиента для работы с API | +| public | [setAuth()](../classes/YooKassa-Client-BaseClient.md#method_setAuth) | | Устанавливает авторизацию по логин/паролю | +| public | [setAuthToken()](../classes/YooKassa-Client-BaseClient.md#method_setAuthToken) | | Устанавливает авторизацию по Oauth-токену | +| public | [setConfig()](../classes/YooKassa-Client-BaseClient.md#method_setConfig) | | Устанавливает настройки клиента | +| public | [setLogger()](../classes/YooKassa-Client-BaseClient.md#method_setLogger) | | Устанавливает логгер приложения | +| public | [setMaxRequestAttempts()](../classes/YooKassa-Client-BaseClient.md#method_setMaxRequestAttempts) | | Установка значения количества попыток повторных запросов при статусе 202 | +| public | [setRetryTimeout()](../classes/YooKassa-Client-BaseClient.md#method_setRetryTimeout) | | Установка значения задержки между повторными запросами | +| protected | [decodeData()](../classes/YooKassa-Client-BaseClient.md#method_decodeData) | | Декодирует JSON строку в массив данных | +| protected | [delay()](../classes/YooKassa-Client-BaseClient.md#method_delay) | | Задержка между повторными запросами | +| protected | [encodeData()](../classes/YooKassa-Client-BaseClient.md#method_encodeData) | | Кодирует массив данных в JSON строку | +| protected | [execute()](../classes/YooKassa-Client-BaseClient.md#method_execute) | | Выполнение запроса и обработка 202 статуса | +| protected | [handleError()](../classes/YooKassa-Client-BaseClient.md#method_handleError) | | Выбрасывает исключение по коду ошибки | +--- +### Details +* File: [lib/Client/BaseClient.php](../../lib/Client/BaseClient.php) +* Package: Default +* Class Hierarchy: + * \YooKassa\Client\BaseClient +--- +## Constants + +###### ME_PATH +Точка входа для запроса к API по магазину + +```php +ME_PATH = '/me' +``` + + + +###### PAYMENTS_PATH +Точка входа для запросов к API по платежам + +```php +PAYMENTS_PATH = '/payments' +``` + + + +###### REFUNDS_PATH +Точка входа для запросов к API по возвратам + +```php +REFUNDS_PATH = '/refunds' +``` + + + +###### WEBHOOKS_PATH +Точка входа для запросов к API по вебхукам + +```php +WEBHOOKS_PATH = '/webhooks' +``` + + + +###### RECEIPTS_PATH +Точка входа для запросов к API по чекам + +```php +RECEIPTS_PATH = '/receipts' +``` + + + +###### IDEMPOTENCY_KEY_HEADER +Имя HTTP заголовка, используемого для передачи idempotence key + +```php +IDEMPOTENCY_KEY_HEADER = 'Idempotence-Key' +``` + + + +###### DEFAULT_DELAY +Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202 + +```php +DEFAULT_DELAY = 1800 +``` + + + +###### DEFAULT_TRIES_COUNT +Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 + +```php +DEFAULT_TRIES_COUNT = 3 +``` + + + +###### DEFAULT_ATTEMPTS_COUNT +Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 + +```php +DEFAULT_ATTEMPTS_COUNT = 3 +``` + + +--- +## Properties + +#### protected $apiClient : null|\YooKassa\Client\ApiClientInterface +--- +**Summary** + +CURL клиент + +**Type:** ApiClientInterface + +**Details:** + + + +#### protected $attempts : int +--- +**Summary** + +Количество повторных запросов при ответе API статусом 202 + +***Description*** + +Значение по умолчанию 3 + +**Type:** int + +**Details:** + + + +#### protected $config : array +--- +**Summary** + +Настройки для CURL клиента + +**Type:** array + +**Details:** + + + +#### protected $logger : \Psr\Log\LoggerInterface|null +--- +**Summary** + +Объект для логирования работы SDK + +**Type:** LoggerInterface|null + +**Details:** + + + +#### protected $login : string|int +--- +**Summary** + +shopId магазина + +**Type:** string|int + +**Details:** + + + +#### protected $password : string +--- +**Summary** + +Секретный ключ магазина + +**Type:** string + +**Details:** + + + +#### protected $timeout : int +--- +**Summary** + +Время через которое будут осуществляться повторные запросы + +***Description*** + +Значение по умолчанию - 1800 миллисекунд. + +**Type:** int +значение в миллисекундах +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(\YooKassa\Client\ApiClientInterface|null apiClient = null, \YooKassa\Helpers\Config\ConfigurationLoaderInterface|null configLoader = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Client\ApiClientInterface OR null | apiClient | | +| \YooKassa\Helpers\Config\ConfigurationLoaderInterface OR null | configLoader | | + +**Returns:** mixed - + + + +#### public getApiClient() : \YooKassa\Client\ApiClientInterface + +```php +public getApiClient() : \YooKassa\Client\ApiClientInterface +``` + +**Summary** + +Возвращает CURL клиента для работы с API + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +**Returns:** \YooKassa\Client\ApiClientInterface - + + + +#### public getConfig() : array + +```php +public getConfig() : array +``` + +**Summary** + +Возвращает настройки клиента + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +**Returns:** array - + + + +#### public setApiClient() : $this + +```php +public setApiClient(\YooKassa\Client\ApiClientInterface apiClient) : $this +``` + +**Summary** + +Устанавливает CURL клиента для работы с API + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Client\ApiClientInterface | apiClient | | + +**Returns:** $this - + + + +#### public setAuth() : $this + +```php +public setAuth(string login, string password) : $this +``` + +**Summary** + +Устанавливает авторизацию по логин/паролю + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | login | | +| string | password | | + +**Returns:** $this - +##### Examples: +Пример авторизации: + +```php +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +``` + + + +#### public setAuthToken() : $this + +```php +public setAuthToken(string token) : $this +``` + +**Summary** + +Устанавливает авторизацию по Oauth-токену + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | token | | + +**Returns:** $this - +##### Examples: +Пример авторизации: + +```php +$client->setAuthToken('token_XXXXXXX'); + +``` + + + +#### public setConfig() : mixed + +```php +public setConfig(array config) : mixed +``` + +**Summary** + +Устанавливает настройки клиента + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | config | | + +**Returns:** mixed - + + + +#### public setLogger() : mixed + +```php +public setLogger(null|callable|object|\Psr\Log\LoggerInterface value) : mixed +``` + +**Summary** + +Устанавливает логгер приложения + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| null OR callable OR object OR \Psr\Log\LoggerInterface | value | Инстанс логгера | + +**Returns:** mixed - + + + +#### public setMaxRequestAttempts() : $this + +```php +public setMaxRequestAttempts(int attempts) : $this +``` + +**Summary** + +Установка значения количества попыток повторных запросов при статусе 202 + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | attempts | | + +**Returns:** $this - + + + +#### public setRetryTimeout() : $this + +```php +public setRetryTimeout(int timeout) : $this +``` + +**Summary** + +Установка значения задержки между повторными запросами + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | timeout | | + +**Returns:** $this - + + + +#### protected decodeData() : array + +```php +protected decodeData(\YooKassa\Common\ResponseObject response) : array +``` + +**Summary** + +Декодирует JSON строку в массив данных + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\ResponseObject | response | | + +**Returns:** array - + + + +#### protected delay() : mixed + +```php +protected delay(\YooKassa\Common\ResponseObject response) : mixed +``` + +**Summary** + +Задержка между повторными запросами + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\ResponseObject | response | | + +**Returns:** mixed - + + + +#### protected encodeData() : string + +```php +protected encodeData(array serializedData) : string +``` + +**Summary** + +Кодирует массив данных в JSON строку + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | serializedData | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** string - + + + +#### protected execute() : mixed|\YooKassa\Common\ResponseObject + +```php +protected execute(string path, string method, array queryParams, null httpBody = null, array headers = array()) : mixed|\YooKassa\Common\ResponseObject +``` + +**Summary** + +Выполнение запроса и обработка 202 статуса + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | path | | +| string | method | | +| array | queryParams | | +| null | httpBody | | +| array | headers | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ApiConnectionException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | + +**Returns:** mixed|\YooKassa\Common\ResponseObject - + + + +#### protected handleError() : mixed + +```php +protected handleError(\YooKassa\Common\ResponseObject response) : mixed +``` + +**Summary** + +Выбрасывает исключение по коду ошибки + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\ResponseObject | response | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-CurlClient.md b/docs/classes/YooKassa-Client-CurlClient.md new file mode 100644 index 00000000..9edc35d6 --- /dev/null +++ b/docs/classes/YooKassa-Client-CurlClient.md @@ -0,0 +1,483 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Client\CurlClient +### Namespace: [\YooKassa\Client](../namespaces/yookassa-client.md) +--- +**Summary:** + +Класс клиента Curl запросов + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Client-CurlClient.md#method___construct) | | CurlClient constructor. | +| public | [call()](../classes/YooKassa-Client-CurlClient.md#method_call) | | Создает CURL запрос, получает и возвращает обработанный ответ | +| public | [closeCurlConnection()](../classes/YooKassa-Client-CurlClient.md#method_closeCurlConnection) | | Close connection | +| public | [getConfig()](../classes/YooKassa-Client-CurlClient.md#method_getConfig) | | Возвращает настройки | +| public | [getConnectionTimeout()](../classes/YooKassa-Client-CurlClient.md#method_getConnectionTimeout) | | Возвращает значение параметра CURLOPT_CONNECTTIMEOUT | +| public | [getProxy()](../classes/YooKassa-Client-CurlClient.md#method_getProxy) | | Возвращает настройки прокси | +| public | [getTimeout()](../classes/YooKassa-Client-CurlClient.md#method_getTimeout) | | Возвращает значение параметра CURLOPT_TIMEOUT | +| public | [getUserAgent()](../classes/YooKassa-Client-CurlClient.md#method_getUserAgent) | | Возвращает UserAgent | +| public | [sendRequest()](../classes/YooKassa-Client-CurlClient.md#method_sendRequest) | | Выполняет запрос, получает и возвращает обработанный ответ | +| public | [setBearerToken()](../classes/YooKassa-Client-CurlClient.md#method_setBearerToken) | | Устанавливает OAuth-токен магазина | +| public | [setBody()](../classes/YooKassa-Client-CurlClient.md#method_setBody) | | Устанавливает тело запроса | +| public | [setConfig()](../classes/YooKassa-Client-CurlClient.md#method_setConfig) | | Устанавливает настройки | +| public | [setConnectionTimeout()](../classes/YooKassa-Client-CurlClient.md#method_setConnectionTimeout) | | Устанавливает значение параметра CURLOPT_CONNECTTIMEOUT | +| public | [setCurlOption()](../classes/YooKassa-Client-CurlClient.md#method_setCurlOption) | | Устанавливает параметры CURL | +| public | [setKeepAlive()](../classes/YooKassa-Client-CurlClient.md#method_setKeepAlive) | | Устанавливает флаг сохранения соединения | +| public | [setLogger()](../classes/YooKassa-Client-CurlClient.md#method_setLogger) | | Устанавливает объект для логирования | +| public | [setProxy()](../classes/YooKassa-Client-CurlClient.md#method_setProxy) | | Устанавливает настройки прокси | +| public | [setShopId()](../classes/YooKassa-Client-CurlClient.md#method_setShopId) | | Устанавливает shopId магазина | +| public | [setShopPassword()](../classes/YooKassa-Client-CurlClient.md#method_setShopPassword) | | Устанавливает секретный ключ магазина | +| public | [setTimeout()](../classes/YooKassa-Client-CurlClient.md#method_setTimeout) | | Устанавливает значение параметра CURLOPT_TIMEOUT | +--- +### Details +* File: [lib/Client/CurlClient.php](../../lib/Client/CurlClient.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Client\CurlClient +* Implements: + * [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +CurlClient constructor. + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** mixed - + + + +#### public call() : \YooKassa\Common\ResponseObject + +```php +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\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | path | URL запроса | +| string | method | HTTP метод | +| array | queryParams | Массив GET параметров запроса | +| string OR null | 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 - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public closeCurlConnection() : mixed + +```php +public closeCurlConnection() : mixed +``` + +**Summary** + +Close connection + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** mixed - + + + +#### public getConfig() : mixed + +```php +public getConfig() : mixed +``` + +**Summary** + +Возвращает настройки + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** mixed - + + + +#### public getConnectionTimeout() : int + +```php +public getConnectionTimeout() : int +``` + +**Summary** + +Возвращает значение параметра CURLOPT_CONNECTTIMEOUT + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** int - + + + +#### public getProxy() : string + +```php +public getProxy() : string +``` + +**Summary** + +Возвращает настройки прокси + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.14 | | + + +#### public getTimeout() : int + +```php +public getTimeout() : int +``` + +**Summary** + +Возвращает значение параметра CURLOPT_TIMEOUT + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** int - + + + +#### public getUserAgent() : \YooKassa\Client\UserAgent + +```php +public getUserAgent() : \YooKassa\Client\UserAgent +``` + +**Summary** + +Возвращает UserAgent + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) + +**Returns:** \YooKassa\Client\UserAgent - + + + +#### public sendRequest() : array + +```php +public sendRequest() : array +``` + +**Summary** + +Выполняет запрос, получает и возвращает обработанный ответ + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiConnectionException | | + +**Returns:** array - + + + +#### public setBearerToken() : $this + +```php +public setBearerToken(string bearerToken) : $this +``` + +**Summary** + +Устанавливает OAuth-токен магазина + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | bearerToken | OAuth-токен магазина | + +**Returns:** $this - + + + +#### public setBody() : mixed + +```php +public setBody(string method, string httpBody) : mixed +``` + +**Summary** + +Устанавливает тело запроса + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | method | HTTP метод | +| string | httpBody | Тело запроса | + +**Returns:** mixed - + + + +#### public setConfig() : mixed + +```php +public setConfig(array config) : mixed +``` + +**Summary** + +Устанавливает настройки + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | config | Настройки клиента | + +**Returns:** mixed - + + + +#### public setConnectionTimeout() : mixed + +```php +public setConnectionTimeout(int connectionTimeout) : mixed +``` + +**Summary** + +Устанавливает значение параметра CURLOPT_CONNECTTIMEOUT + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | connectionTimeout | Число секунд ожидания при попытке подключения | + +**Returns:** mixed - + + + +#### public setCurlOption() : bool + +```php +public setCurlOption(string optionName, mixed optionValue) : bool +``` + +**Summary** + +Устанавливает параметры CURL + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | optionName | Имя параметра | +| mixed | optionValue | Значение параметра | + +**Returns:** bool - + + + +#### public setKeepAlive() : $this + +```php +public setKeepAlive(bool keepAlive) : $this +``` + +**Summary** + +Устанавливает флаг сохранения соединения + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | keepAlive | Флаг сохранения настроек | + +**Returns:** $this - + + + +#### public setLogger() : mixed + +```php +public setLogger(\Psr\Log\LoggerInterface|null logger) : mixed +``` + +**Summary** + +Устанавливает объект для логирования + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \Psr\Log\LoggerInterface OR null | logger | | + +**Returns:** mixed - + + + +#### public setProxy() : mixed + +```php +public setProxy(string proxy) : mixed +``` + +**Summary** + +Устанавливает настройки прокси + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | proxy | Прокси сервер | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.14 | | + + +#### public setShopId() : $this + +```php +public setShopId(mixed shopId) : $this +``` + +**Summary** + +Устанавливает shopId магазина + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | shopId | shopId магазина | + +**Returns:** $this - + + + +#### public setShopPassword() : $this + +```php +public setShopPassword(mixed shopPassword) : $this +``` + +**Summary** + +Устанавливает секретный ключ магазина + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | shopPassword | Секретный ключ магазина | + +**Returns:** $this - + + + +#### public setTimeout() : mixed + +```php +public setTimeout(int timeout) : mixed +``` + +**Summary** + +Устанавливает значение параметра CURLOPT_TIMEOUT + +**Details:** +* Inherited From: [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | timeout | Максимальное количество секунд для выполнения функций cURL | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client-UserAgent.md b/docs/classes/YooKassa-Client-UserAgent.md new file mode 100644 index 00000000..e60e509f --- /dev/null +++ b/docs/classes/YooKassa-Client-UserAgent.md @@ -0,0 +1,313 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Client\UserAgent +### Namespace: [\YooKassa\Client](../namespaces/yookassa-client.md) +--- +**Summary:** + +Класс для создания заголовка User-Agent в запросах к API + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HEADER](../classes/YooKassa-Client-UserAgent.md#constant_HEADER) | | Имя заголовка для User-Agent | +| public | [VERSION_DELIMITER](../classes/YooKassa-Client-UserAgent.md#constant_VERSION_DELIMITER) | | Разделитель части заголовка и её версии | +| public | [PART_DELIMITER](../classes/YooKassa-Client-UserAgent.md#constant_PART_DELIMITER) | | Разделитель между частями заголовка | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Client-UserAgent.md#method___construct) | | Конструктор UserAgent | +| public | [createVersion()](../classes/YooKassa-Client-UserAgent.md#method_createVersion) | | Создание строки версии компонента | +| public | [getCms()](../classes/YooKassa-Client-UserAgent.md#method_getCms) | | Возвращает версию CMS | +| public | [getFramework()](../classes/YooKassa-Client-UserAgent.md#method_getFramework) | | Возвращает версию фреймворка | +| public | [getHeaderString()](../classes/YooKassa-Client-UserAgent.md#method_getHeaderString) | | Формирует конечную строку из составных частей | +| public | [getModule()](../classes/YooKassa-Client-UserAgent.md#method_getModule) | | Возвращает версию модуля | +| public | [getOs()](../classes/YooKassa-Client-UserAgent.md#method_getOs) | | Возвращает версию операционной системы | +| public | [getPhp()](../classes/YooKassa-Client-UserAgent.md#method_getPhp) | | Возвращает версию PHP | +| public | [getSdk()](../classes/YooKassa-Client-UserAgent.md#method_getSdk) | | Возвращает версию SDK | +| public | [setCms()](../classes/YooKassa-Client-UserAgent.md#method_setCms) | | Устанавливает версию CMS | +| public | [setFramework()](../classes/YooKassa-Client-UserAgent.md#method_setFramework) | | Устанавливает версию фреймворка | +| public | [setModule()](../classes/YooKassa-Client-UserAgent.md#method_setModule) | | Устанавливает версию модуля | +--- +### Details +* File: [lib/Client/UserAgent.php](../../lib/Client/UserAgent.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Client\UserAgent +--- +## Constants + +###### HEADER +Имя заголовка для User-Agent + +```php +HEADER = 'YM-User-Agent' +``` + + + +###### VERSION_DELIMITER +Разделитель части заголовка и её версии + +```php +VERSION_DELIMITER = '/' +``` + + + +###### PART_DELIMITER +Разделитель между частями заголовка + +```php +PART_DELIMITER = ' ' +``` + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор UserAgent + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** mixed - + + + +#### public createVersion() : string + +```php +public createVersion(string name, string version) : string +``` + +**Summary** + +Создание строки версии компонента + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | name | | +| string | version | | + +**Returns:** string - + + + +#### public getCms() : null + +```php +public getCms() : null +``` + +**Summary** + +Возвращает версию CMS + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** null - + + + +#### public getFramework() : string|null + +```php +public getFramework() : string|null +``` + +**Summary** + +Возвращает версию фреймворка + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** string|null - + + + +#### public getHeaderString() : string + +```php +public getHeaderString() : string +``` + +**Summary** + +Формирует конечную строку из составных частей + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** string - + + + +#### public getModule() : string + +```php +public getModule() : string +``` + +**Summary** + +Возвращает версию модуля + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** string - + + + +#### public getOs() : string + +```php +public getOs() : string +``` + +**Summary** + +Возвращает версию операционной системы + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** string - + + + +#### public getPhp() : string + +```php +public getPhp() : string +``` + +**Summary** + +Возвращает версию PHP + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** string - + + + +#### public getSdk() : string + +```php +public getSdk() : string +``` + +**Summary** + +Возвращает версию SDK + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) + +**Returns:** string - + + + +#### public setCms() : mixed + +```php +public setCms(string name, string version) : mixed +``` + +**Summary** + +Устанавливает версию CMS + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | name | | +| string | version | | + +**Returns:** mixed - + + + +#### public setFramework() : mixed + +```php +public setFramework(string name, string version) : mixed +``` + +**Summary** + +Устанавливает версию фреймворка + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | name | | +| string | version | | + +**Returns:** mixed - + + + +#### public setModule() : mixed + +```php +public setModule(string name, string version) : mixed +``` + +**Summary** + +Устанавливает версию модуля + +**Details:** +* Inherited From: [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | name | | +| string | version | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Client.md b/docs/classes/YooKassa-Client.md new file mode 100644 index 00000000..ccccdf96 --- /dev/null +++ b/docs/classes/YooKassa-Client.md @@ -0,0 +1,1703 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Client +### Namespace: [\YooKassa](../namespaces/yookassa.md) +--- +**Summary:** + +Класс клиента API + +--- +### Examples +Создание клиента + +```php +require_once '../vendor/autoload.php'; + +$client = new \YooKassa\Client(); +// по логин/паролю +$client->setAuth('xxxxxx', 'test_XXXXXXX'); +// или по oauth токену +$client->setAuthToken('token_XXXXXXX'); + +``` +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [ME_PATH](../classes/YooKassa-Client-BaseClient.md#constant_ME_PATH) | | Точка входа для запроса к API по магазину | +| public | [PAYMENTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_PAYMENTS_PATH) | | Точка входа для запросов к API по платежам | +| public | [REFUNDS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_REFUNDS_PATH) | | Точка входа для запросов к API по возвратам | +| public | [WEBHOOKS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_WEBHOOKS_PATH) | | Точка входа для запросов к API по вебхукам | +| public | [RECEIPTS_PATH](../classes/YooKassa-Client-BaseClient.md#constant_RECEIPTS_PATH) | | Точка входа для запросов к API по чекам | +| public | [IDEMPOTENCY_KEY_HEADER](../classes/YooKassa-Client-BaseClient.md#constant_IDEMPOTENCY_KEY_HEADER) | | Имя HTTP заголовка, используемого для передачи idempotence key | +| public | [DEFAULT_DELAY](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_DELAY) | | Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202 | +| public | [DEFAULT_TRIES_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_TRIES_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 | +| public | [DEFAULT_ATTEMPTS_COUNT](../classes/YooKassa-Client-BaseClient.md#constant_DEFAULT_ATTEMPTS_COUNT) | | Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 | +| public | [SDK_VERSION](../classes/YooKassa-Client.md#constant_SDK_VERSION) | | Текущая версия библиотеки | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$apiClient](../classes/YooKassa-Client-BaseClient.md#property_apiClient) | | CURL клиент | +| protected | [$attempts](../classes/YooKassa-Client-BaseClient.md#property_attempts) | | Количество повторных запросов при ответе API статусом 202 | +| protected | [$config](../classes/YooKassa-Client-BaseClient.md#property_config) | | Настройки для CURL клиента | +| protected | [$logger](../classes/YooKassa-Client-BaseClient.md#property_logger) | | Объект для логирования работы SDK | +| protected | [$login](../classes/YooKassa-Client-BaseClient.md#property_login) | | shopId магазина | +| protected | [$password](../classes/YooKassa-Client-BaseClient.md#property_password) | | Секретный ключ магазина | +| protected | [$timeout](../classes/YooKassa-Client-BaseClient.md#property_timeout) | | Время через которое будут осуществляться повторные запросы | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Client-BaseClient.md#method___construct) | | Constructor | +| public | [addWebhook()](../classes/YooKassa-Client.md#method_addWebhook) | | Создание Webhook | +| public | [cancelPayment()](../classes/YooKassa-Client.md#method_cancelPayment) | | Отменить незавершенную оплату заказа. | +| public | [capturePayment()](../classes/YooKassa-Client.md#method_capturePayment) | | Подтверждение платежа | +| public | [createPayment()](../classes/YooKassa-Client.md#method_createPayment) | | Создание платежа. | +| public | [createReceipt()](../classes/YooKassa-Client.md#method_createReceipt) | | Отправка чека в облачную кассу | +| public | [createRefund()](../classes/YooKassa-Client.md#method_createRefund) | | Проведение возврата платежа | +| public | [getApiClient()](../classes/YooKassa-Client-BaseClient.md#method_getApiClient) | | Возвращает CURL клиента для работы с API | +| public | [getConfig()](../classes/YooKassa-Client-BaseClient.md#method_getConfig) | | Возвращает настройки клиента | +| public | [getPaymentInfo()](../classes/YooKassa-Client.md#method_getPaymentInfo) | | Получить информацию о платеже | +| public | [getPayments()](../classes/YooKassa-Client.md#method_getPayments) | | Получить список платежей магазина | +| public | [getReceiptInfo()](../classes/YooKassa-Client.md#method_getReceiptInfo) | | Получить информацию о чеке | +| public | [getReceipts()](../classes/YooKassa-Client.md#method_getReceipts) | | Получить список чеков магазина | +| public | [getRefundInfo()](../classes/YooKassa-Client.md#method_getRefundInfo) | | Получить информацию о возврате | +| public | [getRefunds()](../classes/YooKassa-Client.md#method_getRefunds) | | Получить список возвратов платежей | +| public | [getWebhooks()](../classes/YooKassa-Client.md#method_getWebhooks) | | Список созданных Webhook | +| public | [me()](../classes/YooKassa-Client.md#method_me) | | Информация о магазине | +| public | [removeWebhook()](../classes/YooKassa-Client.md#method_removeWebhook) | | Удаление Webhook | +| public | [setApiClient()](../classes/YooKassa-Client-BaseClient.md#method_setApiClient) | | Устанавливает CURL клиента для работы с API | +| public | [setAuth()](../classes/YooKassa-Client-BaseClient.md#method_setAuth) | | Устанавливает авторизацию по логин/паролю | +| public | [setAuthToken()](../classes/YooKassa-Client-BaseClient.md#method_setAuthToken) | | Устанавливает авторизацию по Oauth-токену | +| public | [setConfig()](../classes/YooKassa-Client-BaseClient.md#method_setConfig) | | Устанавливает настройки клиента | +| public | [setLogger()](../classes/YooKassa-Client-BaseClient.md#method_setLogger) | | Устанавливает логгер приложения | +| public | [setMaxRequestAttempts()](../classes/YooKassa-Client-BaseClient.md#method_setMaxRequestAttempts) | | Установка значения количества попыток повторных запросов при статусе 202 | +| public | [setRetryTimeout()](../classes/YooKassa-Client-BaseClient.md#method_setRetryTimeout) | | Установка значения задержки между повторными запросами | +| protected | [decodeData()](../classes/YooKassa-Client-BaseClient.md#method_decodeData) | | Декодирует JSON строку в массив данных | +| protected | [delay()](../classes/YooKassa-Client-BaseClient.md#method_delay) | | Задержка между повторными запросами | +| protected | [encodeData()](../classes/YooKassa-Client-BaseClient.md#method_encodeData) | | Кодирует массив данных в JSON строку | +| protected | [execute()](../classes/YooKassa-Client-BaseClient.md#method_execute) | | Выполнение запроса и обработка 202 статуса | +| protected | [handleError()](../classes/YooKassa-Client-BaseClient.md#method_handleError) | | Выбрасывает исключение по коду ошибки | +--- +### Details +* File: [lib/Client.php](../../lib/Client.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + * \YooKassa\Client +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.1 | | +--- +## Constants + +###### ME_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запроса к API по магазину + +```php +ME_PATH = '/me' +``` + + + +###### PAYMENTS_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по платежам + +```php +PAYMENTS_PATH = '/payments' +``` + + + +###### REFUNDS_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по возвратам + +```php +REFUNDS_PATH = '/refunds' +``` + + + +###### WEBHOOKS_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по вебхукам + +```php +WEBHOOKS_PATH = '/webhooks' +``` + + + +###### RECEIPTS_PATH +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Точка входа для запросов к API по чекам + +```php +RECEIPTS_PATH = '/receipts' +``` + + + +###### IDEMPOTENCY_KEY_HEADER +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Имя HTTP заголовка, используемого для передачи idempotence key + +```php +IDEMPOTENCY_KEY_HEADER = 'Idempotence-Key' +``` + + + +###### DEFAULT_DELAY +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Значение по умолчанию времени ожидания между запросами при отправке повторного запроса в случае получения ответа с HTTP статусом 202 + +```php +DEFAULT_DELAY = 1800 +``` + + + +###### DEFAULT_TRIES_COUNT +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 + +```php +DEFAULT_TRIES_COUNT = 3 +``` + + + +###### DEFAULT_ATTEMPTS_COUNT +Inherited from [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 + +```php +DEFAULT_ATTEMPTS_COUNT = 3 +``` + + + +###### SDK_VERSION +Текущая версия библиотеки + +```php +SDK_VERSION = '2.1.0' +``` + + +--- +## Properties + +#### protected $apiClient : null|\YooKassa\Client\ApiClientInterface +--- +**Summary** + +CURL клиент + +**Type:** ApiClientInterface + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +#### protected $attempts : int +--- +**Summary** + +Количество повторных запросов при ответе API статусом 202 + +***Description*** + +Значение по умолчанию 3 + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +#### protected $config : array +--- +**Summary** + +Настройки для CURL клиента + +**Type:** array + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +#### protected $logger : \Psr\Log\LoggerInterface|null +--- +**Summary** + +Объект для логирования работы SDK + +**Type:** LoggerInterface|null + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +#### protected $login : string|int +--- +**Summary** + +shopId магазина + +**Type:** string|int + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +#### protected $password : string +--- +**Summary** + +Секретный ключ магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +#### protected $timeout : int +--- +**Summary** + +Время через которое будут осуществляться повторные запросы + +***Description*** + +Значение по умолчанию - 1800 миллисекунд. + +**Type:** int +значение в миллисекундах +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(\YooKassa\Client\ApiClientInterface|null apiClient = null, \YooKassa\Helpers\Config\ConfigurationLoaderInterface|null configLoader = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Client\ApiClientInterface OR null | apiClient | | +| \YooKassa\Helpers\Config\ConfigurationLoaderInterface OR null | configLoader | | + +**Returns:** mixed - + + + +#### public addWebhook() : \YooKassa\Model\Webhook\Webhook|null + +```php +public addWebhook( request, null idempotencyKey = null) : \YooKassa\Model\Webhook\Webhook|null +``` + +**Summary** + +Создание Webhook + +**Description** + +Запрос позволяет подписаться на уведомления о событии (например, на переход платежа в статус successed). + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | request | | +| null | idempotencyKey | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Model\Webhook\Webhook|null - +##### Examples: +Создание Webhook: + +```php +// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. +// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. +try { + $webHookUrl = 'https://merchant-site.ru/payment-notification'; + $needWebHookList = array( + \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, + \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED + ); + $currentWebHookList = $client->getWebhooks()->getItems(); + foreach ($needWebHookList as $event) { + $hookIsSet = false; + foreach ($currentWebHookList as $webHook) { + if ($webHook->getEvent() !== $event) { + continue; + } + if ($webHook->getUrl() !== $webHookUrl) { + $client->removeWebhook($webHook->getId()); + } else { + $hookIsSet = true; + } + break; + } + if (!$hookIsSet) { + $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); + } + } + $response = 'SUCCESS'; +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public cancelPayment() : \YooKassa\Request\Payments\Payment\CancelResponse + +```php +public cancelPayment( paymentId, idempotencyKey = null) : \YooKassa\Request\Payments\Payment\CancelResponse +``` + +**Summary** + +Отменить незавершенную оплату заказа. + +**Description** + +Отменяет платеж, находящийся в статусе `waiting_for_capture`. Отмена платежа значит, что вы +не готовы выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем +возвращать деньги на счет плательщика. Для платежей банковскими картами отмена происходит мгновенно. +Для остальных способов оплаты возврат может занимать до нескольких дней. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | paymentId | | +| | idempotencyKey | {@link} | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Payments\Payment\CancelResponse - +##### Examples: +Отменить незавершенную оплату заказа: + +```php +$paymentId = '24e89cb0-000f-5000-9000-1de77fa0d6df'; +try { + $response = $client->cancelPayment($paymentId, uniqid('', true)); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public capturePayment() : \YooKassa\Request\Payments\Payment\CreateCaptureResponse + +```php +public capturePayment(\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface|array captureRequest, paymentId, idempotencyKey = null) : \YooKassa\Request\Payments\Payment\CreateCaptureResponse +``` + +**Summary** + +Подтверждение платежа + +**Description** + +Подтверждает вашу готовность принять платеж. Платеж можно подтвердить, только если он находится +в статусе `waiting_for_capture`. Если платеж подтвержден успешно — значит, оплата прошла, и вы можете выдать +товар или оказать услугу пользователю. На следующий день после подтверждения платеж попадет в реестр, +и ЮKassa переведет деньги на ваш расчетный счет. Если вы не подтверждаете платеж до момента, указанного +в `expire_at`, по умолчанию он отменяется, а деньги возвращаются пользователю. При оплате банковской картой +у вас есть 7 дней на подтверждение платежа. Для остальных способов оплаты платеж необходимо подтвердить +в течение 6 часов. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface OR array | captureRequest | | +| | paymentId | | +| | idempotencyKey | {@link} | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Payments\Payment\CreateCaptureResponse - +##### Examples: +Подтверждение платежа: + +```php +$paymentId = '24e89cb0-000f-5000-9000-1de77fa0d6df'; +try { + $response = $client->capturePayment( + array( + 'amount' => array( + 'value' => '1500.00', + 'currency' => 'RUB', + ), + 'transfers' => array( + array( + 'account_id' => '123', + 'amount' => array( + 'value' => '1000.00', + 'currency' => 'RUB', + ), + ), + array( + 'account_id' => '456', + 'amount' => array( + 'value' => '500.00', + 'currency' => 'RUB', + ), + ), + ), + ), + $paymentId, + uniqid('', true) + ); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public createPayment() : \YooKassa\Request\Payments\CreatePaymentResponse + +```php +public createPayment(\YooKassa\Request\Payments\CreatePaymentRequestInterface|array payment, string|null idempotenceKey = null) : \YooKassa\Request\Payments\CreatePaymentResponse +``` + +**Summary** + +Создание платежа. + +**Description** + +Чтобы принять оплату, необходимо создать объект платежа — `Payment`. Он содержит всю необходимую информацию +для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, он последовательно +переходит из статуса в статус. + +Необходимо указать один из параметров: + + +Если не указан ни один параметр и `confirmation.type = redirect`, то в качестве `confirmation_url` +возвращается ссылка, по которой пользователь сможет самостоятельно выбрать подходящий способ оплаты. +Дополнительные параметры: + + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payments\CreatePaymentRequestInterface OR array | payment | | +| string OR null | idempotenceKey | {@link} | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentResponse - +##### Examples: +Запрос на создание платежа: + +```php +try { + $idempotenceKey = uniqid('', true); + $response = $client->createPayment( + array( + 'amount' => array( + 'value' => '1.00', + 'currency' => 'RUB', + ), + 'confirmation' => array( + 'type' => 'redirect', + 'return_url' => 'https://merchant-site.ru/payment-notification', + ), + 'description' => 'Оплата заказа на сумму 1 руб', + 'metadata' => array( + 'orderNumber' => 1001 + ), + 'capture' => true, + ), + $idempotenceKey + ); + $confirmation = $response->getConfirmation(); + $redirectUrl = $confirmation->getConfirmationUrl(); + // Далее производим редирект на полученный URL +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public createReceipt() : \YooKassa\Request\Receipts\AbstractReceiptResponse|null + +```php +public createReceipt(\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface|array receipt, string|null idempotenceKey = null) : \YooKassa\Request\Receipts\AbstractReceiptResponse|null +``` + +**Summary** + +Отправка чека в облачную кассу + +**Description** + +Создает объект чека — `Receipt`. Возвращает успешно созданный чек по уникальному идентификатору +платежа или возврата. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface OR array | receipt | | +| string OR null | idempotenceKey | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ApiConnectionException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse|null - +##### Examples: +Запрос на создание чека: + +```php +try { + $response = $client->createReceipt( + array( + 'customer' => array( + 'email' => 'johndoe@yoomoney.ru', + 'phone' => '79000000000', + ), + 'type' => 'payment', + 'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df', + 'on_behalf_of' => '123', + 'send' => true, + 'items' => array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ), + ), + 'tax_system_code' => 1, + ), + uniqid('', true) + ); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public createRefund() : \YooKassa\Request\Refunds\CreateRefundResponse + +```php +public createRefund(\YooKassa\Request\Refunds\CreateRefundRequestInterface|array request, null idempotencyKey = null) : \YooKassa\Request\Refunds\CreateRefundResponse +``` + +**Summary** + +Проведение возврата платежа + +**Description** + +Создает объект возврата — `Refund`. Возвращает успешно завершенный платеж по уникальному идентификатору +этого платежа. Создание возврата возможно только для платежей в статусе `succeeded`. Комиссии за проведение +возврата нет. Комиссия, которую ЮKassa берёт за проведение исходного платежа, не возвращается. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Refunds\CreateRefundRequestInterface OR array | request | | +| null | idempotencyKey | {@link} | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Refunds\CreateRefundResponse - +##### Examples: +Запрос на создание возврата: + +```php +try { + $response = $client->createRefund( + array( + 'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df', + 'amount' => array( + 'value' => '1000.00', + 'currency' => 'RUB', + ), + 'sources' => array( + array( + 'account_id' => '456', + 'amount' => array( + 'value' => '1000.00', + 'currency' => 'RUB', + ) + ), + ), + ), + uniqid('', true) + ); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getApiClient() : \YooKassa\Client\ApiClientInterface + +```php +public getApiClient() : \YooKassa\Client\ApiClientInterface +``` + +**Summary** + +Возвращает CURL клиента для работы с API + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +**Returns:** \YooKassa\Client\ApiClientInterface - + + + +#### public getConfig() : array + +```php +public getConfig() : array +``` + +**Summary** + +Возвращает настройки клиента + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) + +**Returns:** array - + + + +#### public getPaymentInfo() : \YooKassa\Model\PaymentInterface + +```php +public getPaymentInfo(string paymentId) : \YooKassa\Model\PaymentInterface +``` + +**Summary** + +Получить информацию о платеже + +**Description** + +Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. +Выдает объект платежа {@link} в актуальном статусе. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | paymentId | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | + +**Returns:** \YooKassa\Model\PaymentInterface - +##### Examples: +Получить информацию о платеже: + +```php +try { + $response = $client->getPaymentInfo('24e89cb0-000f-5000-9000-1de77fa0d6df'); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getPayments() : \YooKassa\Request\Payments\PaymentsResponse + +```php +public getPayments(\YooKassa\Request\Payments\PaymentsRequestInterface|array|null filter = null) : \YooKassa\Request\Payments\PaymentsResponse +``` + +**Summary** + +Получить список платежей магазина + +**Description** + +Запрос позволяет получить список платежей, отфильтрованный по заданным критериям. +В ответ на запрос вернется список платежей с учетом переданных параметров. В списке будет информация о платежах, +созданных за последние 3 года. Список будет отсортирован по времени создания платежей в порядке убывания. +Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе +на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payments\PaymentsRequestInterface OR array OR null | filter | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Payments\PaymentsResponse - +##### Examples: +Получить список платежей магазина с фильтрацией: + +```php +$cursor = null; +$params = array( + 'limit' => 30, + 'status' => \YooKassa\Model\PaymentStatus::CANCELED, + 'payment_method' => \YooKassa\Model\PaymentMethodType::BANK_CARD, + 'created_at_gte' => '2021-01-01T00:00:00.000Z', + 'created_at_lt' => '2021-03-30T23:59:59.999Z', +); +try { + do { + $params['cursor'] = $cursor; + $payments = $client->getPayments($params); + foreach ($payments->getItems() as $payment) { + echo $payment->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' . + $payment->getStatus() . ' - ' . + $payment->getId() . "\n"; + } + } while ($cursor = $payments->getNextCursor()); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getReceiptInfo() : \YooKassa\Request\Receipts\ReceiptResponseInterface + +```php +public getReceiptInfo(string receiptId) : \YooKassa\Request\Receipts\ReceiptResponseInterface +``` + +**Summary** + +Получить информацию о чеке + +**Description** + +Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. +Выдает объект чека {@link} в актуальном статусе. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | receiptId | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | + +**Returns:** \YooKassa\Request\Receipts\ReceiptResponseInterface - +##### Examples: +Получить информацию о чеке: + +```php +try { + $response = $client->getReceiptInfo('ra-27ed1660-0001-0050-7a5e-10f80e0f0f29'); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getReceipts() : \YooKassa\Request\Receipts\ReceiptsResponse + +```php +public getReceipts(\YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface|array|null filter = null) : \YooKassa\Request\Receipts\ReceiptsResponse +``` + +**Summary** + +Получить список чеков магазина + +**Description** + +Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. +Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. +В ответ на запрос вернется список чеков с учетом переданных параметров. В списке будет информация о чеках, +созданных за последние 3 года. Список будет отсортирован по времени создания чеков в порядке убывания. +Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. +В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentInterface OR \YooKassa\Model\RefundInterface OR array OR null | filter | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsResponse - +##### Examples: +Получить список чеков магазина с фильтрацией: + +```php +$cursor = null; +$params = array( + 'limit' => 30, + 'status' => \YooKassa\Model\ReceiptRegistrationStatus::SUCCEEDED, + 'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9', + 'created_at_gte' => '2021-01-01T00:00:00.000Z', + 'created_at_lt' => '2021-03-30T23:59:59.999Z', +); +try { + do { + $params['cursor'] = $cursor; + $receipts = $client->getReceipts($params); + foreach ($receipts->getItems() as $receipt) { + echo $receipt->getStatus() . ' - ' . $receipt->getId() . "\n"; + } + } while ($cursor = $receipts->getNextCursor()); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getRefundInfo() : \YooKassa\Request\Refunds\RefundResponse + +```php +public getRefundInfo( refundId) : \YooKassa\Request\Refunds\RefundResponse +``` + +**Summary** + +Получить информацию о возврате + +**Description** + +Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. +В ответ на запрос придет объект возврата {@link} в актуальном статусе. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | refundId | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Refunds\RefundResponse - +##### Examples: +Получить информацию о возврате: + +```php +try { + $response = $client->getRefundInfo('216749f7-0016-50be-b000-078d43a63ae4'); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getRefunds() : \YooKassa\Request\Refunds\RefundsResponse + +```php +public getRefunds(\YooKassa\Request\Refunds\RefundsRequestInterface|array|null filter = null) : \YooKassa\Request\Refunds\RefundsResponse +``` + +**Summary** + +Получить список возвратов платежей + +**Description** + +Запрос позволяет получить список возвратов, отфильтрованный по заданным критериям. +В ответ на запрос вернется список возвратов с учетом переданных параметров. В списке будет информация о возвратах, +созданных за последние 3 года. Список будет отсортирован по времени создания возвратов в порядке убывания. +Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе +на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Refunds\RefundsRequestInterface OR array OR null | filter | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | +| \Exception | | + +**Returns:** \YooKassa\Request\Refunds\RefundsResponse - +##### Examples: +Получить список возвратов платежей магазина с фильтрацией: + +```php +$cursor = null; +$params = array( + 'limit' => 30, + 'status' => \YooKassa\Model\RefundStatus::SUCCEEDED, + 'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9', + 'created_at_gte' => '2021-01-01T00:00:00.000Z', + 'created_at_lt' => '2021-03-30T23:59:59.999Z', +); +try { + do { + $params['cursor'] = $cursor; + $refunds = $client->getRefunds($params); + foreach ($refunds->getItems() as $refund) { + echo $refund->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' . + $refund->getStatus() . ' - ' . + $refund->getId() . "\n"; + } + } while ($cursor = $refunds->getNextCursor()); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public getWebhooks() : \YooKassa\Request\Webhook\WebhookListResponse|null + +```php +public getWebhooks() : \YooKassa\Request\Webhook\WebhookListResponse|null +``` + +**Summary** + +Список созданных Webhook + +**Description** + +Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | + +**Returns:** \YooKassa\Request\Webhook\WebhookListResponse|null - +##### Examples: +Список созданных Webhook: + +```php +// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. +// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. +try { + $webHookUrl = 'https://merchant-site.ru/payment-notification'; + $needWebHookList = array( + \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, + \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED + ); + $currentWebHookList = $client->getWebhooks()->getItems(); + foreach ($needWebHookList as $event) { + $hookIsSet = false; + foreach ($currentWebHookList as $webHook) { + if ($webHook->getEvent() !== $event) { + continue; + } + if ($webHook->getUrl() !== $webHookUrl) { + $client->removeWebhook($webHook->getId()); + } else { + $hookIsSet = true; + } + break; + } + if (!$hookIsSet) { + $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); + } + } + $response = 'SUCCESS'; +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public me() : array|null + +```php +public me() : array|null +``` + +**Summary** + +Информация о магазине + +**Description** + +Запрос позволяет получить информацию о магазине для переданного OAuth-токена. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | + +**Returns:** array|null - Массив с информацией о магазине +##### Examples: +Информация о магазине: + +```php +try { + $response = $client->me(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public removeWebhook() : \YooKassa\Model\Webhook\Webhook|null + +```php +public removeWebhook( webhookId, null idempotencyKey = null) : \YooKassa\Model\Webhook\Webhook|null +``` + +**Summary** + +Удаление Webhook + +**Description** + +Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. +Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. + +**Details:** +* Inherited From: [\YooKassa\Client](../classes/YooKassa-Client.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | webhookId | | +| null | idempotencyKey | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | +| \Exception | | + +**Returns:** \YooKassa\Model\Webhook\Webhook|null - +##### Examples: +Удаление Webhook: + +```php +// В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. +// А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. +try { + $webHookUrl = 'https://merchant-site.ru/payment-notification'; + $needWebHookList = array( + \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, + \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED + ); + $currentWebHookList = $client->getWebhooks()->getItems(); + foreach ($needWebHookList as $event) { + $hookIsSet = false; + foreach ($currentWebHookList as $webHook) { + if ($webHook->getEvent() !== $event) { + continue; + } + if ($webHook->getUrl() !== $webHookUrl) { + $client->removeWebhook($webHook->getId()); + } else { + $hookIsSet = true; + } + break; + } + if (!$hookIsSet) { + $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); + } + } + $response = 'SUCCESS'; +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` + + + +#### public setApiClient() : $this + +```php +public setApiClient(\YooKassa\Client\ApiClientInterface apiClient) : $this +``` + +**Summary** + +Устанавливает CURL клиента для работы с API + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Client\ApiClientInterface | apiClient | | + +**Returns:** $this - + + + +#### public setAuth() : $this + +```php +public setAuth(string login, string password) : $this +``` + +**Summary** + +Устанавливает авторизацию по логин/паролю + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | login | | +| string | password | | + +**Returns:** $this - +##### Examples: +Пример авторизации: + +```php +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +``` + + + +#### public setAuthToken() : $this + +```php +public setAuthToken(string token) : $this +``` + +**Summary** + +Устанавливает авторизацию по Oauth-токену + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | token | | + +**Returns:** $this - +##### Examples: +Пример авторизации: + +```php +$client->setAuthToken('token_XXXXXXX'); + +``` + + + +#### public setConfig() : mixed + +```php +public setConfig(array config) : mixed +``` + +**Summary** + +Устанавливает настройки клиента + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | config | | + +**Returns:** mixed - + + + +#### public setLogger() : mixed + +```php +public setLogger(null|callable|object|\Psr\Log\LoggerInterface value) : mixed +``` + +**Summary** + +Устанавливает логгер приложения + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| null OR callable OR object OR \Psr\Log\LoggerInterface | value | Инстанс логгера | + +**Returns:** mixed - + + + +#### public setMaxRequestAttempts() : $this + +```php +public setMaxRequestAttempts(int attempts) : $this +``` + +**Summary** + +Установка значения количества попыток повторных запросов при статусе 202 + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | attempts | | + +**Returns:** $this - + + + +#### public setRetryTimeout() : $this + +```php +public setRetryTimeout(int timeout) : $this +``` + +**Summary** + +Установка значения задержки между повторными запросами + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | timeout | | + +**Returns:** $this - + + + +#### protected decodeData() : array + +```php +protected decodeData(\YooKassa\Common\ResponseObject response) : array +``` + +**Summary** + +Декодирует JSON строку в массив данных + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\ResponseObject | response | | + +**Returns:** array - + + + +#### protected delay() : mixed + +```php +protected delay(\YooKassa\Common\ResponseObject response) : mixed +``` + +**Summary** + +Задержка между повторными запросами + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\ResponseObject | response | | + +**Returns:** mixed - + + + +#### protected encodeData() : string + +```php +protected encodeData(array serializedData) : string +``` + +**Summary** + +Кодирует массив данных в JSON строку + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | serializedData | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** string - + + + +#### protected execute() : mixed|\YooKassa\Common\ResponseObject + +```php +protected execute(string path, string method, array queryParams, null httpBody = null, array headers = array()) : mixed|\YooKassa\Common\ResponseObject +``` + +**Summary** + +Выполнение запроса и обработка 202 статуса + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | path | | +| string | method | | +| array | queryParams | | +| null | httpBody | | +| array | headers | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\AuthorizeException | | +| \YooKassa\Common\Exceptions\ApiConnectionException | | +| \YooKassa\Common\Exceptions\ExtensionNotFoundException | | + +**Returns:** mixed|\YooKassa\Common\ResponseObject - + + + +#### protected handleError() : mixed + +```php +protected handleError(\YooKassa\Common\ResponseObject response) : mixed +``` + +**Summary** + +Выбрасывает исключение по коду ошибки + +**Details:** +* Inherited From: [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\ResponseObject | response | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\ApiException | | +| \YooKassa\Common\Exceptions\BadApiRequestException | | +| \YooKassa\Common\Exceptions\ForbiddenException | | +| \YooKassa\Common\Exceptions\InternalServerError | | +| \YooKassa\Common\Exceptions\NotFoundException | | +| \YooKassa\Common\Exceptions\ResponseProcessingException | | +| \YooKassa\Common\Exceptions\TooManyRequestsException | | +| \YooKassa\Common\Exceptions\UnauthorizedException | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractEnum.md b/docs/classes/YooKassa-Common-AbstractEnum.md new file mode 100644 index 00000000..7ed869a7 --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractEnum.md @@ -0,0 +1,117 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Common\AbstractEnum +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Common-AbstractEnum.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Common/AbstractEnum.php](../../lib/Common/AbstractEnum.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Common\AbstractEnum +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractObject.md b/docs/classes/YooKassa-Common-AbstractObject.md new file mode 100644 index 00000000..ebeaf835 --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractObject.md @@ -0,0 +1,324 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Common\AbstractObject +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Базовый класс генерируемых объектов + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Common/AbstractObject.php](../../lib/Common/AbstractObject.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Common\AbstractObject +* Implements: + * [](\ArrayAccess) + * [\JsonSerializable](../classes/JsonSerializable.md) + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractPaymentRequest.md b/docs/classes/YooKassa-Common-AbstractPaymentRequest.md new file mode 100644 index 00000000..e1fc84cb --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractPaymentRequest.md @@ -0,0 +1,650 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\AbstractPaymentRequest +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Класс объекта запроса к API + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | +| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getReceipt) | | Возвращает чек, если он есть | +| public | [getTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. | +| public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | +| public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_validate) | | Валидирует объект запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Common/AbstractPaymentRequest.php](../../lib/Common/AbstractPaymentRequest.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Common\AbstractPaymentRequest +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма + +**Type:** AmountInterface + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface + +**Details:** + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает чек, если он есть + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null если чека нет + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + +**Description** + +Присутствует, если вы используете решение ЮKassa для платформ. +(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет наличие чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если чек есть, false если нет + + + +#### public hasTransfers() : bool + +```php +public hasTransfers() : bool +``` + +**Summary** + +Проверяет наличие данных о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public removeReceipt() : mixed + +```php +public removeReceipt() : mixed +``` + +**Summary** + +Удаляет чек из запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public setReceipt() : mixed + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|null value) : mixed +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : mixed +``` + +**Summary** + +Устанавливает transfers (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Валидирует объект запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если запрос валиден и его можно отправить в API, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md b/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md new file mode 100644 index 00000000..2863de97 --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractPaymentRequestBuilder.md @@ -0,0 +1,441 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Common\AbstractPaymentRequestBuilder +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Базовый класс объекта платежного запроса, передаваемого в методы клиента API + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$amount](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_amount) | | Сумма | +| protected | [$currentObject](../classes/YooKassa-Common-AbstractRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса | +| protected | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_receipt) | | Объект с информацией о чеке | +| protected | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_transfers) | | Массив платежей в пользу разных мерчантов | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [addReceiptItem()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptItem) | | Добавляет в чек товар | +| public | [addReceiptShipping()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptShipping) | | Добавляет в чек доставку товара | +| public | [build()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_build) | | Строит запрос, валидирует его и возвращает, если все прошло нормально | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setAmount) | | Устанавливает сумму | +| public | [setCurrency()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceipt) | | Устанавливает чек | +| public | [setReceiptEmail()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptEmail) | | Устанавливает адрес электронной почты получателя чека | +| public | [setReceiptItems()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptItems) | | Устанавлвиает список товаров для создания чека | +| public | [setReceiptPhone()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptPhone) | | Устанавливает телефон получателя чека | +| public | [setTaxSystemCode()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения. | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTransfers) | | Устанавливает трансферы | +| protected | [initCurrentObject()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_initCurrentObject) | | Инициализирует пустой запрос | +--- +### Details +* File: [lib/Common/AbstractPaymentRequestBuilder.php](../../lib/Common/AbstractPaymentRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Common\AbstractPaymentRequestBuilder +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | +--- +## Properties + +#### protected $amount : \YooKassa\Model\MonetaryAmount +--- +**Summary** + +Сумма + +**Type:** MonetaryAmount + +**Details:** + + + +#### protected $currentObject : \YooKassa\Common\AbstractRequest +--- +**Summary** + +Инстанс собираемого запроса + +**Type:** AbstractRequest + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + + + +#### protected $receipt : \YooKassa\Model\Receipt +--- +**Summary** + +Объект с информацией о чеке + +**Type:** Receipt + +**Details:** + + + +#### protected $transfers : \YooKassa\Model\TransferInterface[] +--- +**Summary** + +Массив платежей в пользу разных мерчантов + +**Type:** TransferInterface[] + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public addReceiptItem() : self + +```php +public addReceiptItem(string title, string price, float quantity, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек товар + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название или описание товара | +| string | price | Цена товара в валюте, заданной в заказе | +| float | quantity | Количество товара | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public addReceiptShipping() : self + +```php +public addReceiptShipping(string title, string price, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек доставку товара + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название доставки в чеке | +| string | price | Стоимость доставки | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public build() : \YooKassa\Common\AbstractRequest + +```php +public build(array options = null) : \YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит запрос, валидирует его и возвращает, если все прошло нормально + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | options | Массив свойств запроса, если нужно их установить перед сборкой | + +**Returns:** \YooKassa\Common\AbstractRequest - Инстанс собранного запроса + + + +#### public setAmount() : self + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|string value) : self +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR string | value | Сумма оплаты | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setCurrency() : self + +```php +public setCurrency(string value) : self +``` + +**Summary** + +Устанавливает валюту в которой будет происходить подтверждение оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Валюта в которой подтверждается оплата | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setReceipt() : self + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|array value) : self +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR array | value | Инстанс чека или ассоциативный массив с данными чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | + +**Returns:** self - + + + +#### public setReceiptEmail() : self + +```php +public setReceiptEmail(string value) : self +``` + +**Summary** + +Устанавливает адрес электронной почты получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Email получателя чека | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptItems() : self + +```php +public setReceiptItems(array value) : self +``` + +**Summary** + +Устанавлвиает список товаров для создания чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | value | Массив товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если хотя бы один из товаров имеет неверную структуру | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptPhone() : self + +```php +public setReceiptPhone(string value) : self +``` + +**Summary** + +Устанавливает телефон получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Телефон получателя чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTaxSystemCode() : self + +```php +public setTaxSystemCode(int value) : self +``` + +**Summary** + +Устанавливает код системы налогообложения. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6. | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTransfers() : self + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : self +``` + +**Summary** + +Устанавливает трансферы + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | Массив трансферов | + +**Returns:** self - Инстанс билдера запросов + + + +#### protected initCurrentObject() : self + +```php +protected initCurrentObject() : self +``` + +**Summary** + +Инициализирует пустой запрос + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + +**Returns:** self - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractRefundRequest.md b/docs/classes/YooKassa-Common-AbstractRefundRequest.md new file mode 100644 index 00000000..a43ac3a0 --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractRefundRequest.md @@ -0,0 +1,540 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\AbstractRefundRequest +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Класс объекта запроса к API + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Common-AbstractRefundRequest.md#property_amount) | | Сумма возврата | +| public | [$paymentId](../classes/YooKassa-Common-AbstractRefundRequest.md#property_paymentId) | | Идентификатор платежа для которого создаётся возврат | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_getAmount) | | Возвращает сумму возврата | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_getPaymentId) | | Возвращает идентификатор платежа для которого создаётся возврат средств | +| public | [hasAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_hasAmount) | | Проверяет была ли установлена сумма возврата | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setAmount) | | Устанавливает сумму | +| public | [setPaymentId()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа для которого создаётся возврат | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Common-AbstractRefundRequest.md#method_validate) | | Валидирует объект запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Common/AbstractRefundRequest.php](../../lib/Common/AbstractRefundRequest.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Common\AbstractRefundRequest +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 2.1.0 | | +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа для которого создаётся возврат + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа для которого создаётся возврат средств + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) + +**Returns:** string - Идентификатор платежа для которого создаётся возврат + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма возврата + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) + +**Returns:** bool - True если сумма возврата была установлена, false если нет + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : self + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|string value) : self +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR string | value | Сумма возврата | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа для которого создаётся возврат + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение идентификатора платежа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение является строкой, но не является валидным значением идентификатора платежа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передано значение не валидного типа | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Валидирует объект запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) + +**Returns:** bool - True если запрос валиден и его можно отправить в API, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractRequest.md b/docs/classes/YooKassa-Common-AbstractRequest.md new file mode 100644 index 00000000..20bf81a3 --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractRequest.md @@ -0,0 +1,398 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Common\AbstractRequest +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Базовый класс объекта запроса, передаваемого в методы клиента API + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Common-AbstractRequest.md#method_validate) | | Валидирует текущий запрос, проверяет все ли нужные свойства установлены | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Common/AbstractRequest.php](../../lib/Common/AbstractRequest.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Common\AbstractRequest + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +Abstract public validate() : bool +``` + +**Summary** + +Валидирует текущий запрос, проверяет все ли нужные свойства установлены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** bool - True если запрос валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-AbstractRequestBuilder.md b/docs/classes/YooKassa-Common-AbstractRequestBuilder.md new file mode 100644 index 00000000..31c39fb2 --- /dev/null +++ b/docs/classes/YooKassa-Common-AbstractRequestBuilder.md @@ -0,0 +1,153 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Common\AbstractRequestBuilder +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Базовый класс билдера запросов + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$currentObject](../classes/YooKassa-Common-AbstractRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [build()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_build) | | Строит запрос, валидирует его и возвращает, если все прошло нормально | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| protected | [initCurrentObject()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_initCurrentObject) | | Инициализирует пустой запрос | +--- +### Details +* File: [lib/Common/AbstractRequestBuilder.php](../../lib/Common/AbstractRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Common\AbstractRequestBuilder +--- +## Properties + +#### protected $currentObject : \YooKassa\Common\AbstractRequest +--- +**Summary** + +Инстанс собираемого запроса + +**Type:** AbstractRequest + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public build() : \YooKassa\Common\AbstractRequest + +```php +public build(array options = null) : \YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит запрос, валидирует его и возвращает, если все прошло нормально + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | options | Массив свойств запроса, если нужно их установить перед сборкой | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если при валидации запроса произошла ошибка | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequest - Инстанс собранного запроса + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### protected initCurrentObject() : \YooKassa\Common\AbstractRequest + +```php +Abstract protected initCurrentObject() : \YooKassa\Common\AbstractRequest +``` + +**Summary** + +Инициализирует пустой запрос + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** \YooKassa\Common\AbstractRequest - Инстанс запроса который будем собирать + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md b/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md new file mode 100644 index 00000000..db1e75fb --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-ApiConnectionException.md @@ -0,0 +1,121 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\ApiConnectionException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-ApiException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/ApiConnectionException.php](../../lib/Common/Exceptions/ApiConnectionException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\ApiConnectionException +--- +## Properties + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = "", int code, string[] responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | Error message | +| int | code | HTTP status code | +| string[] | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ApiException.md b/docs/classes/YooKassa-Common-Exceptions-ApiException.md new file mode 100644 index 00000000..1d04865a --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-ApiException.md @@ -0,0 +1,118 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\ApiException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-ApiException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/ApiException.php](../../lib/Common/Exceptions/ApiException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * \YooKassa\Common\Exceptions\ApiException +--- +## Properties + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = "", int code, string[] responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | Error message | +| int | code | HTTP status code | +| string[] | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md b/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md new file mode 100644 index 00000000..3e9ae3f2 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-AuthorizeException.md @@ -0,0 +1,121 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\AuthorizeException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-ApiException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/AuthorizeException.php](../../lib/Common/Exceptions/AuthorizeException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\AuthorizeException +--- +## Properties + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = "", int code, string[] responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | Error message | +| int | code | HTTP status code | +| string[] | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md b/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md new file mode 100644 index 00000000..4d30af3c --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-BadApiRequestException.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\BadApiRequestException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-BadApiRequestException.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-BadApiRequestException.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-BadApiRequestException.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-BadApiRequestException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/BadApiRequestException.php](../../lib/Common/Exceptions/BadApiRequestException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\BadApiRequestException +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 400 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\BadApiRequestException](../classes/YooKassa-Common-Exceptions-BadApiRequestException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md b/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md new file mode 100644 index 00000000..fbf32f02 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md @@ -0,0 +1,80 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\EmptyPropertyValueException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md#method___construct) | | InvalidValueException constructor. | +| public | [getProperty()](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md#method_getProperty) | | | +--- +### Details +* File: [lib/Common/Exceptions/EmptyPropertyValueException.php](../../lib/Common/Exceptions/EmptyPropertyValueException.php) +* Package: Default +* Class Hierarchy: + * [\InvalidArgumentException](\InvalidArgumentException) + * [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + * \YooKassa\Common\Exceptions\EmptyPropertyValueException + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = "", int code, string property = "") : mixed +``` + +**Summary** + +InvalidValueException constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| int | code | | +| string | property | | + +**Returns:** mixed - + + + +#### public getProperty() : string + +```php +public getProperty() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + +**Returns:** string - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md b/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md new file mode 100644 index 00000000..7d894b02 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md @@ -0,0 +1,64 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\ExtensionNotFoundException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md#method___construct) | | Constructor | +--- +### Details +* File: [lib/Common/Exceptions/ExtensionNotFoundException.php](../../lib/Common/Exceptions/ExtensionNotFoundException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * \YooKassa\Common\Exceptions\ExtensionNotFoundException + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string name, int code) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ExtensionNotFoundException](../classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | name | extension name | +| int | code | error code | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md b/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md new file mode 100644 index 00000000..e6554969 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-ForbiddenException.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\ForbiddenException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-ForbiddenException.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-ForbiddenException.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-ForbiddenException.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-ForbiddenException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/ForbiddenException.php](../../lib/Common/Exceptions/ForbiddenException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\ForbiddenException +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 403 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ForbiddenException](../classes/YooKassa-Common-Exceptions-ForbiddenException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md b/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md new file mode 100644 index 00000000..536c8112 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-InternalServerError.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\InternalServerError +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-InternalServerError.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-InternalServerError.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-InternalServerError.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-InternalServerError.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/InternalServerError.php](../../lib/Common/Exceptions/InternalServerError.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\InternalServerError +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 500 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InternalServerError](../classes/YooKassa-Common-Exceptions-InternalServerError.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md new file mode 100644 index 00000000..0f53032f --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyException.md @@ -0,0 +1,79 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\InvalidPropertyException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md#method___construct) | | InvalidValueException constructor. | +| public | [getProperty()](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md#method_getProperty) | | | +--- +### Details +* File: [lib/Common/Exceptions/InvalidPropertyException.php](../../lib/Common/Exceptions/InvalidPropertyException.php) +* Package: Default +* Class Hierarchy: + * [\InvalidArgumentException](\InvalidArgumentException) + * \YooKassa\Common\Exceptions\InvalidPropertyException + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = "", int code, string property = "") : mixed +``` + +**Summary** + +InvalidValueException constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| int | code | | +| string | property | | + +**Returns:** mixed - + + + +#### public getProperty() : string + +```php +public getProperty() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + +**Returns:** string - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md new file mode 100644 index 00000000..9c6f343e --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md @@ -0,0 +1,95 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\InvalidPropertyValueException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md#method___construct) | | InvalidPropertyValueTypeException constructor. | +| public | [getProperty()](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md#method_getProperty) | | | +| public | [getValue()](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md#method_getValue) | | | +--- +### Details +* File: [lib/Common/Exceptions/InvalidPropertyValueException.php](../../lib/Common/Exceptions/InvalidPropertyValueException.php) +* Package: Default +* Class Hierarchy: + * [\InvalidArgumentException](\InvalidArgumentException) + * [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + * \YooKassa\Common\Exceptions\InvalidPropertyValueException + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = '', int code, string property = '', mixed value = null) : mixed +``` + +**Summary** + +InvalidPropertyValueTypeException constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyValueException](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| int | code | | +| string | property | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public getProperty() : string + +```php +public getProperty() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + +**Returns:** string - + + + +#### public getValue() : mixed + +```php +public getValue() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyValueException](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md) + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md new file mode 100644 index 00000000..ca320f35 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md @@ -0,0 +1,95 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md#method___construct) | | InvalidPropertyValueTypeException constructor. | +| public | [getProperty()](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md#method_getProperty) | | | +| public | [getType()](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md#method_getType) | | | +--- +### Details +* File: [lib/Common/Exceptions/InvalidPropertyValueTypeException.php](../../lib/Common/Exceptions/InvalidPropertyValueTypeException.php) +* Package: Default +* Class Hierarchy: + * [\InvalidArgumentException](\InvalidArgumentException) + * [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + * \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string message = "", int code, string property = "", mixed value = null) : mixed +``` + +**Summary** + +InvalidPropertyValueTypeException constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| int | code | | +| string | property | | +| mixed | value | | + +**Returns:** mixed - + + + +#### public getProperty() : string + +```php +public getProperty() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md) + +**Returns:** string - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md b/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md new file mode 100644 index 00000000..e9327f62 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-InvalidRequestException.md @@ -0,0 +1,79 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\InvalidRequestException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-InvalidRequestException.md#method___construct) | | InvalidRequestException constructor. | +| public | [getRequestObject()](../classes/YooKassa-Common-Exceptions-InvalidRequestException.md#method_getRequestObject) | | | +--- +### Details +* File: [lib/Common/Exceptions/InvalidRequestException.php](../../lib/Common/Exceptions/InvalidRequestException.php) +* Package: Default +* Class Hierarchy: + * [\RuntimeException](\RuntimeException) + * \YooKassa\Common\Exceptions\InvalidRequestException + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(\YooKassa\Common\AbstractRequest|string error, int code, null previous = null) : mixed +``` + +**Summary** + +InvalidRequestException constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidRequestException](../classes/YooKassa-Common-Exceptions-InvalidRequestException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Common\AbstractRequest OR string | error | | +| int | code | | +| null | previous | | + +**Returns:** mixed - + + + +#### public getRequestObject() : \YooKassa\Common\AbstractRequest|null + +```php +public getRequestObject() : \YooKassa\Common\AbstractRequest|null +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\InvalidRequestException](../classes/YooKassa-Common-Exceptions-InvalidRequestException.md) + +**Returns:** \YooKassa\Common\AbstractRequest|null - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-JsonException.md b/docs/classes/YooKassa-Common-Exceptions-JsonException.md new file mode 100644 index 00000000..d6b7b5b6 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-JsonException.md @@ -0,0 +1,75 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\JsonException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$errorLabels](../classes/YooKassa-Common-Exceptions-JsonException.md#property_errorLabels) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-JsonException.md#method___construct) | | | +--- +### Details +* File: [lib/Common/Exceptions/JsonException.php](../../lib/Common/Exceptions/JsonException.php) +* Package: Default +* Class Hierarchy: + * [\UnexpectedValueException](\UnexpectedValueException) + * \YooKassa\Common\Exceptions\JsonException +--- +## Properties + +#### public $errorLabels +--- + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed message = "", mixed code, mixed previous = null) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\JsonException](../classes/YooKassa-Common-Exceptions-JsonException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | message | | +| mixed | code | | +| mixed | previous | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md b/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md new file mode 100644 index 00000000..4255f2c8 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-NotFoundException.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\NotFoundException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-NotFoundException.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-NotFoundException.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-NotFoundException.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-NotFoundException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/NotFoundException.php](../../lib/Common/Exceptions/NotFoundException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\NotFoundException +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 404 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\NotFoundException](../classes/YooKassa-Common-Exceptions-NotFoundException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md b/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md new file mode 100644 index 00000000..9c29997b --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-ResponseProcessingException.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\ResponseProcessingException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-ResponseProcessingException.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-ResponseProcessingException.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-ResponseProcessingException.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-ResponseProcessingException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/ResponseProcessingException.php](../../lib/Common/Exceptions/ResponseProcessingException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\ResponseProcessingException +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 202 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ResponseProcessingException](../classes/YooKassa-Common-Exceptions-ResponseProcessingException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md b/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md new file mode 100644 index 00000000..a708a043 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-TooManyRequestsException.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\TooManyRequestsException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-TooManyRequestsException.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-TooManyRequestsException.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-TooManyRequestsException.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-TooManyRequestsException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/TooManyRequestsException.php](../../lib/Common/Exceptions/TooManyRequestsException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\TooManyRequestsException +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 429 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\TooManyRequestsException](../classes/YooKassa-Common-Exceptions-TooManyRequestsException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md b/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md new file mode 100644 index 00000000..d222d437 --- /dev/null +++ b/docs/classes/YooKassa-Common-Exceptions-UnauthorizedException.md @@ -0,0 +1,146 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\Exceptions\UnauthorizedException +### Namespace: [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +--- +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [HTTP_CODE](../classes/YooKassa-Common-Exceptions-UnauthorizedException.md#constant_HTTP_CODE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$retryAfter](../classes/YooKassa-Common-Exceptions-UnauthorizedException.md#property_retryAfter) | | | +| public | [$type](../classes/YooKassa-Common-Exceptions-UnauthorizedException.md#property_type) | | | +| protected | [$responseBody](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseBody) | | | +| protected | [$responseHeaders](../classes/YooKassa-Common-Exceptions-ApiException.md#property_responseHeaders) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-Exceptions-UnauthorizedException.md#method___construct) | | Constructor | +| public | [getResponseBody()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseBody) | | | +| public | [getResponseHeaders()](../classes/YooKassa-Common-Exceptions-ApiException.md#method_getResponseHeaders) | | | +--- +### Details +* File: [lib/Common/Exceptions/UnauthorizedException.php](../../lib/Common/Exceptions/UnauthorizedException.php) +* Package: Default +* Class Hierarchy: + * [\Exception](\Exception) + * [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + * \YooKassa\Common\Exceptions\UnauthorizedException +--- +## Constants + +###### HTTP_CODE +```php +HTTP_CODE = 401 +``` + + +--- +## Properties + +#### public $retryAfter +--- + +**Details:** + + + +#### public $type +--- + +**Details:** + + + +#### protected $responseBody : mixed +--- +**Type:** mixed + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +#### protected $responseHeaders : string[] +--- +**Type:** string[] + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed responseHeaders = array(), mixed responseBody = null) : mixed +``` + +**Summary** + +Constructor + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\UnauthorizedException](../classes/YooKassa-Common-Exceptions-UnauthorizedException.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | responseHeaders | HTTP header | +| mixed | responseBody | HTTP body | + +**Returns:** mixed - + + + +#### public getResponseBody() : mixed + +```php +public getResponseBody() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** mixed - + + + +#### public getResponseHeaders() : string[] + +```php +public getResponseHeaders() : string[] +``` + +**Details:** +* Inherited From: [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) + +**Returns:** string[] - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-HttpVerb.md b/docs/classes/YooKassa-Common-HttpVerb.md new file mode 100644 index 00000000..6b59edf0 --- /dev/null +++ b/docs/classes/YooKassa-Common-HttpVerb.md @@ -0,0 +1,177 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\HttpVerb +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [GET](../classes/YooKassa-Common-HttpVerb.md#constant_GET) | | | +| public | [POST](../classes/YooKassa-Common-HttpVerb.md#constant_POST) | | | +| public | [PATCH](../classes/YooKassa-Common-HttpVerb.md#constant_PATCH) | | | +| public | [HEAD](../classes/YooKassa-Common-HttpVerb.md#constant_HEAD) | | | +| public | [OPTIONS](../classes/YooKassa-Common-HttpVerb.md#constant_OPTIONS) | | | +| public | [PUT](../classes/YooKassa-Common-HttpVerb.md#constant_PUT) | | | +| public | [DELETE](../classes/YooKassa-Common-HttpVerb.md#constant_DELETE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Common-HttpVerb.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Common/HttpVerb.php](../../lib/Common/HttpVerb.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Common\HttpVerb +--- +## Constants + +###### GET +```php +GET = 'GET' +``` + + + +###### POST +```php +POST = 'POST' +``` + + + +###### PATCH +```php +PATCH = 'PATCH' +``` + + + +###### HEAD +```php +HEAD = 'HEAD' +``` + + + +###### OPTIONS +```php +OPTIONS = 'OPTIONS' +``` + + + +###### PUT +```php +PUT = 'PUT' +``` + + + +###### DELETE +```php +DELETE = 'DELETE' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-LoggerWrapper.md b/docs/classes/YooKassa-Common-LoggerWrapper.md new file mode 100644 index 00000000..be9a9f66 --- /dev/null +++ b/docs/classes/YooKassa-Common-LoggerWrapper.md @@ -0,0 +1,291 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\LoggerWrapper +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-LoggerWrapper.md#method___construct) | | LoggerWrapper constructor. | +| public | [alert()](../classes/YooKassa-Common-LoggerWrapper.md#method_alert) | | Action must be taken immediately. | +| public | [critical()](../classes/YooKassa-Common-LoggerWrapper.md#method_critical) | | Critical conditions. | +| public | [debug()](../classes/YooKassa-Common-LoggerWrapper.md#method_debug) | | Detailed debug information. | +| public | [emergency()](../classes/YooKassa-Common-LoggerWrapper.md#method_emergency) | | System is unusable. | +| public | [error()](../classes/YooKassa-Common-LoggerWrapper.md#method_error) | | Runtime errors that do not require immediate action but should typically be logged and monitored. | +| public | [info()](../classes/YooKassa-Common-LoggerWrapper.md#method_info) | | Interesting events. | +| public | [log()](../classes/YooKassa-Common-LoggerWrapper.md#method_log) | | Logs with an arbitrary level. | +| public | [notice()](../classes/YooKassa-Common-LoggerWrapper.md#method_notice) | | Normal but significant events. | +| public | [warning()](../classes/YooKassa-Common-LoggerWrapper.md#method_warning) | | Exceptional occurrences that are not errors. | +--- +### Details +* File: [lib/Common/LoggerWrapper.php](../../lib/Common/LoggerWrapper.php) +* Package: Default +* Class Hierarchy: + * \YooKassa\Common\LoggerWrapper +* Implements: + * [](\Psr\Log\LoggerInterface) + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(object|callable wrapped) : mixed +``` + +**Summary** + +LoggerWrapper constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| object OR callable | wrapped | | + +**Returns:** mixed - + + + +#### public alert() : void + +```php +public alert(string message, array context = array()) : void +``` + +**Summary** + +Action must be taken immediately. + +**Description** + +Example: Entire website down, database unavailable, etc. This should +trigger the SMS alerts and wake you up. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public critical() : void + +```php +public critical(string message, array context = array()) : void +``` + +**Summary** + +Critical conditions. + +**Description** + +Example: Application component unavailable, unexpected exception. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public debug() : void + +```php +public debug(string message, array context = array()) : void +``` + +**Summary** + +Detailed debug information. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public emergency() : void + +```php +public emergency(string message, array context = array()) : void +``` + +**Summary** + +System is unusable. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public error() : void + +```php +public error(string message, array context = array()) : void +``` + +**Summary** + +Runtime errors that do not require immediate action but should typically +be logged and monitored. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public info() : void + +```php +public info(string message, array context = array()) : void +``` + +**Summary** + +Interesting events. + +**Description** + +Example: User logs in, SQL logs. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public log() : void + +```php +public log(mixed level, string message, array context = array()) : void +``` + +**Summary** + +Logs with an arbitrary level. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | level | | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public notice() : void + +```php +public notice(string message, array context = array()) : void +``` + +**Summary** + +Normal but significant events. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +#### public warning() : void + +```php +public warning(string message, array context = array()) : void +``` + +**Summary** + +Exceptional occurrences that are not errors. + +**Description** + +Example: Use of deprecated APIs, poor use of an API, undesirable things +that are not necessarily wrong. + +**Details:** +* Inherited From: [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | message | | +| array | context | | + +**Returns:** void - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Common-ResponseObject.md b/docs/classes/YooKassa-Common-ResponseObject.md new file mode 100644 index 00000000..30ee7c5f --- /dev/null +++ b/docs/classes/YooKassa-Common-ResponseObject.md @@ -0,0 +1,161 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Common\ResponseObject +### Namespace: [\YooKassa\Common](../namespaces/yookassa-common.md) +--- +**Summary:** + +Класс HTTP ответа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$body](../classes/YooKassa-Common-ResponseObject.md#property_body) | | Тело ответа | +| protected | [$code](../classes/YooKassa-Common-ResponseObject.md#property_code) | | HTTP код ответа | +| protected | [$headers](../classes/YooKassa-Common-ResponseObject.md#property_headers) | | Массив заголовков ответа | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-ResponseObject.md#method___construct) | | | +| public | [getBody()](../classes/YooKassa-Common-ResponseObject.md#method_getBody) | | Возвращает тело ответа | +| public | [getCode()](../classes/YooKassa-Common-ResponseObject.md#method_getCode) | | Возвращает HTTP код ответа | +| public | [getHeaders()](../classes/YooKassa-Common-ResponseObject.md#method_getHeaders) | | Возвращает массив заголовков ответа | +--- +### Details +* File: [lib/Common/ResponseObject.php](../../lib/Common/ResponseObject.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Common\ResponseObject +--- +## Properties + +#### protected $body : mixed +--- +**Summary** + +Тело ответа + +**Type:** mixed + +**Details:** + + + +#### protected $code : int|string +--- +**Summary** + +HTTP код ответа + +**Type:** int|string + +**Details:** + + + +#### protected $headers : array +--- +**Summary** + +Массив заголовков ответа + +**Type:** array + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed config = null) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Common\ResponseObject](../classes/YooKassa-Common-ResponseObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | config | | + +**Returns:** mixed - + + + +#### public getBody() : mixed + +```php +public getBody() : mixed +``` + +**Summary** + +Возвращает тело ответа + +**Details:** +* Inherited From: [\YooKassa\Common\ResponseObject](../classes/YooKassa-Common-ResponseObject.md) + +**Returns:** mixed - Тело ответа + + + +#### public getCode() : int|string + +```php +public getCode() : int|string +``` + +**Summary** + +Возвращает HTTP код ответа + +**Details:** +* Inherited From: [\YooKassa\Common\ResponseObject](../classes/YooKassa-Common-ResponseObject.md) + +**Returns:** int|string - HTTP код ответа + + + +#### public getHeaders() : array + +```php +public getHeaders() : array +``` + +**Summary** + +Возвращает массив заголовков ответа + +**Details:** +* Inherited From: [\YooKassa\Common\ResponseObject](../classes/YooKassa-Common-ResponseObject.md) + +**Returns:** array - Массив заголовков ответа + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md new file mode 100644 index 00000000..581700ed --- /dev/null +++ b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoader.md @@ -0,0 +1,74 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\Config\ConfigurationLoader +### Namespace: [\YooKassa\Helpers\Config](../namespaces/yookassa-helpers-config.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getConfig()](../classes/YooKassa-Helpers-Config-ConfigurationLoader.md#method_getConfig) | | | +| public | [load()](../classes/YooKassa-Helpers-Config-ConfigurationLoader.md#method_load) | | | +--- +### Details +* File: [lib/Helpers/Config/ConfigurationLoader.php](../../lib/Helpers/Config/ConfigurationLoader.php) +* Package: Default +* Class Hierarchy: + * \YooKassa\Helpers\Config\ConfigurationLoader +* Implements: + * [\YooKassa\Helpers\Config\ConfigurationLoaderInterface](../classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md) + +--- +## Methods + +#### public getConfig() : mixed + +```php +public getConfig() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Helpers\Config\ConfigurationLoader](../classes/YooKassa-Helpers-Config-ConfigurationLoader.md) + +**Returns:** mixed - + + + +#### public load() : mixed + +```php +public load(mixed filePath = null) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Helpers\Config\ConfigurationLoader](../classes/YooKassa-Helpers-Config-ConfigurationLoader.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | filePath | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md new file mode 100644 index 00000000..0a3b3e90 --- /dev/null +++ b/docs/classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md @@ -0,0 +1,67 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ConfigurationLoaderInterface +### Namespace: [\YooKassa\Helpers\Config](../namespaces/yookassa-helpers-config.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getConfig()](../classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md#method_getConfig) | | | +| public | [load()](../classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md#method_load) | | | + +--- +### Details +* File: [lib/Helpers/Config/ConfigurationLoaderInterface.php](../../lib/Helpers/Config/ConfigurationLoaderInterface.php) +* Package: \Default +--- +## Methods + +#### public getConfig() : mixed + +```php +public getConfig() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Helpers\Config\ConfigurationLoaderInterface](../classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md) + +**Returns:** mixed - + + + +#### public load() : mixed + +```php +public load() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Helpers\Config\ConfigurationLoaderInterface](../classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md) + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-ProductCode.md b/docs/classes/YooKassa-Helpers-ProductCode.md new file mode 100644 index 00000000..26c4f533 --- /dev/null +++ b/docs/classes/YooKassa-Helpers-ProductCode.md @@ -0,0 +1,338 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\ProductCode +### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +--- +**Summary:** + +Класс для формирования тега 1162 на основе кода в формате Data Matrix + +--- +### Examples +Вариант через метод + +```php +$inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh'; +$productCode = new \YooKassa\Helpers\ProductCode($inputDataMatrix); +$receiptItem = new \YooKassa\Model\ReceiptItem(); +$receiptItem->setProductCode($productCode); + +var_dump($receiptItem); + +``` +Вариант через массив + +```php +$inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh'; +$receiptItem = new \YooKassa\Model\ReceiptItem(array( + 'product_code' => (string)(new \YooKassa\Helpers\ProductCode($inputDataMatrix)), +)); + +var_dump($receiptItem); + +``` +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PREFIX_DATA_MATRIX](../classes/YooKassa-Helpers-ProductCode.md#constant_PREFIX_DATA_MATRIX) | | Код типа маркировки DataMatrix | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Helpers-ProductCode.md#method___construct) | | ProductCode constructor. | +| public | [__toString()](../classes/YooKassa-Helpers-ProductCode.md#method___toString) | | Приводит объект к строке | +| public | [calcResult()](../classes/YooKassa-Helpers-ProductCode.md#method_calcResult) | | Формирует тег 1162. | +| public | [getGtin()](../classes/YooKassa-Helpers-ProductCode.md#method_getGtin) | | Возвращает Глобальный номер товарной продукции | +| public | [getPrefix()](../classes/YooKassa-Helpers-ProductCode.md#method_getPrefix) | | Возвращает Код типа маркировки | +| public | [getResult()](../classes/YooKassa-Helpers-ProductCode.md#method_getResult) | | Возвращает Сформированный тег 1162. | +| public | [getSerial()](../classes/YooKassa-Helpers-ProductCode.md#method_getSerial) | | Возвращает Серийный номер товара | +| public | [isUsePrefix()](../classes/YooKassa-Helpers-ProductCode.md#method_isUsePrefix) | | Возвращает флаг использования кода типа маркировки | +| public | [setGtin()](../classes/YooKassa-Helpers-ProductCode.md#method_setGtin) | | Устанавливает Глобальный номер товарной продукции | +| public | [setPrefix()](../classes/YooKassa-Helpers-ProductCode.md#method_setPrefix) | | Устанавливает Код типа маркировки | +| public | [setSerial()](../classes/YooKassa-Helpers-ProductCode.md#method_setSerial) | | Устанавливает Серийный номер товара | +| public | [setUsePrefix()](../classes/YooKassa-Helpers-ProductCode.md#method_setUsePrefix) | | Устанавливает флаг использования кода типа маркировки | +| public | [validate()](../classes/YooKassa-Helpers-ProductCode.md#method_validate) | | Проверяет заполненность необходимых свойств | +--- +### Details +* File: [lib/Helpers/ProductCode.php](../../lib/Helpers/ProductCode.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Helpers\ProductCode +* See Also: + * [](https://github.com/yoomoney/yookassa-sdk-php/blob/master/lib/Helpers/ProductCode.php) +--- +## Constants + +###### PREFIX_DATA_MATRIX +Код типа маркировки DataMatrix + +```php +PREFIX_DATA_MATRIX = '444D' +``` + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string|null codeDataMatrix = null, bool|string usePrefix = false) : mixed +``` + +**Summary** + +ProductCode constructor. + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | codeDataMatrix | Строка, расшифрованная из QR-кода | +| bool OR string | usePrefix | Нужен ли код типа маркировки в результате | + +**Returns:** mixed - + + + +#### public __toString() : string + +```php +public __toString() : string +``` + +**Summary** + +Приводит объект к строке + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** string - + + + +#### public calcResult() : string|null + +```php +public calcResult() : string|null +``` + +**Summary** + +Формирует тег 1162. + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** string|null - Сформированный тег 1162. + + + +#### public getGtin() : string + +```php +public getGtin() : string +``` + +**Summary** + +Возвращает Глобальный номер товарной продукции + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** string - Глобальный номер товарной продукции + + + +#### public getPrefix() : string + +```php +public getPrefix() : string +``` + +**Summary** + +Возвращает Код типа маркировки + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** string - Код типа маркировки + + + +#### public getResult() : string + +```php +public getResult() : string +``` + +**Summary** + +Возвращает Сформированный тег 1162. + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** string - Сформированный тег 1162. + + + +#### public getSerial() : string + +```php +public getSerial() : string +``` + +**Summary** + +Возвращает Серийный номер товара + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** string - Серийный номер товара + + + +#### public isUsePrefix() : bool + +```php +public isUsePrefix() : bool +``` + +**Summary** + +Возвращает флаг использования кода типа маркировки + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** bool - + + + +#### public setGtin() : \YooKassa\Helpers\ProductCode + +```php +public setGtin(string gtin) : \YooKassa\Helpers\ProductCode +``` + +**Summary** + +Устанавливает Глобальный номер товарной продукции + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | gtin | Глобальный номер товарной продукции | + +**Returns:** \YooKassa\Helpers\ProductCode - + + + +#### public setPrefix() : \YooKassa\Helpers\ProductCode + +```php +public setPrefix(string|int prefix) : \YooKassa\Helpers\ProductCode +``` + +**Summary** + +Устанавливает Код типа маркировки + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR int | prefix | Код типа маркировки | + +**Returns:** \YooKassa\Helpers\ProductCode - + + + +#### public setSerial() : \YooKassa\Helpers\ProductCode + +```php +public setSerial(string serial) : \YooKassa\Helpers\ProductCode +``` + +**Summary** + +Устанавливает Серийный номер товара + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | serial | Серийный номер товара | + +**Returns:** \YooKassa\Helpers\ProductCode - + + + +#### public setUsePrefix() : \YooKassa\Helpers\ProductCode + +```php +public setUsePrefix(bool usePrefix) : \YooKassa\Helpers\ProductCode +``` + +**Summary** + +Устанавливает флаг использования кода типа маркировки + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | usePrefix | Флаг использования кода типа маркировки | + +**Returns:** \YooKassa\Helpers\ProductCode - + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет заполненность необходимых свойств + +**Details:** +* Inherited From: [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) + +**Returns:** bool - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-Random.md b/docs/classes/YooKassa-Helpers-Random.md new file mode 100644 index 00000000..1e155d47 --- /dev/null +++ b/docs/classes/YooKassa-Helpers-Random.md @@ -0,0 +1,232 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\Random +### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +--- +**Summary:** + +Класс хэлпера для генерации случайных значений, используется в тестах + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [bool()](../classes/YooKassa-Helpers-Random.md#method_bool) | | Возвращает рандомное буллево значение | +| public | [bytes()](../classes/YooKassa-Helpers-Random.md#method_bytes) | | Возвращает рандомную последовательность байт | +| public | [float()](../classes/YooKassa-Helpers-Random.md#method_float) | | Возвращает рандомное число с плавающей точкой. По умолчанию возвращает значение в промежутке от нуля до едениы. | +| public | [hex()](../classes/YooKassa-Helpers-Random.md#method_hex) | | Возвращает строку, состоящую из символов '0123456789abcdef' | +| public | [int()](../classes/YooKassa-Helpers-Random.md#method_int) | | Возвращает рандомное целое число. По умолчанию возвращает число от нуля до PHP_INT_MAX. | +| public | [str()](../classes/YooKassa-Helpers-Random.md#method_str) | | Возвращает строку из рандомных символов | +| public | [value()](../classes/YooKassa-Helpers-Random.md#method_value) | | Возвращает рандомное значение из переданного массива | +--- +### Details +* File: [lib/Helpers/Random.php](../../lib/Helpers/Random.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Helpers\Random + +--- +## Methods + +#### public bool() : bool + +```php +Static public bool() : bool +``` + +**Summary** + +Возвращает рандомное буллево значение + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** bool - Либо true либо false, одно из двух + + + +#### public bytes() : string + +```php +Static public bytes(int length, bool useBest = true) : string +``` + +**Summary** + +Возвращает рандомную последовательность байт + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | length | Длина возвращаемой строки | +| bool | useBest | Использовать ли функцию random_int если она доступна | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** string - Строка, состоящая из рандомных символов + + + +#### public float() : float + +```php +Static public float(float|null min = null, float|null max = null, bool useBest = true) : float +``` + +**Summary** + +Возвращает рандомное число с плавающей точкой. По умолчанию возвращает значение в промежутке от нуля до едениы. + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float OR null | min | Минимально возможное значение | +| float OR null | max | Максимально возможное значение | +| bool | useBest | Использовать ли функцию random_int если она доступна | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** float - Рандомное число с плавающей точкой + + + +#### public hex() : string + +```php +Static public hex(int length, bool useBest = true) : string +``` + +**Summary** + +Возвращает строку, состоящую из символов '0123456789abcdef' + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | length | Длина возвращаемой строки | +| bool | useBest | Использовать ли функцию random_int если она доступна | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** string - Строка, состоящая из рандомных символов + + + +#### public int() : int + +```php +Static public int(int|null min = null, int|null max = null, bool useBest = true) : int +``` + +**Summary** + +Возвращает рандомное целое число. По умолчанию возвращает число от нуля до PHP_INT_MAX. + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int OR null | min | Минимально возможное значение | +| int OR null | max | Максимально возможное значение | +| bool | useBest | Использовать ли функцию random_int если она доступна | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** int - Рандомное целое число + + + +#### public str() : string + +```php +Static public str(int length, int|null maxLength = null, string|array|null characters = null, bool useBest = true) : string +``` + +**Summary** + +Возвращает строку из рандомных символов + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | length | Длина возвращаемой строки, или минимальная длина, если передан парамтр $maxLength | +| int OR null | maxLength | Если параметр не равен null, возвращает сроку длиной от $length до $maxLength | +| string OR array OR null | characters | Строка или массив используемых в строке символов | +| bool | useBest | Использовать ли функцию random_int если она доступна | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** string - Строка, состоящая из рандомных символов + + + +#### public value() : mixed + +```php +Static public value(array values, bool useBest = true) : mixed +``` + +**Summary** + +Возвращает рандомное значение из переданного массива + +**Details:** +* Inherited From: [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | values | Массив источник данных | +| bool | useBest | Использовать ли функцию random_int если она доступна | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - Случайное значение из переданного массива + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-RawHeadersParser.md b/docs/classes/YooKassa-Helpers-RawHeadersParser.md new file mode 100644 index 00000000..58b63d5d --- /dev/null +++ b/docs/classes/YooKassa-Helpers-RawHeadersParser.md @@ -0,0 +1,58 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\RawHeadersParser +### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [parse()](../classes/YooKassa-Helpers-RawHeadersParser.md#method_parse) | | | +--- +### Details +* File: [lib/Helpers/RawHeadersParser.php](../../lib/Helpers/RawHeadersParser.php) +* Package: Default +* Class Hierarchy: + * \YooKassa\Helpers\RawHeadersParser + +--- +## Methods + +#### public parse() : mixed + +```php +Static public parse(mixed rawHeaders) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Helpers\RawHeadersParser](../classes/YooKassa-Helpers-RawHeadersParser.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | rawHeaders | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-StringObject.md b/docs/classes/YooKassa-Helpers-StringObject.md new file mode 100644 index 00000000..06ba880d --- /dev/null +++ b/docs/classes/YooKassa-Helpers-StringObject.md @@ -0,0 +1,84 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\StringObject +### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +--- +**Summary:** + +Класс объекта, кастящегося в строку, используется только в тестах + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Helpers-StringObject.md#method___construct) | | StringObject constructor. | +| public | [__toString()](../classes/YooKassa-Helpers-StringObject.md#method___toString) | | Возвращает строковое значение текущего объекта | +--- +### Details +* File: [lib/Helpers/StringObject.php](../../lib/Helpers/StringObject.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Helpers\StringObject + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string value) : mixed +``` + +**Summary** + +StringObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Helpers\StringObject](../classes/YooKassa-Helpers-StringObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public __toString() : string + +```php +public __toString() : string +``` + +**Summary** + +Возвращает строковое значение текущего объекта + +**Details:** +* Inherited From: [\YooKassa\Helpers\StringObject](../classes/YooKassa-Helpers-StringObject.md) + +**Returns:** string - Строковое представление объекта + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-TypeCast.md b/docs/classes/YooKassa-Helpers-TypeCast.md new file mode 100644 index 00000000..8817a9c7 --- /dev/null +++ b/docs/classes/YooKassa-Helpers-TypeCast.md @@ -0,0 +1,158 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\TypeCast +### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +--- +**Summary:** + +Класс хэлпер для преобразования типов значений + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [canCastToBoolean()](../classes/YooKassa-Helpers-TypeCast.md#method_canCastToBoolean) | | Проверяет можно ли преобразовать переданное значение в буллево значение | +| public | [canCastToDateTime()](../classes/YooKassa-Helpers-TypeCast.md#method_canCastToDateTime) | | Проверяет, можно ли преобразовать переданное значение в объект даты-времени | +| public | [canCastToEnumString()](../classes/YooKassa-Helpers-TypeCast.md#method_canCastToEnumString) | | Проверяет можно ли преобразовать переданное значение в строку из перечисления | +| public | [canCastToString()](../classes/YooKassa-Helpers-TypeCast.md#method_canCastToString) | | Проверяет может ли переданное значение быть преобразовано в строку | +| public | [castToDateTime()](../classes/YooKassa-Helpers-TypeCast.md#method_castToDateTime) | | Преобразует переданне значение в объект типа \DateTime | +--- +### Details +* File: [lib/Helpers/TypeCast.php](../../lib/Helpers/TypeCast.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Helpers\TypeCast + +--- +## Methods + +#### public canCastToBoolean() : bool + +```php +Static public canCastToBoolean(mixed value) : bool +``` + +**Summary** + +Проверяет можно ли преобразовать переданное значение в буллево значение + +**Details:** +* Inherited From: [\YooKassa\Helpers\TypeCast](../classes/YooKassa-Helpers-TypeCast.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение качтится в bool, false если нет + + + +#### public canCastToDateTime() : bool + +```php +Static public canCastToDateTime(mixed value) : bool +``` + +**Summary** + +Проверяет, можно ли преобразовать переданное значение в объект даты-времени + +**Details:** +* Inherited From: [\YooKassa\Helpers\TypeCast](../classes/YooKassa-Helpers-TypeCast.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Провеяремое значение | + +**Returns:** bool - True если значение можно преобразовать в объект даты, false если нет + + + +#### public canCastToEnumString() : bool + +```php +Static public canCastToEnumString(mixed value) : bool +``` + +**Summary** + +Проверяет можно ли преобразовать переданное значение в строку из перечисления + +**Details:** +* Inherited From: [\YooKassa\Helpers\TypeCast](../classes/YooKassa-Helpers-TypeCast.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение преобразовать в строку можно, false если нет + + + +#### public canCastToString() : bool + +```php +Static public canCastToString(mixed value) : bool +``` + +**Summary** + +Проверяет может ли переданное значение быть преобразовано в строку + +**Details:** +* Inherited From: [\YooKassa\Helpers\TypeCast](../classes/YooKassa-Helpers-TypeCast.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение преобразовать в строку можно, false если нет + + + +#### public castToDateTime() : \DateTime|null + +```php +Static public castToDateTime(string|int|\DateTime value) : \DateTime|null +``` + +**Summary** + +Преобразует переданне значение в объект типа \DateTime + +**Details:** +* Inherited From: [\YooKassa\Helpers\TypeCast](../classes/YooKassa-Helpers-TypeCast.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR int OR \DateTime | value | Преобразуемое значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** \DateTime|null - Объект типа \DateTime или null если при парсинг даты не удался + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Helpers-UUID.md b/docs/classes/YooKassa-Helpers-UUID.md new file mode 100644 index 00000000..ed9c71b2 --- /dev/null +++ b/docs/classes/YooKassa-Helpers-UUID.md @@ -0,0 +1,58 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Helpers\UUID +### Namespace: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [v4()](../classes/YooKassa-Helpers-UUID.md#method_v4) | | | +--- +### Details +* File: [lib/Helpers/UUID.php](../../lib/Helpers/UUID.php) +* Package: Default +* Class Hierarchy: + * \YooKassa\Helpers\UUID + +--- +## Methods + +#### public v4() : string + +```php +Static public v4() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Helpers\UUID](../classes/YooKassa-Helpers-UUID.md) +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** string - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Airline.md b/docs/classes/YooKassa-Model-Airline.md new file mode 100644 index 00000000..31d05232 --- /dev/null +++ b/docs/classes/YooKassa-Model-Airline.md @@ -0,0 +1,650 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Airline +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс описывающий авиабилет + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$booking_reference](../classes/YooKassa-Model-Airline.md#property_booking_reference) | | Номер бронирования. Обязателен на этапе создания платежа | +| public | [$bookingReference](../classes/YooKassa-Model-Airline.md#property_bookingReference) | | Номер бронирования. Обязателен на этапе создания платежа | +| public | [$legs](../classes/YooKassa-Model-Airline.md#property_legs) | | Список маршрутов | +| public | [$passengers](../classes/YooKassa-Model-Airline.md#property_passengers) | | Список пассажиров | +| public | [$ticket_number](../classes/YooKassa-Model-Airline.md#property_ticket_number) | | Уникальный номер билета. Обязателен на этапе подтверждения платежа | +| public | [$ticketNumber](../classes/YooKassa-Model-Airline.md#property_ticketNumber) | | Уникальный номер билета. Обязателен на этапе подтверждения платежа | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addLeg()](../classes/YooKassa-Model-Airline.md#method_addLeg) | | Добавляет объект-контейнер с данными о маршруте | +| public | [addPassenger()](../classes/YooKassa-Model-Airline.md#method_addPassenger) | | Добавляет объект-контейнер с данными пассажиров | +| public | [fromArray()](../classes/YooKassa-Model-Airline.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getBookingReference()](../classes/YooKassa-Model-Airline.md#method_getBookingReference) | | Номер бронирования. Обязателен на этапе создания платежа. | +| public | [getLegs()](../classes/YooKassa-Model-Airline.md#method_getLegs) | | Список объектов-контейнеров с данными о маршруте | +| public | [getPassengers()](../classes/YooKassa-Model-Airline.md#method_getPassengers) | | Список объектов-контейнеров с данными пассажиров | +| public | [getTicketNumber()](../classes/YooKassa-Model-Airline.md#method_getTicketNumber) | | Уникальный номер билета. Обязателен на этапе подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [notEmpty()](../classes/YooKassa-Model-Airline.md#method_notEmpty) | | Првоерка на наличие данных | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setBookingReference()](../classes/YooKassa-Model-Airline.md#method_setBookingReference) | | Устанавливает номер бронирования. Обязателен на этапе создания платежа. | +| public | [setLegs()](../classes/YooKassa-Model-Airline.md#method_setLegs) | | Устанавливает список объектов-контейнеров с данными о маршруте | +| public | [setPassengers()](../classes/YooKassa-Model-Airline.md#method_setPassengers) | | Устанавливает список объектов-контейнеров с данными пассажиров | +| public | [setTicketNumber()](../classes/YooKassa-Model-Airline.md#method_setTicketNumber) | | Устанавливает уникальный номер билета. Обязателен на этапе подтверждения платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Airline.php](../../lib/Model/Airline.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Airline +* Implements: + * [\YooKassa\Model\AirlineInterface](../classes/YooKassa-Model-AirlineInterface.md) +--- +## Properties + +#### public $booking_reference : string +--- +***Description*** + +Номер бронирования. Обязателен на этапе создания платежа + +**Type:** string + +**Details:** + + + +#### public $bookingReference : string +--- +***Description*** + +Номер бронирования. Обязателен на этапе создания платежа + +**Type:** string + +**Details:** + + + +#### public $legs : \YooKassa\Model\Leg[] +--- +***Description*** + +Список маршрутов + +**Type:** Leg[] + +**Details:** + + + +#### public $passengers : \YooKassa\Model\PassengerInterface[] +--- +***Description*** + +Список пассажиров + +**Type:** PassengerInterface[] + +**Details:** + + + +#### public $ticket_number : string +--- +***Description*** + +Уникальный номер билета. Обязателен на этапе подтверждения платежа + +**Type:** string + +**Details:** + + + +#### public $ticketNumber : string +--- +***Description*** + +Уникальный номер билета. Обязателен на этапе подтверждения платежа + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addLeg() : mixed + +```php +public addLeg(array|\YooKassa\Model\LegInterface value) : mixed +``` + +**Summary** + +Добавляет объект-контейнер с данными о маршруте + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \YooKassa\Model\LegInterface | value | Объект-контейнер с данными о маршруте | + +**Returns:** mixed - + + + +#### public addPassenger() : mixed + +```php +public addPassenger(array|\YooKassa\Model\PassengerInterface value) : mixed +``` + +**Summary** + +Добавляет объект-контейнер с данными пассажиров + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \YooKassa\Model\PassengerInterface | value | Объект-контейнер с данными пассажиров | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(mixed sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getBookingReference() : string + +```php +public getBookingReference() : string +``` + +**Summary** + +Номер бронирования. Обязателен на этапе создания платежа. + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getLegs() : \YooKassa\Model\LegInterface[] + +```php +public getLegs() : \YooKassa\Model\LegInterface[] +``` + +**Summary** + +Список объектов-контейнеров с данными о маршруте + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) + +**Returns:** \YooKassa\Model\LegInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getPassengers() : \YooKassa\Model\PassengerInterface[] + +```php +public getPassengers() : \YooKassa\Model\PassengerInterface[] +``` + +**Summary** + +Список объектов-контейнеров с данными пассажиров + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) + +**Returns:** \YooKassa\Model\PassengerInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getTicketNumber() : string + +```php +public getTicketNumber() : string +``` + +**Summary** + +Уникальный номер билета. Обязателен на этапе подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Првоерка на наличие данных + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) + +**Returns:** bool - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setBookingReference() : mixed + +```php +public setBookingReference(string value) : mixed +``` + +**Summary** + +Устанавливает номер бронирования. Обязателен на этапе создания платежа. + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер бронирования | + +**Returns:** mixed - + + + +#### public setLegs() : mixed + +```php +public setLegs(array|\YooKassa\Model\LegInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список объектов-контейнеров с данными о маршруте + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \YooKassa\Model\LegInterface[] | value | Список объектов-контейнеров с данными о маршруте | + +**Returns:** mixed - + + + +#### public setPassengers() : mixed + +```php +public setPassengers(array|\YooKassa\Model\PassengerInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список объектов-контейнеров с данными пассажиров + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \YooKassa\Model\PassengerInterface[] | value | Список объектов-контейнеров с данными пассажиров | + +**Returns:** mixed - + + + +#### public setTicketNumber() : mixed + +```php +public setTicketNumber(string value) : mixed +``` + +**Summary** + +Устанавливает уникальный номер билета. Обязателен на этапе подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Уникальный номер билета | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AirlineInterface.md b/docs/classes/YooKassa-Model-AirlineInterface.md new file mode 100644 index 00000000..cbff8aa3 --- /dev/null +++ b/docs/classes/YooKassa-Model-AirlineInterface.md @@ -0,0 +1,111 @@ +# [YooKassa API SDK](../home.md) + +# Interface: AirlineInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getBookingReference()](../classes/YooKassa-Model-AirlineInterface.md#method_getBookingReference) | | Номер бронирования. Обязателен на этапе создания платежа. | +| public | [getLegs()](../classes/YooKassa-Model-AirlineInterface.md#method_getLegs) | | Список объектов-контейнеров с данными о маршруте | +| public | [getPassengers()](../classes/YooKassa-Model-AirlineInterface.md#method_getPassengers) | | Список объектов-контейнеров с данными пассажиров | +| public | [getTicketNumber()](../classes/YooKassa-Model-AirlineInterface.md#method_getTicketNumber) | | Уникальный номер билета. Обязателен на этапе подтверждения платежа | + +--- +### Details +* File: [lib/Model/AirlineInterface.php](../../lib/Model/AirlineInterface.php) +* Package: \Default +--- +## Methods + +#### public getBookingReference() : string + +```php +public getBookingReference() : string +``` + +**Summary** + +Номер бронирования. Обязателен на этапе создания платежа. + +**Details:** +* Inherited From: [\YooKassa\Model\AirlineInterface](../classes/YooKassa-Model-AirlineInterface.md) + +**Returns:** string - + + + +#### public getTicketNumber() : string + +```php +public getTicketNumber() : string +``` + +**Summary** + +Уникальный номер билета. Обязателен на этапе подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\AirlineInterface](../classes/YooKassa-Model-AirlineInterface.md) + +**Returns:** string - + + + +#### public getPassengers() : \YooKassa\Model\PassengerInterface[] + +```php +public getPassengers() : \YooKassa\Model\PassengerInterface[] +``` + +**Summary** + +Список объектов-контейнеров с данными пассажиров + +**Details:** +* Inherited From: [\YooKassa\Model\AirlineInterface](../classes/YooKassa-Model-AirlineInterface.md) + +**Returns:** \YooKassa\Model\PassengerInterface[] - + + + +#### public getLegs() : \YooKassa\Model\LegInterface[] + +```php +public getLegs() : \YooKassa\Model\LegInterface[] +``` + +**Summary** + +Список объектов-контейнеров с данными о маршруте + +**Details:** +* Inherited From: [\YooKassa\Model\AirlineInterface](../classes/YooKassa-Model-AirlineInterface.md) + +**Returns:** \YooKassa\Model\LegInterface[] - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AmountInterface.md b/docs/classes/YooKassa-Model-AmountInterface.md new file mode 100644 index 00000000..bdba49c1 --- /dev/null +++ b/docs/classes/YooKassa-Model-AmountInterface.md @@ -0,0 +1,147 @@ +# [YooKassa API SDK](../home.md) + +# Interface: AmountInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface AmountInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getCurrency()](../classes/YooKassa-Model-AmountInterface.md#method_getCurrency) | | Возвращает валюту | +| public | [getIntegerValue()](../classes/YooKassa-Model-AmountInterface.md#method_getIntegerValue) | | Возвращает сумму в копейках в виде целого числа | +| public | [getValue()](../classes/YooKassa-Model-AmountInterface.md#method_getValue) | | Возвращает значение суммы | +| public | [setCurrency()](../classes/YooKassa-Model-AmountInterface.md#method_setCurrency) | | Устанавливает код валюты | +| public | [setValue()](../classes/YooKassa-Model-AmountInterface.md#method_setValue) | | Устанавливает значение суммы | + +--- +### Details +* File: [lib/Model/AmountInterface.php](../../lib/Model/AmountInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Сумма | +| property-read | | Код валюты | +--- +## Methods + +#### public getValue() : string + +```php +public getValue() : string +``` + +**Summary** + +Возвращает значение суммы + +**Details:** +* Inherited From: [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) + +**Returns:** string - Сумма + + + +#### public setValue() : mixed + +```php +public setValue(\YooKassa\Model\numeric value) : mixed +``` + +**Summary** + +Устанавливает значение суммы + +**Details:** +* Inherited From: [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\numeric | value | Сумма | + +**Returns:** mixed - + + + +#### public getIntegerValue() : int + +```php +public getIntegerValue() : int +``` + +**Summary** + +Возвращает сумму в копейках в виде целого числа + +**Details:** +* Inherited From: [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) + +**Returns:** int - Сумма в копейках/центах + + + +#### public getCurrency() : string + +```php +public getCurrency() : string +``` + +**Summary** + +Возвращает валюту + +**Details:** +* Inherited From: [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) + +**Returns:** string - Код валюты + + + +#### public setCurrency() : mixed + +```php +public setCurrency(string value) : mixed +``` + +**Summary** + +Устанавливает код валюты + +**Details:** +* Inherited From: [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Код валюты | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AuthorizationDetails.md b/docs/classes/YooKassa-Model-AuthorizationDetails.md new file mode 100644 index 00000000..856b3936 --- /dev/null +++ b/docs/classes/YooKassa-Model-AuthorizationDetails.md @@ -0,0 +1,436 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\AuthorizationDetails +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +AuthorizationDetails - Данные об авторизации платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$authCode](../classes/YooKassa-Model-AuthorizationDetails.md#property_authCode) | | Код авторизации банковской карты | +| public | [$rrn](../classes/YooKassa-Model-AuthorizationDetails.md#property_rrn) | | Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-AuthorizationDetails.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAuthCode()](../classes/YooKassa-Model-AuthorizationDetails.md#method_getAuthCode) | | Возвращает код авторизации банковской карты | +| public | [getRrn()](../classes/YooKassa-Model-AuthorizationDetails.md#method_getRrn) | | Возвращает уникальный идентификатор транзакции | +| public | [jsonSerialize()](../classes/YooKassa-Model-AuthorizationDetails.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAuthCode()](../classes/YooKassa-Model-AuthorizationDetails.md#method_setAuthCode) | | Устанавливает код авторизации банковской карты | +| public | [setRrn()](../classes/YooKassa-Model-AuthorizationDetails.md#method_setRrn) | | Устанавливает уникальный идентификатор транзакции | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/AuthorizationDetails.php](../../lib/Model/AuthorizationDetails.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\AuthorizationDetails +* Implements: + * [\YooKassa\Model\AuthorizationDetailsInterface](../classes/YooKassa-Model-AuthorizationDetailsInterface.md) +--- +## Properties + +#### public $authCode : string +--- +***Description*** + +Код авторизации банковской карты + +**Type:** string + +**Details:** + + + +#### public $rrn +--- +***Description*** + +Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента + + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string|null rrn = null, string|null authCode = null) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | rrn | Уникальный идентификатор транзакции | +| string OR null | authCode | Код авторизации банковской карты | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAuthCode() : string|null + +```php +public getAuthCode() : string|null +``` + +**Summary** + +Возвращает код авторизации банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) + +**Returns:** string|null - Код авторизации банковской карты + + + +#### public getRrn() : string|null + +```php +public getRrn() : string|null +``` + +**Summary** + +Возвращает уникальный идентификатор транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) + +**Returns:** string|null - Уникальный идентификатор транзакции + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) + +**Returns:** array - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAuthCode() : mixed + +```php +public setAuthCode( value) : mixed +``` + +**Summary** + +Устанавливает код авторизации банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public setRrn() : mixed + +```php +public setRrn( value) : mixed +``` + +**Summary** + +Устанавливает уникальный идентификатор транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md b/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md new file mode 100644 index 00000000..ccb9420c --- /dev/null +++ b/docs/classes/YooKassa-Model-AuthorizationDetailsInterface.md @@ -0,0 +1,85 @@ +# [YooKassa API SDK](../home.md) + +# Interface: AuthorizationDetailsInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface AuthorizationDetailsInterface - Данные об авторизации платежа + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAuthCode()](../classes/YooKassa-Model-AuthorizationDetailsInterface.md#method_getAuthCode) | | Возвращает код авторизации банковской карты | +| public | [getRrn()](../classes/YooKassa-Model-AuthorizationDetailsInterface.md#method_getRrn) | | Возвращает Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента | + +--- +### Details +* File: [lib/Model/AuthorizationDetailsInterface.php](../../lib/Model/AuthorizationDetailsInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента | +| property-read | | Код авторизации банковской карты | +--- +## Methods + +#### public getRrn() : string|null + +```php +public getRrn() : string|null +``` + +**Summary** + +Возвращает Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetailsInterface](../classes/YooKassa-Model-AuthorizationDetailsInterface.md) + +**Returns:** string|null - Уникальный идентификатор транзакции + + + +#### public getAuthCode() : string|null + +```php +public getAuthCode() : string|null +``` + +**Summary** + +Возвращает код авторизации банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\AuthorizationDetailsInterface](../classes/YooKassa-Model-AuthorizationDetailsInterface.md) + +**Returns:** string|null - Код авторизации банковской карты + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetails.md b/docs/classes/YooKassa-Model-CancellationDetails.md new file mode 100644 index 00000000..1452460c --- /dev/null +++ b/docs/classes/YooKassa-Model-CancellationDetails.md @@ -0,0 +1,437 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\CancellationDetails +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +CancellationDetails - Комментарий к отмене платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$party](../classes/YooKassa-Model-CancellationDetails.md#property_party) | | Инициатор отмены платежа | +| public | [$reason](../classes/YooKassa-Model-CancellationDetails.md#property_reason) | | Причина отмены платежа | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-CancellationDetails.md#method___construct) | | CancellationDetails constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getParty()](../classes/YooKassa-Model-CancellationDetails.md#method_getParty) | | Возвращает участника процесса платежа, который принял решение об отмене транзакции | +| public | [getReason()](../classes/YooKassa-Model-CancellationDetails.md#method_getReason) | | Возвращает причину отмены платежа | +| public | [jsonSerialize()](../classes/YooKassa-Model-CancellationDetails.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setParty()](../classes/YooKassa-Model-CancellationDetails.md#method_setParty) | | Устанавливает участника процесса платежа, который принял решение об отмене транзакции | +| public | [setReason()](../classes/YooKassa-Model-CancellationDetails.md#method_setReason) | | Устанавливает причину отмены платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/CancellationDetails.php](../../lib/Model/CancellationDetails.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\CancellationDetails +* Implements: + * [\YooKassa\Model\CancellationDetailsInterface](../classes/YooKassa-Model-CancellationDetailsInterface.md) +--- +## Properties + +#### public $party : string +--- +***Description*** + +Инициатор отмены платежа + +**Type:** string + +**Details:** + + + +#### public $reason : string +--- +***Description*** + +Причина отмены платежа + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string|null party = null, string|null reason = null) : mixed +``` + +**Summary** + +CancellationDetails constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | party | Инициатор отмены платежа | +| string OR null | reason | Причина отмены платежа | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getParty() : string + +```php +public getParty() : string +``` + +**Summary** + +Возвращает участника процесса платежа, который принял решение об отмене транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) + +**Returns:** string - Инициатор отмены платежа + + + +#### public getReason() : string + +```php +public getReason() : string +``` + +**Summary** + +Возвращает причину отмены платежа + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) + +**Returns:** string - Причина отмены платежа + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) + +**Returns:** array - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setParty() : mixed + +```php +public setParty( value) : mixed +``` + +**Summary** + +Устанавливает участника процесса платежа, который принял решение об отмене транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public setReason() : mixed + +```php +public setReason( value) : mixed +``` + +**Summary** + +Устанавливает причину отмены платежа + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetailsInterface.md b/docs/classes/YooKassa-Model-CancellationDetailsInterface.md new file mode 100644 index 00000000..d639f8c8 --- /dev/null +++ b/docs/classes/YooKassa-Model-CancellationDetailsInterface.md @@ -0,0 +1,85 @@ +# [YooKassa API SDK](../home.md) + +# Interface: CancellationDetailsInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface CancellationDetailsInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getParty()](../classes/YooKassa-Model-CancellationDetailsInterface.md#method_getParty) | | Возвращает участника процесса платежа, который принял решение об отмене транзакции | +| public | [getReason()](../classes/YooKassa-Model-CancellationDetailsInterface.md#method_getReason) | | Возвращает причину отмены платежа | + +--- +### Details +* File: [lib/Model/CancellationDetailsInterface.php](../../lib/Model/CancellationDetailsInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Участник процесса платежа, который принял решение об отмене транзакции. | +| property-read | | Причина отмены платежа. | +--- +## Methods + +#### public getParty() : string + +```php +public getParty() : string +``` + +**Summary** + +Возвращает участника процесса платежа, который принял решение об отмене транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetailsInterface](../classes/YooKassa-Model-CancellationDetailsInterface.md) + +**Returns:** string - Участник процесса платежа + + + +#### public getReason() : string + +```php +public getReason() : string +``` + +**Summary** + +Возвращает причину отмены платежа + +**Details:** +* Inherited From: [\YooKassa\Model\CancellationDetailsInterface](../classes/YooKassa-Model-CancellationDetailsInterface.md) + +**Returns:** string - Причина отмены платежа + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md b/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md new file mode 100644 index 00000000..fc8da6e3 --- /dev/null +++ b/docs/classes/YooKassa-Model-CancellationDetailsPartyCode.md @@ -0,0 +1,151 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\CancellationDetailsPartyCode +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +CancellationDetailsPartyCode - Возможные инициаторы отмены платежа + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MERCHANT](../classes/YooKassa-Model-CancellationDetailsPartyCode.md#constant_MERCHANT) | | Продавец товаров и услуг | +| public | [YOO_KASSA](../classes/YooKassa-Model-CancellationDetailsPartyCode.md#constant_YOO_KASSA) | | ЮKassa | +| public | [PAYMENT_NETWORK](../classes/YooKassa-Model-CancellationDetailsPartyCode.md#constant_PAYMENT_NETWORK) | | «Внешние» участники платежного процесса (например, эмитент, сторонний платежный сервис) | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-CancellationDetailsPartyCode.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/CancellationDetailsPartyCode.php](../../lib/Model/CancellationDetailsPartyCode.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\CancellationDetailsPartyCode +--- +## Constants + +###### MERCHANT +Продавец товаров и услуг + +```php +MERCHANT = 'merchant' +``` + + + +###### YOO_KASSA +ЮKassa + +```php +YOO_KASSA = 'yoo_kassa' +``` + + + +###### PAYMENT_NETWORK +«Внешние» участники платежного процесса (например, эмитент, сторонний платежный сервис) + +```php +PAYMENT_NETWORK = 'payment_network' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md b/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md new file mode 100644 index 00000000..960ae62b --- /dev/null +++ b/docs/classes/YooKassa-Model-CancellationDetailsReasonCode.md @@ -0,0 +1,273 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\CancellationDetailsReasonCode +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +CancellationDetailsReasonCode - Возможные причины отмены платежа + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [THREE_D_SECURE_FAILED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_THREE_D_SECURE_FAILED) | | | +| public | [CALL_ISSUER](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_CALL_ISSUER) | | | +| public | [CARD_EXPIRED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_CARD_EXPIRED) | | | +| public | [COUNTRY_FORBIDDEN](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_COUNTRY_FORBIDDEN) | | | +| public | [FRAUD_SUSPECTED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_FRAUD_SUSPECTED) | | | +| public | [GENERAL_DECLINE](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_GENERAL_DECLINE) | | | +| public | [IDENTIFICATION_REQUIRED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_IDENTIFICATION_REQUIRED) | | | +| public | [INSUFFICIENT_FUNDS](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_INSUFFICIENT_FUNDS) | | | +| public | [INVALID_CARD_NUMBER](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_INVALID_CARD_NUMBER) | | | +| public | [INVALID_CSC](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_INVALID_CSC) | | | +| public | [ISSUER_UNAVAILABLE](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_ISSUER_UNAVAILABLE) | | | +| public | [PAYMENT_METHOD_LIMIT_EXCEEDED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_PAYMENT_METHOD_LIMIT_EXCEEDED) | | | +| public | [PAYMENT_METHOD_RESTRICTED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_PAYMENT_METHOD_RESTRICTED) | | | +| public | [PERMISSION_REVOKED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_PERMISSION_REVOKED) | | | +| public | [INTERNAL_TIMEOUT](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_INTERNAL_TIMEOUT) | | | +| public | [CANCELED_BY_MERCHANT](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_CANCELED_BY_MERCHANT) | | | +| public | [PAYMENT_EXPIRED](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_PAYMENT_EXPIRED) | | | +| public | [EXPIRED_ON_CONFIRMATION](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_EXPIRED_ON_CONFIRMATION) | | | +| public | [EXPIRED_ON_CAPTURE](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#constant_EXPIRED_ON_CAPTURE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-CancellationDetailsReasonCode.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/CancellationDetailsReasonCode.php](../../lib/Model/CancellationDetailsReasonCode.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\CancellationDetailsReasonCode +--- +## Constants + +###### THREE_D_SECURE_FAILED +```php +THREE_D_SECURE_FAILED = '3d_secure_failed' +``` + + + +###### CALL_ISSUER +```php +CALL_ISSUER = 'call_issuer' +``` + + + +###### CARD_EXPIRED +```php +CARD_EXPIRED = 'card_expired' +``` + + + +###### COUNTRY_FORBIDDEN +```php +COUNTRY_FORBIDDEN = 'country_forbidden' +``` + + + +###### FRAUD_SUSPECTED +```php +FRAUD_SUSPECTED = 'fraud_suspected' +``` + + + +###### GENERAL_DECLINE +```php +GENERAL_DECLINE = 'general_decline' +``` + + + +###### IDENTIFICATION_REQUIRED +```php +IDENTIFICATION_REQUIRED = 'identification_required' +``` + + + +###### INSUFFICIENT_FUNDS +```php +INSUFFICIENT_FUNDS = 'insufficient_funds' +``` + + + +###### INVALID_CARD_NUMBER +```php +INVALID_CARD_NUMBER = 'invalid_card_number' +``` + + + +###### INVALID_CSC +```php +INVALID_CSC = 'invalid_csc' +``` + + + +###### ISSUER_UNAVAILABLE +```php +ISSUER_UNAVAILABLE = 'issuer_unavailable' +``` + + + +###### PAYMENT_METHOD_LIMIT_EXCEEDED +```php +PAYMENT_METHOD_LIMIT_EXCEEDED = 'payment_method_limit_exceeded' +``` + + + +###### PAYMENT_METHOD_RESTRICTED +```php +PAYMENT_METHOD_RESTRICTED = 'payment_method_restricted' +``` + + + +###### PERMISSION_REVOKED +```php +PERMISSION_REVOKED = 'permission_revoked' +``` + + + +###### INTERNAL_TIMEOUT +```php +INTERNAL_TIMEOUT = 'internal_timeout' +``` + + + +###### CANCELED_BY_MERCHANT +```php +CANCELED_BY_MERCHANT = 'canceled_by_merchant' +``` + + + +###### PAYMENT_EXPIRED +```php +PAYMENT_EXPIRED = 'payment_expired' +``` + + + +###### EXPIRED_ON_CONFIRMATION +```php +EXPIRED_ON_CONFIRMATION = 'expired_on_confirmation' +``` + + + +###### EXPIRED_ON_CAPTURE +```php +EXPIRED_ON_CAPTURE = 'expired_on_capture' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md b/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md new file mode 100644 index 00000000..57b74b91 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-AbstractConfirmation.md @@ -0,0 +1,431 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Model\Confirmation\AbstractConfirmation +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Способ подтверждения платежа. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/AbstractConfirmation.php](../../lib/Model/Confirmation/AbstractConfirmation.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Confirmation\AbstractConfirmation +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md new file mode 100644 index 00000000..dc572003 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md @@ -0,0 +1,425 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationCodeVerification +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Сценарий при котором необходимо получить одноразовый код от плательщика для подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationCodeVerification.php](../../lib/Model/Confirmation/ConfirmationCodeVerification.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + * \YooKassa\Model\Confirmation\ConfirmationCodeVerification +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationCodeVerification](../classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationDeepLink.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationDeepLink.md new file mode 100644 index 00000000..248e8a2d --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationDeepLink.md @@ -0,0 +1,425 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationDeepLink +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Сценарий при котором необходимо направить плательщика в приложение партнера + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Confirmation-ConfirmationDeepLink.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationDeepLink.php](../../lib/Model/Confirmation/ConfirmationDeepLink.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + * \YooKassa\Model\Confirmation\ConfirmationDeepLink +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationDeepLink](../classes/YooKassa-Model-Confirmation-ConfirmationDeepLink.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md new file mode 100644 index 00000000..4109b9b6 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md @@ -0,0 +1,470 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationEmbedded +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Способ подтверждения платежа. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmationToken](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md#property_confirmationToken) | | Токен для checkout.js | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md#method_getConfirmationToken) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setConfirmationToken()](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md#method_setConfirmationToken) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationEmbedded.php](../../lib/Model/Confirmation/ConfirmationEmbedded.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + * \YooKassa\Model\Confirmation\ConfirmationEmbedded +--- +## Properties + +#### public $confirmationToken : string +--- +***Description*** + +Токен для checkout.js + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationEmbedded](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() : string + +```php +public getConfirmationToken() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationEmbedded](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md) + +**Returns:** string - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setConfirmationToken() : mixed + +```php +public setConfirmationToken(string confirmationToken) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationEmbedded](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | confirmationToken | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md new file mode 100644 index 00000000..0b98ad80 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationExternal.md @@ -0,0 +1,426 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationExternal +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Сценарий при котором необходимо ожидать пока пользователь самостоятельно подтвердит платеж. Например, +пользователь подтверждает платеж ответом на SMS или в приложении партнера + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Confirmation-ConfirmationExternal.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationExternal.php](../../lib/Model/Confirmation/ConfirmationExternal.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + * \YooKassa\Model\Confirmation\ConfirmationExternal +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationExternal](../classes/YooKassa-Model-Confirmation-ConfirmationExternal.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md new file mode 100644 index 00000000..b9b7fb42 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationFactory.md @@ -0,0 +1,89 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationFactory +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Class ConfirmationFactory + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Model-Confirmation-ConfirmationFactory.md#method_factory) | | Возвращает объект, соответствующий типу подтверждения платежа | +| public | [factoryFromArray()](../classes/YooKassa-Model-Confirmation-ConfirmationFactory.md#method_factoryFromArray) | | Возвращает объект, соответствующий типу подтверждения платежа, из массива данных | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationFactory.php](../../lib/Model/Confirmation/ConfirmationFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Model\Confirmation\ConfirmationFactory + +--- +## Methods + +#### public factory() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public factory(string type) : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает объект, соответствующий типу подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationFactory](../classes/YooKassa-Model-Confirmation-ConfirmationFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип подтверждения платежа | + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - + + + +#### public factoryFromArray() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public factoryFromArray(array data, string|null type = null) : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает объект, соответствующий типу подтверждения платежа, из массива данных + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationFactory](../classes/YooKassa-Model-Confirmation-ConfirmationFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | Массив данных подтверждения платежа | +| string OR null | type | Тип подтверждения платежа | + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md new file mode 100644 index 00000000..35fef8e3 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationQr.md @@ -0,0 +1,483 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationQr +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Способ подтверждения платежа. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmation_data](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md#property_confirmation_data) | | URL для создания QR-кода | +| public | [$confirmationData](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md#property_confirmationData) | | URL для создания QR-кода | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md#method_getConfirmationData) | | | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setConfirmationData()](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md#method_setConfirmationData) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationQr.php](../../lib/Model/Confirmation/ConfirmationQr.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + * \YooKassa\Model\Confirmation\ConfirmationQr +--- +## Properties + +#### public $confirmation_data : string +--- +***Description*** + +URL для создания QR-кода + +**Type:** string + +**Details:** + + + +#### public $confirmationData : string +--- +***Description*** + +URL для создания QR-кода + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationQr](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() : string + +```php +public getConfirmationData() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationQr](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md) + +**Returns:** string - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setConfirmationData() : mixed + +```php +public setConfirmationData(string confirmationData) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationQr](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | confirmationData | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md b/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md new file mode 100644 index 00000000..8602f855 --- /dev/null +++ b/docs/classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md @@ -0,0 +1,591 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Confirmation\ConfirmationRedirect +### Namespace: [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +--- +**Summary:** + +Сценарий, при котором необходимо отправить плательщика на веб-страницу ЮKassa или партнера для +подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$confirmation_url](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#property_confirmation_url) | | URL на который необходимо перенаправить плательщика для подтверждения оплаты. | +| public | [$confirmationUrl](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#property_confirmationUrl) | | URL на который необходимо перенаправить плательщика для подтверждения оплаты. | +| public | [$enforce](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#property_enforce) | | Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы. | +| public | [$return_url](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#property_return_url) | | URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. | +| public | [$returnUrl](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#property_returnUrl) | | URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. | +| public | [$type](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getConfirmationData()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationData) | | | +| public | [getConfirmationToken()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationToken) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getConfirmationUrl) | | | +| public | [getConfirmationUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_getConfirmationUrl) | | | +| public | [getEnforce()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_getEnforce) | | | +| public | [getReturnUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_getReturnUrl) | | | +| public | [getType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_getType) | | Возвращает тип подтверждения платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setConfirmationUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_setConfirmationUrl) | | | +| public | [setEnforce()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_setEnforce) | | | +| public | [setReturnUrl()](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md#method_setReturnUrl) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setType()](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md#method_setType) | | Устанавливает тип подтверждения платежа | +--- +### Details +* File: [lib/Model/Confirmation/ConfirmationRedirect.php](../../lib/Model/Confirmation/ConfirmationRedirect.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + * \YooKassa\Model\Confirmation\ConfirmationRedirect +--- +## Properties + +#### public $confirmation_url : string +--- +***Description*** + +URL на который необходимо перенаправить плательщика для подтверждения оплаты. + +**Type:** string + +**Details:** + + + +#### public $confirmationUrl : string +--- +***Description*** + +URL на который необходимо перенаправить плательщика для подтверждения оплаты. + +**Type:** string + +**Details:** + + + +#### public $enforce : bool +--- +***Description*** + +Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для +оплаты банковскими картами. По умолчанию определяется политикой платежной системы. + +**Type:** bool + +**Details:** + + + +#### public $return_url : string +--- +***Description*** + +URL на который вернется плательщик после подтверждения или отмены платежа на +странице партнера. + +**Type:** string + +**Details:** + + + +#### public $returnUrl : string +--- +***Description*** + +URL на который вернется плательщик после подтверждения или отмены платежа на +странице партнера. + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getConfirmationData() + +```php +public getConfirmationData() +``` + +**Description** + +Для ConfirmationQr + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationToken() + +```php +public getConfirmationToken() +``` + +**Description** + +Для ConfirmationEmbedded + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() + +```php +public getConfirmationUrl() +``` + +**Description** + +Для ConfirmationRedirect + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** - + + + +#### public getConfirmationUrl() : string + +```php +public getConfirmationUrl() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) + +**Returns:** string - URL на который необходимо перенаправить плательщика для подтверждения оплаты. + + + +#### public getEnforce() : bool + +```php +public getEnforce() : bool +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) + +**Returns:** bool - Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для +оплаты банковскими картами. По умолчанию определяется политикой платежной системы. + + + +#### public getReturnUrl() : string + +```php +public getReturnUrl() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) + +**Returns:** string - URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setConfirmationUrl() : mixed + +```php +public setConfirmationUrl(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | URL на который необходимо перенаправить плательщика для подтверждения оплаты. | + +**Returns:** mixed - + + + +#### public setEnforce() : mixed + +```php +public setEnforce(bool value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы. | + +**Returns:** mixed - + + + +#### public setReturnUrl() : mixed + +```php +public setReturnUrl(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setType() : mixed + +```php +protected setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md new file mode 100644 index 00000000..96636647 --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md @@ -0,0 +1,401 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Способ подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php](../../lib/Model/ConfirmationAttributes/AbstractConfirmationAttributes.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md new file mode 100644 index 00000000..6668bfd0 --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md @@ -0,0 +1,395 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesCodeVerification +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Сценарий при котором необходимо получить одноразовый код от плательщика для подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesCodeVerification +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesCodeVerification](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesDeepLink.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesDeepLink.md new file mode 100644 index 00000000..6a83d8de --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesDeepLink.md @@ -0,0 +1,395 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesDeepLink +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Сценарий при котором необходимо направить плательщика в приложение партнера + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesDeepLink.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesDeepLink.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesDeepLink.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesDeepLink +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesDeepLink](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesDeepLink.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md new file mode 100644 index 00000000..3c241b0d --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md @@ -0,0 +1,395 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesEmbedded +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Способ подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesEmbedded.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesEmbedded +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesEmbedded](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md new file mode 100644 index 00000000..7be85c8d --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md @@ -0,0 +1,396 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesExternal +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Сценарий при котором необходимо ожидать пока пользователь самостоятельно подтвердит платеж. Например, +пользователь подтверждает платеж ответом на SMS или в приложении партнера + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesExternal +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesExternal](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md new file mode 100644 index 00000000..d00c6495 --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md @@ -0,0 +1,81 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Class ConfirmationAttributesFactory + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md#method_factory) | | | +| public | [factoryFromArray()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md#method_factoryFromArray) | | | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory + +--- +## Methods + +#### public factory() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes + +```php +public factory(string type) : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | | + +**Returns:** \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes - + + + +#### public factoryFromArray() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes + +```php +public factoryFromArray(array data, string|null type = null) : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | +| string OR null | type | | + +**Returns:** \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md new file mode 100644 index 00000000..4250517c --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md @@ -0,0 +1,395 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesQr +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Способ подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesQr.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesQr +--- +## Properties + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesQr](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md new file mode 100644 index 00000000..94ae8e5e --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md @@ -0,0 +1,502 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect +### Namespace: [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +--- +**Summary:** + +Способ подтверждения платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$enforce](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#property_enforce) | | Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы. | +| public | [$return_url](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#property_return_url) | | URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. | +| public | [$returnUrl](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#property_returnUrl) | | URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. | +| public | [$type](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#property_type) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEnforce()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_getEnforce) | | | +| public | [getLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getLocale) | | | +| public | [getReturnUrl()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_getReturnUrl) | | | +| public | [getType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_getType) | | | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setEnforce()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_setEnforce) | | | +| public | [setLocale()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method_setLocale) | | | +| public | [setReturnUrl()](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md#method_setReturnUrl) | | | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md#method__setType) | | | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php](../../lib/Model/ConfirmationAttributes/ConfirmationAttributesRedirect.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + * \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect +--- +## Properties + +#### public $enforce : bool +--- +***Description*** + +Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для +оплаты банковскими картами. По умолчанию определяется политикой платежной системы. + +**Type:** bool + +**Details:** + + + +#### public $return_url : string +--- +***Description*** + +URL на который вернется плательщик после подтверждения или отмены платежа +на странице партнера. + +**Type:** string + +**Details:** + + + +#### public $returnUrl : string +--- +***Description*** + +URL на который вернется плательщик после подтверждения или отмены платежа +на странице партнера. + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEnforce() : bool + +```php +public getEnforce() : bool +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md) + +**Returns:** bool - Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для +оплаты банковскими картами. По умолчанию определяется политикой платежной системы. + + + +#### public getLocale() : string + +```php +public getLocale() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public getReturnUrl() : string + +```php +public getReturnUrl() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md) + +**Returns:** string - URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setEnforce() : mixed + +```php +public setEnforce(bool value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты банковскими картами. По умолчанию определяется политикой платежной системы. | + +**Returns:** mixed - + + + +#### public setLocale() : mixed + +```php +public setLocale(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public setReturnUrl() : mixed + +```php +public setReturnUrl(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера. | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ConfirmationType.md b/docs/classes/YooKassa-Model-ConfirmationType.md new file mode 100644 index 00000000..3fc8ca02 --- /dev/null +++ b/docs/classes/YooKassa-Model-ConfirmationType.md @@ -0,0 +1,177 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ConfirmationType +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +ConfirmationType - Тип пользовательского процесса подтверждения платежа +|Код|Описание| +--- | --- +|redirect|Необходимо направить плательщика на страницу партнера| +|external|Необходимо ождать пока плательщик самостоятельно подтвердит платеж| +|deeplink|Необходимо направить плательщика в приложение партнера| +|code_verification|Необходимо получить одноразовый код от плательщика для подтверждения платежа| +|embedded|Необходимо получить токен для checkout.js| +|qr|Необходимо получить QR-код| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [REDIRECT](../classes/YooKassa-Model-ConfirmationType.md#constant_REDIRECT) | | | +| public | [EXTERNAL](../classes/YooKassa-Model-ConfirmationType.md#constant_EXTERNAL) | | | +| public | [DEEPLINK](../classes/YooKassa-Model-ConfirmationType.md#constant_DEEPLINK) | | | +| public | [CODE_VERIFICATION](../classes/YooKassa-Model-ConfirmationType.md#constant_CODE_VERIFICATION) | | | +| public | [EMBEDDED](../classes/YooKassa-Model-ConfirmationType.md#constant_EMBEDDED) | | | +| public | [QR](../classes/YooKassa-Model-ConfirmationType.md#constant_QR) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-ConfirmationType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/ConfirmationType.php](../../lib/Model/ConfirmationType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\ConfirmationType +--- +## Constants + +###### REDIRECT +```php +REDIRECT = 'redirect' +``` + + + +###### EXTERNAL +```php +EXTERNAL = 'external' +``` + + + +###### DEEPLINK +```php +DEEPLINK = 'deeplink' +``` + + + +###### CODE_VERIFICATION +```php +CODE_VERIFICATION = 'code_verification' +``` + + + +###### EMBEDDED +```php +EMBEDDED = 'embedded' +``` + + + +###### QR +```php +QR = 'qr' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-CurrencyCode.md b/docs/classes/YooKassa-Model-CurrencyCode.md new file mode 100644 index 00000000..473741f2 --- /dev/null +++ b/docs/classes/YooKassa-Model-CurrencyCode.md @@ -0,0 +1,191 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\CurrencyCode +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [RUB](../classes/YooKassa-Model-CurrencyCode.md#constant_RUB) | | Российский рубль | +| public | [USD](../classes/YooKassa-Model-CurrencyCode.md#constant_USD) | | Доллар США | +| public | [EUR](../classes/YooKassa-Model-CurrencyCode.md#constant_EUR) | | Евро | +| public | [BYN](../classes/YooKassa-Model-CurrencyCode.md#constant_BYN) | | Белорусский рубль | +| public | [CNY](../classes/YooKassa-Model-CurrencyCode.md#constant_CNY) | | Китайская йена | +| public | [KZT](../classes/YooKassa-Model-CurrencyCode.md#constant_KZT) | | Казахский тенге | +| public | [UAH](../classes/YooKassa-Model-CurrencyCode.md#constant_UAH) | | Украинская гривна | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-CurrencyCode.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/CurrencyCode.php](../../lib/Model/CurrencyCode.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\CurrencyCode +--- +## Constants + +###### RUB +Российский рубль + +```php +RUB = 'RUB' +``` + + + +###### USD +Доллар США + +```php +USD = 'USD' +``` + + + +###### EUR +Евро + +```php +EUR = 'EUR' +``` + + + +###### BYN +Белорусский рубль + +```php +BYN = 'BYN' +``` + + + +###### CNY +Китайская йена + +```php +CNY = 'CNY' +``` + + + +###### KZT +Казахский тенге + +```php +KZT = 'KZT' +``` + + + +###### UAH +Украинская гривна + +```php +UAH = 'UAH' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Leg.md b/docs/classes/YooKassa-Model-Leg.md new file mode 100644 index 00000000..36c37cd5 --- /dev/null +++ b/docs/classes/YooKassa-Model-Leg.md @@ -0,0 +1,569 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Leg +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс, описывающий маршрут + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [ISO8601](../classes/YooKassa-Model-Leg.md#constant_ISO8601) | | Формат даты | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$departure_airport](../classes/YooKassa-Model-Leg.md#property_departure_airport) | | Трёхбуквенный IATA-код аэропорта вылета | +| public | [$departure_date](../classes/YooKassa-Model-Leg.md#property_departure_date) | | Дата вылета в формате YYYY-MM-DD ISO 8601:2004 | +| public | [$departureAirport](../classes/YooKassa-Model-Leg.md#property_departureAirport) | | Трёхбуквенный IATA-код аэропорта вылета | +| public | [$departureDate](../classes/YooKassa-Model-Leg.md#property_departureDate) | | Дата вылета в формате YYYY-MM-DD ISO 8601:2004 | +| public | [$destination_airport](../classes/YooKassa-Model-Leg.md#property_destination_airport) | | Трёхбуквенный IATA-код аэропорта прилёта | +| public | [$destinationAirport](../classes/YooKassa-Model-Leg.md#property_destinationAirport) | | Трёхбуквенный IATA-код аэропорта прилёта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getDepartureAirport()](../classes/YooKassa-Model-Leg.md#method_getDepartureAirport) | | Возвращает трёхбуквенный IATA-код аэропорта вылета | +| public | [getDepartureDate()](../classes/YooKassa-Model-Leg.md#method_getDepartureDate) | | Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | +| public | [getDestinationAirport()](../classes/YooKassa-Model-Leg.md#method_getDestinationAirport) | | Возвращает трёхбуквенный IATA-код аэропорта прилёта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setDepartureAirport()](../classes/YooKassa-Model-Leg.md#method_setDepartureAirport) | | Устанавливает трёхбуквенный IATA-код аэропорта вылета | +| public | [setDepartureDate()](../classes/YooKassa-Model-Leg.md#method_setDepartureDate) | | Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | +| public | [setDestinationAirport()](../classes/YooKassa-Model-Leg.md#method_setDestinationAirport) | | Устанавливает трёхбуквенный IATA-код аэропорта прилёта | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Leg.php](../../lib/Model/Leg.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Leg +* Implements: + * [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) +--- +## Constants + +###### ISO8601 +Формат даты + +```php +ISO8601 = 'Y-m-d' +``` + + +--- +## Properties + +#### public $departure_airport : string +--- +***Description*** + +Трёхбуквенный IATA-код аэропорта вылета + +**Type:** string + +**Details:** + + + +#### public $departure_date : string +--- +***Description*** + +Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + +**Type:** string + +**Details:** + + + +#### public $departureAirport : string +--- +***Description*** + +Трёхбуквенный IATA-код аэропорта вылета + +**Type:** string + +**Details:** + + + +#### public $departureDate : string +--- +***Description*** + +Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + +**Type:** string + +**Details:** + + + +#### public $destination_airport : string +--- +***Description*** + +Трёхбуквенный IATA-код аэропорта прилёта + +**Type:** string + +**Details:** + + + +#### public $destinationAirport : string +--- +***Description*** + +Трёхбуквенный IATA-код аэропорта прилёта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getDepartureAirport() : string + +```php +public getDepartureAirport() : string +``` + +**Summary** + +Возвращает трёхбуквенный IATA-код аэропорта вылета + +**Details:** +* Inherited From: [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) + +**Returns:** string - Трёхбуквенный IATA-код аэропорта вылета + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getDepartureDate() : string + +```php +public getDepartureDate() : string +``` + +**Summary** + +Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 + +**Details:** +* Inherited From: [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) + +**Returns:** string - Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getDestinationAirport() : string + +```php +public getDestinationAirport() : string +``` + +**Summary** + +Возвращает трёхбуквенный IATA-код аэропорта прилёта + +**Details:** +* Inherited From: [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) + +**Returns:** string - Трёхбуквенный IATA-код аэропорта прилёта + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setDepartureAirport() : mixed + +```php +public setDepartureAirport(string value) : mixed +``` + +**Summary** + +Устанавливает трёхбуквенный IATA-код аэропорта вылета + +**Details:** +* Inherited From: [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public setDepartureDate() : mixed + +```php +public setDepartureDate(\DateTime|string value) : mixed +``` + +**Summary** + +Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 + +**Details:** +* Inherited From: [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public setDestinationAirport() : mixed + +```php +public setDestinationAirport(string value) : mixed +``` + +**Summary** + +Устанавливает трёхбуквенный IATA-код аэропорта прилёта + +**Details:** +* Inherited From: [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-LegInterface.md b/docs/classes/YooKassa-Model-LegInterface.md new file mode 100644 index 00000000..d6f5f53d --- /dev/null +++ b/docs/classes/YooKassa-Model-LegInterface.md @@ -0,0 +1,159 @@ +# [YooKassa API SDK](../home.md) + +# Interface: LegInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getDepartureAirport()](../classes/YooKassa-Model-LegInterface.md#method_getDepartureAirport) | | Возвращает трёхбуквенный IATA-код аэропорта вылета | +| public | [getDepartureDate()](../classes/YooKassa-Model-LegInterface.md#method_getDepartureDate) | | Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | +| public | [getDestinationAirport()](../classes/YooKassa-Model-LegInterface.md#method_getDestinationAirport) | | Возвращает трёхбуквенный IATA-код аэропорта прилёта | +| public | [setDepartureAirport()](../classes/YooKassa-Model-LegInterface.md#method_setDepartureAirport) | | Устанавливает трёхбуквенный IATA-код аэропорта вылета | +| public | [setDepartureDate()](../classes/YooKassa-Model-LegInterface.md#method_setDepartureDate) | | Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 | +| public | [setDestinationAirport()](../classes/YooKassa-Model-LegInterface.md#method_setDestinationAirport) | | Устанавливает трёхбуквенный IATA-код аэропорта прилёта | + +--- +### Details +* File: [lib/Model/LegInterface.php](../../lib/Model/LegInterface.php) +* Package: \Default +--- +## Methods + +#### public getDepartureAirport() : string + +```php +public getDepartureAirport() : string +``` + +**Summary** + +Возвращает трёхбуквенный IATA-код аэропорта вылета + +**Details:** +* Inherited From: [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) + +**Returns:** string - Трёхбуквенный IATA-код аэропорта вылета + + + +#### public getDestinationAirport() : string + +```php +public getDestinationAirport() : string +``` + +**Summary** + +Возвращает трёхбуквенный IATA-код аэропорта прилёта + +**Details:** +* Inherited From: [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) + +**Returns:** string - Трёхбуквенный IATA-код аэропорта прилёта + + + +#### public getDepartureDate() : string + +```php +public getDepartureDate() : string +``` + +**Summary** + +Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 + +**Details:** +* Inherited From: [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) + +**Returns:** string - Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + + + +#### public setDepartureAirport() : mixed + +```php +public setDepartureAirport(string value) : mixed +``` + +**Summary** + +Устанавливает трёхбуквенный IATA-код аэропорта вылета + +**Details:** +* Inherited From: [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Трёхбуквенный IATA-код аэропорта вылета | + +**Returns:** mixed - + + + +#### public setDestinationAirport() : mixed + +```php +public setDestinationAirport(string value) : mixed +``` + +**Summary** + +Устанавливает трёхбуквенный IATA-код аэропорта прилёта + +**Details:** +* Inherited From: [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Трёхбуквенный IATA-код аэропорта прилёта | + +**Returns:** mixed - + + + +#### public setDepartureDate() : mixed + +```php +public setDepartureDate(\DateTime|string value) : mixed +``` + +**Summary** + +Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 + +**Details:** +* Inherited From: [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string | value | Дата вылета в формате YYYY-MM-DD ISO 8601:2004 | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Metadata.md b/docs/classes/YooKassa-Model-Metadata.md new file mode 100644 index 00000000..116c7e52 --- /dev/null +++ b/docs/classes/YooKassa-Model-Metadata.md @@ -0,0 +1,370 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Metadata +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Metadata - Метаданные платежа указанные мерчантом. + +**Description:** + +Мерчант может добавлять произвольные данные к платежам в виде набора пар ключ-значение. +Имена ключей уникальны. + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [count()](../classes/YooKassa-Model-Metadata.md#method_count) | | Возвращает количество метаданных | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getIterator()](../classes/YooKassa-Model-Metadata.md#method_getIterator) | | Возвращает объект ArrayIterator для метаданных | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Model-Metadata.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Metadata.php](../../lib/Model/Metadata.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Metadata +* Implements: + * [](\IteratorAggregate) + * [](\Countable) + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public count() : int + +```php +public count() : int +``` + +**Summary** + +Возвращает количество метаданных + +**Details:** +* Inherited From: [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) + +**Returns:** int - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getIterator() : \Iterator + +```php +public getIterator() : \Iterator +``` + +**Summary** + +Возвращает объект ArrayIterator для метаданных + +**Details:** +* Inherited From: [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) + +**Returns:** \Iterator - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) + +**Returns:** array - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-MonetaryAmount.md b/docs/classes/YooKassa-Model-MonetaryAmount.md new file mode 100644 index 00000000..25698aab --- /dev/null +++ b/docs/classes/YooKassa-Model-MonetaryAmount.md @@ -0,0 +1,523 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\MonetaryAmount +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +MonetaryAmount - Сумма определенная в валюте + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$currency](../classes/YooKassa-Model-MonetaryAmount.md#property_currency) | | Код валюты | +| public | [$value](../classes/YooKassa-Model-MonetaryAmount.md#property_value) | | Сумма | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-MonetaryAmount.md#method___construct) | | MonetaryAmount constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCurrency()](../classes/YooKassa-Model-MonetaryAmount.md#method_getCurrency) | | Возвращает валюту | +| public | [getIntegerValue()](../classes/YooKassa-Model-MonetaryAmount.md#method_getIntegerValue) | | Возвращает сумму в копейках в виде целого числа | +| public | [getValue()](../classes/YooKassa-Model-MonetaryAmount.md#method_getValue) | | Возвращает значение суммы | +| public | [increase()](../classes/YooKassa-Model-MonetaryAmount.md#method_increase) | | Увеличивает сумму на указанное значение | +| public | [jsonSerialize()](../classes/YooKassa-Model-MonetaryAmount.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [multiply()](../classes/YooKassa-Model-MonetaryAmount.md#method_multiply) | | Умножает текущую сумму на указанный коэффициент | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCurrency()](../classes/YooKassa-Model-MonetaryAmount.md#method_setCurrency) | | Устанавливает код валюты | +| public | [setValue()](../classes/YooKassa-Model-MonetaryAmount.md#method_setValue) | | Устанавливает сумму | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/MonetaryAmount.php](../../lib/Model/MonetaryAmount.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\MonetaryAmount +* Implements: + * [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) +--- +## Properties + +#### public $currency : string +--- +***Description*** + +Код валюты + +**Type:** string + +**Details:** + + + +#### public $value : string +--- +***Description*** + +Сумма + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(\YooKassa\Model\numeric|null value = null, string|null currency = null) : mixed +``` + +**Summary** + +MonetaryAmount constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\numeric OR null | value | Сумма | +| string OR null | currency | Код валюты | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCurrency() : string + +```php +public getCurrency() : string +``` + +**Summary** + +Возвращает валюту + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) + +**Returns:** string - Код валюты + + + +#### public getIntegerValue() : int + +```php +public getIntegerValue() : int +``` + +**Summary** + +Возвращает сумму в копейках в виде целого числа + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) + +**Returns:** int - Сумма в копейках/центах + + + +#### public getValue() : string + +```php +public getValue() : string +``` + +**Summary** + +Возвращает значение суммы + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) + +**Returns:** string - Сумма + + + +#### public increase() : mixed + +```php +public increase(int value) : mixed +``` + +**Summary** + +Увеличивает сумму на указанное значение + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Значение которое будет прибавлено к текущему | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если после сложения получилась сумма меньше или равная нулю | + +**Returns:** mixed - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) + +**Returns:** array - + + + +#### public multiply() : mixed + +```php +public multiply(float coefficient) : mixed +``` + +**Summary** + +Умножает текущую сумму на указанный коэффициент + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float | coefficient | Множитель | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение меньше или равно нулю, либо если после умножения получили значение равное нулю | + +**Returns:** mixed - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCurrency() : mixed + +```php +public setCurrency(string value) : mixed +``` + +**Summary** + +Устанавливает код валюты + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Код валюты | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Генерируется если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если был передан неподдерживаемый код валюты | + +**Returns:** mixed - + + + +#### public setValue() : mixed + +```php +public setValue(string value) : mixed +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Сумма | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Генерируется если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если было передано не валидное значение | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-AbstractNotification.md b/docs/classes/YooKassa-Model-Notification-AbstractNotification.md new file mode 100644 index 00000000..c1801307 --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-AbstractNotification.md @@ -0,0 +1,552 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Model\Notification\AbstractNotification +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +**Summary:** + +Базовый класс уведомлений + +--- +### Examples +Пример скрипта обработки уведомления + +```php +require_once '../vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} + + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$event](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_event) | | Тип события | +| public | [$type](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_type) | | Тип уведомления в виде строки | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | +| public | [getObject()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getObject) | | Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте | +| public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | +| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Notification/AbstractNotification.php](../../lib/Model/Notification/AbstractNotification.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Notification\AbstractNotification +* Implements: + * [\YooKassa\Model\Notification\NotificationInterface](../classes/YooKassa-Model-Notification-NotificationInterface.md) +--- +## Properties + +#### public $event : string +--- +***Description*** + +Тип события + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип уведомления в виде строки + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает тип события + +**Description** + +Тип события - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип события + + + +#### public getObject() : \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface + +```php +public getObject() : \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface +``` + +**Summary** + +Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте + +**Description** + +Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет +получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о +платеже у API. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface - Объект с информацией о платеже + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип уведомления + +**Description** + +Тип уведомления - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип уведомления в виде строки + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setEvent() : mixed + +```php +protected _setEvent(string value) : mixed +``` + +**Summary** + +Устанавливает тип события + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип события | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов событий | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип уведомления | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов нотификаций | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md b/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md new file mode 100644 index 00000000..5445ace4 --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-NotificationCanceled.md @@ -0,0 +1,576 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Notification\NotificationCanceled +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +**Summary:** + +Класс объекта, присылаемого API при изменении статуса платежа на "canceled" + +--- +### Examples +Пример скрипта обработки уведомления + +```php +require_once '../vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} + + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$event](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_event) | | Тип события | +| public | [$object](../classes/YooKassa-Model-Notification-NotificationCanceled.md#property_object) | | Объект с информацией о платеже | +| public | [$type](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_type) | | Тип уведомления в виде строки | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Notification-NotificationCanceled.md#method___construct) | | Конструктор объекта нотификации о возможности подтверждения платежа | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | +| public | [getObject()](../classes/YooKassa-Model-Notification-NotificationCanceled.md#method_getObject) | | Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте | +| public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | +| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Notification/NotificationCanceled.php](../../lib/Model/Notification/NotificationCanceled.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + * \YooKassa\Model\Notification\NotificationCanceled +--- +## Properties + +#### public $event : string +--- +***Description*** + +Тип события + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +#### public $object : \YooKassa\Model\PaymentInterface +--- +***Description*** + +Объект с информацией о платеже + +**Type:** PaymentInterface + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип уведомления в виде строки + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array source) : mixed +``` + +**Summary** + +Конструктор объекта нотификации о возможности подтверждения платежа + +**Description** + +Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из +тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если +передать уведомление не того типа, будет сгенерировано исключение типа {@link} + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationCanceled](../classes/YooKassa-Model-Notification-NotificationCanceled.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | source | Ассоциативный массив с информацией о уведомлении | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если значение типа нотификации или события не равны "notification" и "payment.canceled" соответственно, что может говорить о том, что переданные в конструктор данные не являются уведомлением нужного типа. | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает тип события + +**Description** + +Тип события - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип события + + + +#### public getObject() : \YooKassa\Model\PaymentInterface + +```php +public getObject() : \YooKassa\Model\PaymentInterface +``` + +**Summary** + +Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте + +**Description** + +Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет +получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о +платеже у API. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationCanceled](../classes/YooKassa-Model-Notification-NotificationCanceled.md) + +**Returns:** \YooKassa\Model\PaymentInterface - Объект с информацией о платеже + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип уведомления + +**Description** + +Тип уведомления - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип уведомления в виде строки + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setEvent() : mixed + +```php +protected _setEvent(string value) : mixed +``` + +**Summary** + +Устанавливает тип события + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип события | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов событий | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип уведомления | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов нотификаций | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationFactory.md b/docs/classes/YooKassa-Model-Notification-NotificationFactory.md new file mode 100644 index 00000000..4bc98e4d --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-NotificationFactory.md @@ -0,0 +1,134 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Notification\NotificationFactory +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +**Summary:** + +Фабрика для получения конкретного объекта уведомления. + +--- +### Examples +Пример скрипта обработки уведомления + +```php +require_once '../vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} + + +``` +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Model-Notification-NotificationFactory.md#method_factory) | | | +--- +### Details +* File: [lib/Model/Notification/NotificationFactory.php](../../lib/Model/Notification/NotificationFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Model\Notification\NotificationFactory + +--- +## Methods + +#### public factory() : \YooKassa\Model\Notification\AbstractNotification + +```php +public factory(array data) : \YooKassa\Model\Notification\AbstractNotification +``` + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationFactory](../classes/YooKassa-Model-Notification-NotificationFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** \YooKassa\Model\Notification\AbstractNotification - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationInterface.md b/docs/classes/YooKassa-Model-Notification-NotificationInterface.md new file mode 100644 index 00000000..f2e775cd --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-NotificationInterface.md @@ -0,0 +1,107 @@ +# [YooKassa API SDK](../home.md) + +# Interface: NotificationInterface +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEvent()](../classes/YooKassa-Model-Notification-NotificationInterface.md#method_getEvent) | | Возвращает тип события | +| public | [getObject()](../classes/YooKassa-Model-Notification-NotificationInterface.md#method_getObject) | | Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте | +| public | [getType()](../classes/YooKassa-Model-Notification-NotificationInterface.md#method_getType) | | Возвращает тип уведомления | + +--- +### Details +* File: [lib/Model/Notification/NotificationInterface.php](../../lib/Model/Notification/NotificationInterface.php) +* Package: \Default +--- +## Methods + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип уведомления + +**Description** + +Тип уведомления - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationInterface](../classes/YooKassa-Model-Notification-NotificationInterface.md) + +**Returns:** string - Тип уведомления в виде строки + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает тип события + +**Description** + +Тип события - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationInterface](../classes/YooKassa-Model-Notification-NotificationInterface.md) + +**Returns:** string - Тип события + + + +#### public getObject() : \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface + +```php +public getObject() : \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface +``` + +**Summary** + +Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте + +**Description** + +Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет +получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о +платеже у API. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationInterface](../classes/YooKassa-Model-Notification-NotificationInterface.md) + +**Returns:** \YooKassa\Model\PaymentInterface|\YooKassa\Model\RefundInterface - Объект с информацией о платеже + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md b/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md new file mode 100644 index 00000000..9247b379 --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md @@ -0,0 +1,576 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Notification\NotificationRefundSucceeded +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +**Summary:** + +Класс объекта, присылаемого API при изменении статуса возврата на "succeeded" + +--- +### Examples +Пример скрипта обработки уведомления + +```php +require_once '../vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} + + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$event](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_event) | | Тип события | +| public | [$object](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md#property_object) | | Объект с информацией о возврате | +| public | [$type](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_type) | | Тип уведомления в виде строки | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md#method___construct) | | Конструктор объекта нотификации | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | +| public | [getObject()](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md#method_getObject) | | Возвращает объект с информацией о возврате, уведомление о котором хранится в текущем объекте | +| public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | +| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Notification/NotificationRefundSucceeded.php](../../lib/Model/Notification/NotificationRefundSucceeded.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + * \YooKassa\Model\Notification\NotificationRefundSucceeded +--- +## Properties + +#### public $event : string +--- +***Description*** + +Тип события + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +#### public $object : \YooKassa\Model\RefundInterface +--- +***Description*** + +Объект с информацией о возврате + +**Type:** RefundInterface + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип уведомления в виде строки + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array source) : mixed +``` + +**Summary** + +Конструктор объекта нотификации + +**Description** + +Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из +тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если +передать уведомление не того типа, будет сгенерировано исключение типа {@link} + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationRefundSucceeded](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | source | Ассоциативный массив с информацией о уведомлении | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException|\Exception | Генерируется если значение типа нотификации или события не равны "notification" и "refund.succeeded" соответственно, что может говорить о том, что переданные в конструктор данные не являются уведомлением нужного типа. | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает тип события + +**Description** + +Тип события - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип события + + + +#### public getObject() : \YooKassa\Model\RefundInterface + +```php +public getObject() : \YooKassa\Model\RefundInterface +``` + +**Summary** + +Возвращает объект с информацией о возврате, уведомление о котором хранится в текущем объекте + +**Description** + +Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет +получена на сайте, то опираться на статус пришедшего возврата не стоит, лучше запросить текущую информацию о +возврате у API. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationRefundSucceeded](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md) + +**Returns:** \YooKassa\Model\RefundInterface - Объект с информацией о возврате + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип уведомления + +**Description** + +Тип уведомления - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип уведомления в виде строки + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setEvent() : mixed + +```php +protected _setEvent(string value) : mixed +``` + +**Summary** + +Устанавливает тип события + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип события | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов событий | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип уведомления | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов нотификаций | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md b/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md new file mode 100644 index 00000000..49c675dd --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-NotificationSucceeded.md @@ -0,0 +1,576 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Notification\NotificationSucceeded +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +**Summary:** + +Класс объекта, присылаемого API при изменении статуса платежа на "succeeded" + +--- +### Examples +Пример скрипта обработки уведомления + +```php +require_once '../vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} + + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$event](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_event) | | Тип события | +| public | [$object](../classes/YooKassa-Model-Notification-NotificationSucceeded.md#property_object) | | Объект с информацией о платеже | +| public | [$type](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_type) | | Тип уведомления в виде строки | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Notification-NotificationSucceeded.md#method___construct) | | Конструктор объекта нотификации о возможности подтверждения платежа | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | +| public | [getObject()](../classes/YooKassa-Model-Notification-NotificationSucceeded.md#method_getObject) | | Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте | +| public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | +| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Notification/NotificationSucceeded.php](../../lib/Model/Notification/NotificationSucceeded.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + * \YooKassa\Model\Notification\NotificationSucceeded +--- +## Properties + +#### public $event : string +--- +***Description*** + +Тип события + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +#### public $object : \YooKassa\Model\PaymentInterface +--- +***Description*** + +Объект с информацией о платеже + +**Type:** PaymentInterface + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип уведомления в виде строки + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array source) : mixed +``` + +**Summary** + +Конструктор объекта нотификации о возможности подтверждения платежа + +**Description** + +Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из +тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если +передать уведомление не того типа, будет сгенерировано исключение типа {@link} + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationSucceeded](../classes/YooKassa-Model-Notification-NotificationSucceeded.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | source | Ассоциативный массив с информацией о уведомлении | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если значение типа нотификации или события не равны "notification" и "payment.succeeded" соответственно, что может говорить о том, что переданные в конструктор данные не являются уведомлением нужного типа. | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает тип события + +**Description** + +Тип события - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип события + + + +#### public getObject() : \YooKassa\Model\PaymentInterface + +```php +public getObject() : \YooKassa\Model\PaymentInterface +``` + +**Summary** + +Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте + +**Description** + +Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет +получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о +платеже у API. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationSucceeded](../classes/YooKassa-Model-Notification-NotificationSucceeded.md) + +**Returns:** \YooKassa\Model\PaymentInterface - Объект с информацией о платеже + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип уведомления + +**Description** + +Тип уведомления - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип уведомления в виде строки + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setEvent() : mixed + +```php +protected _setEvent(string value) : mixed +``` + +**Summary** + +Устанавливает тип события + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип события | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов событий | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип уведомления | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов нотификаций | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md b/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md new file mode 100644 index 00000000..97303026 --- /dev/null +++ b/docs/classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md @@ -0,0 +1,582 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Notification\NotificationWaitingForCapture +### Namespace: [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +--- +**Summary:** + +Класс объекта, присылаемого API при изменении статуса платежа на "waiting_for_capture" + +**Description:** + +При создании платежа с флагом "capture" равным false, после того как клиент проводит платёж, от API на эндпоинт, +указанный в настройках API посылается уведомление о том, что платёж теперь может быть проведён. В классе описана +структура такого объекта для магазинов, которые получают уведомления на HTTPS endpoint. + +--- +### Examples +Пример скрипта обработки уведомления + +```php +require_once '../vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} + + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$event](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_event) | | Тип события | +| public | [$object](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md#property_object) | | Объект с информацией о платеже, который можно подтвердить или отменить | +| public | [$type](../classes/YooKassa-Model-Notification-AbstractNotification.md#property_type) | | Тип уведомления в виде строки | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md#method___construct) | | Конструктор объекта нотификации о возможности подтверждения платежа | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getEvent) | | Возвращает тип события | +| public | [getObject()](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md#method_getObject) | | Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте | +| public | [getType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method_getType) | | Возвращает тип уведомления | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setEvent()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setEvent) | | Устанавливает тип события | +| protected | [_setType()](../classes/YooKassa-Model-Notification-AbstractNotification.md#method__setType) | | Устанавливает тип уведомления | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Notification/NotificationWaitingForCapture.php](../../lib/Model/Notification/NotificationWaitingForCapture.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + * \YooKassa\Model\Notification\NotificationWaitingForCapture +--- +## Properties + +#### public $event : string +--- +***Description*** + +Тип события + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +#### public $object : \YooKassa\Model\PaymentInterface +--- +***Description*** + +Объект с информацией о платеже, который можно подтвердить или отменить + +**Type:** PaymentInterface + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип уведомления в виде строки + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array source) : mixed +``` + +**Summary** + +Конструктор объекта нотификации о возможности подтверждения платежа + +**Description** + +Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из +тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если +передать уведомление не того типа, будет сгенерировано исключение типа {@link} + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationWaitingForCapture](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | source | Ассоциативный массив с информацией о уведомлении | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если значение типа нотификации или события не равны "notification" и "payment.waiting_for_capture" соответственно, что может говорить о том, что переданные в конструктор данные не являются уведомлением нужного типа. | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает тип события + +**Description** + +Тип события - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип события + + + +#### public getObject() : \YooKassa\Model\PaymentInterface + +```php +public getObject() : \YooKassa\Model\PaymentInterface +``` + +**Summary** + +Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте + +**Description** + +Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет +получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о +платеже у API. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\NotificationWaitingForCapture](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md) + +**Returns:** \YooKassa\Model\PaymentInterface - Объект с информацией о платеже, который можно подтвердить или отменить + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип уведомления + +**Description** + +Тип уведомления - одна из констант, указанных в перечислении {@link}. + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) + +**Returns:** string - Тип уведомления в виде строки + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setEvent() : mixed + +```php +protected _setEvent(string value) : mixed +``` + +**Summary** + +Устанавливает тип события + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип события | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов событий | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип уведомления | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в качестве значения было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не найдено в перечислении типов нотификаций | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-NotificationEventType.md b/docs/classes/YooKassa-Model-NotificationEventType.md new file mode 100644 index 00000000..ebd42aa1 --- /dev/null +++ b/docs/classes/YooKassa-Model-NotificationEventType.md @@ -0,0 +1,167 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\NotificationEventType +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +NotificationEventType - Тип уведомления +|Код|Описание| +--- | --- +|payment.waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| +|payment.succeeded|Успешно оплачен и подтвержден магазином| +|payment.canceled|Неуспех оплаты или отменен магазином| +|refund.succeeded|Успешный возврат| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PAYMENT_WAITING_FOR_CAPTURE](../classes/YooKassa-Model-NotificationEventType.md#constant_PAYMENT_WAITING_FOR_CAPTURE) | | Успешно оплачен покупателем, ожидает подтверждения магазином | +| public | [PAYMENT_SUCCEEDED](../classes/YooKassa-Model-NotificationEventType.md#constant_PAYMENT_SUCCEEDED) | | Успешно оплачен и подтвержден магазином | +| public | [PAYMENT_CANCELED](../classes/YooKassa-Model-NotificationEventType.md#constant_PAYMENT_CANCELED) | | Неуспех оплаты или отменен магазином | +| public | [REFUND_SUCCEEDED](../classes/YooKassa-Model-NotificationEventType.md#constant_REFUND_SUCCEEDED) | | Успешный возврат | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-NotificationEventType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/NotificationEventType.php](../../lib/Model/NotificationEventType.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\NotificationEventType +--- +## Constants + +###### PAYMENT_WAITING_FOR_CAPTURE +Успешно оплачен покупателем, ожидает подтверждения магазином + +```php +PAYMENT_WAITING_FOR_CAPTURE = 'payment.waiting_for_capture' +``` + + + +###### PAYMENT_SUCCEEDED +Успешно оплачен и подтвержден магазином + +```php +PAYMENT_SUCCEEDED = 'payment.succeeded' +``` + + + +###### PAYMENT_CANCELED +Неуспех оплаты или отменен магазином + +```php +PAYMENT_CANCELED = 'payment.canceled' +``` + + + +###### REFUND_SUCCEEDED +Успешный возврат + +```php +REFUND_SUCCEEDED = 'refund.succeeded' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-NotificationType.md b/docs/classes/YooKassa-Model-NotificationType.md new file mode 100644 index 00000000..d2d62d0f --- /dev/null +++ b/docs/classes/YooKassa-Model-NotificationType.md @@ -0,0 +1,129 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\NotificationType +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [NOTIFICATION](../classes/YooKassa-Model-NotificationType.md#constant_NOTIFICATION) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-NotificationType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/NotificationType.php](../../lib/Model/NotificationType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\NotificationType +--- +## Constants + +###### NOTIFICATION +```php +NOTIFICATION = 'notification' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Passenger.md b/docs/classes/YooKassa-Model-Passenger.md new file mode 100644 index 00000000..75d001f9 --- /dev/null +++ b/docs/classes/YooKassa-Model-Passenger.md @@ -0,0 +1,478 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Passenger +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс описывающий данные пассажира + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$first_name](../classes/YooKassa-Model-Passenger.md#property_first_name) | | Имя пассажира | +| public | [$firstName](../classes/YooKassa-Model-Passenger.md#property_firstName) | | Имя пассажира | +| public | [$last_name](../classes/YooKassa-Model-Passenger.md#property_last_name) | | Фамилия пассажира | +| public | [$lastName](../classes/YooKassa-Model-Passenger.md#property_lastName) | | Фамилия пассажира | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getFirstName()](../classes/YooKassa-Model-Passenger.md#method_getFirstName) | | Возвращает имя пассажира | +| public | [getLastName()](../classes/YooKassa-Model-Passenger.md#method_getLastName) | | Возвращает фамилию пассажира | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setFirstName()](../classes/YooKassa-Model-Passenger.md#method_setFirstName) | | Устанавливает имя пассажира | +| public | [setLastName()](../classes/YooKassa-Model-Passenger.md#method_setLastName) | | Устанавливает фамилию пассажира | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Passenger.php](../../lib/Model/Passenger.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Passenger +* Implements: + * [\YooKassa\Model\PassengerInterface](../classes/YooKassa-Model-PassengerInterface.md) +--- +## Properties + +#### public $first_name : string +--- +***Description*** + +Имя пассажира + +**Type:** string + +**Details:** + + + +#### public $firstName : string +--- +***Description*** + +Имя пассажира + +**Type:** string + +**Details:** + + + +#### public $last_name : string +--- +***Description*** + +Фамилия пассажира + +**Type:** string + +**Details:** + + + +#### public $lastName : string +--- +***Description*** + +Фамилия пассажира + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getFirstName() : string + +```php +public getFirstName() : string +``` + +**Summary** + +Возвращает имя пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\Passenger](../classes/YooKassa-Model-Passenger.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getLastName() : string + +```php +public getLastName() : string +``` + +**Summary** + +Возвращает фамилию пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\Passenger](../classes/YooKassa-Model-Passenger.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setFirstName() : mixed + +```php +public setFirstName(string value) : mixed +``` + +**Summary** + +Устанавливает имя пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\Passenger](../classes/YooKassa-Model-Passenger.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public setLastName() : mixed + +```php +public setLastName(string value) : mixed +``` + +**Summary** + +Устанавливает фамилию пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\Passenger](../classes/YooKassa-Model-Passenger.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PassengerInterface.md b/docs/classes/YooKassa-Model-PassengerInterface.md new file mode 100644 index 00000000..76926be3 --- /dev/null +++ b/docs/classes/YooKassa-Model-PassengerInterface.md @@ -0,0 +1,119 @@ +# [YooKassa API SDK](../home.md) + +# Interface: PassengerInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getFirstName()](../classes/YooKassa-Model-PassengerInterface.md#method_getFirstName) | | Возвращает имя пассажира | +| public | [getLastName()](../classes/YooKassa-Model-PassengerInterface.md#method_getLastName) | | Возвращает фамилию пассажира | +| public | [setFirstName()](../classes/YooKassa-Model-PassengerInterface.md#method_setFirstName) | | Устанавливает имя пассажира | +| public | [setLastName()](../classes/YooKassa-Model-PassengerInterface.md#method_setLastName) | | Устанавливает фамилию пассажира | + +--- +### Details +* File: [lib/Model/PassengerInterface.php](../../lib/Model/PassengerInterface.php) +* Package: \Default +--- +## Methods + +#### public getFirstName() : string + +```php +public getFirstName() : string +``` + +**Summary** + +Возвращает имя пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\PassengerInterface](../classes/YooKassa-Model-PassengerInterface.md) + +**Returns:** string - + + + +#### public setFirstName() : mixed + +```php +public setFirstName(string value) : mixed +``` + +**Summary** + +Устанавливает имя пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\PassengerInterface](../classes/YooKassa-Model-PassengerInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Имя пассажира | + +**Returns:** mixed - + + + +#### public getLastName() : string + +```php +public getLastName() : string +``` + +**Summary** + +Возвращает фамилию пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\PassengerInterface](../classes/YooKassa-Model-PassengerInterface.md) + +**Returns:** string - + + + +#### public setLastName() : mixed + +```php +public setLastName(string value) : mixed +``` + +**Summary** + +Устанавливает фамилию пассажира + +**Details:** +* Inherited From: [\YooKassa\Model\PassengerInterface](../classes/YooKassa-Model-PassengerInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Фамилия пассажира | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Payment.md b/docs/classes/YooKassa-Model-Payment.md new file mode 100644 index 00000000..dc6cb07f --- /dev/null +++ b/docs/classes/YooKassa-Model-Payment.md @@ -0,0 +1,1635 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Payment +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Payment - Данные о платеже + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Payment.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payment.md#property_amount) | | Сумма заказа | +| public | [$authorization_details](../classes/YooKassa-Model-Payment.md#property_authorization_details) | | Данные об авторизации платежа | +| public | [$authorizationDetails](../classes/YooKassa-Model-Payment.md#property_authorizationDetails) | | Данные об авторизации платежа | +| public | [$cancellation_details](../classes/YooKassa-Model-Payment.md#property_cancellation_details) | | Комментарий к отмене платежа | +| public | [$cancellationDetails](../classes/YooKassa-Model-Payment.md#property_cancellationDetails) | | Комментарий к отмене платежа | +| public | [$captured_at](../classes/YooKassa-Model-Payment.md#property_captured_at) | | Время подтверждения платежа магазином | +| public | [$capturedAt](../classes/YooKassa-Model-Payment.md#property_capturedAt) | | Время подтверждения платежа магазином | +| public | [$confirmation](../classes/YooKassa-Model-Payment.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$created_at](../classes/YooKassa-Model-Payment.md#property_created_at) | | Время создания заказа | +| public | [$createdAt](../classes/YooKassa-Model-Payment.md#property_createdAt) | | Время создания заказа | +| public | [$description](../classes/YooKassa-Model-Payment.md#property_description) | | Описание транзакции | +| public | [$expires_at](../classes/YooKassa-Model-Payment.md#property_expires_at) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$expiresAt](../classes/YooKassa-Model-Payment.md#property_expiresAt) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$id](../classes/YooKassa-Model-Payment.md#property_id) | | Идентификатор платежа | +| public | [$income_amount](../classes/YooKassa-Model-Payment.md#property_income_amount) | | Сумма платежа, которую получит магазин | +| public | [$incomeAmount](../classes/YooKassa-Model-Payment.md#property_incomeAmount) | | Сумма платежа, которую получит магазин | +| public | [$metadata](../classes/YooKassa-Model-Payment.md#property_metadata) | | Метаданные платежа указанные мерчантом | +| public | [$paid](../classes/YooKassa-Model-Payment.md#property_paid) | | Признак оплаты заказа | +| public | [$payment_method](../classes/YooKassa-Model-Payment.md#property_payment_method) | | Способ проведения платежа | +| public | [$paymentMethod](../classes/YooKassa-Model-Payment.md#property_paymentMethod) | | Способ проведения платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Payment.md#property_receipt_registration) | | Состояние регистрации фискального чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Payment.md#property_receiptRegistration) | | Состояние регистрации фискального чека | +| public | [$recipient](../classes/YooKassa-Model-Payment.md#property_recipient) | | Получатель платежа | +| public | [$refundable](../classes/YooKassa-Model-Payment.md#property_refundable) | | Возможность провести возврат по API | +| public | [$refunded_amount](../classes/YooKassa-Model-Payment.md#property_refunded_amount) | | Сумма возвращенных средств платежа | +| public | [$refundedAmount](../classes/YooKassa-Model-Payment.md#property_refundedAmount) | | Сумма возвращенных средств платежа | +| public | [$requestor](../classes/YooKassa-Model-Payment.md#property_requestor) | | Инициатор платежа | +| public | [$status](../classes/YooKassa-Model-Payment.md#property_status) | | Текущее состояние платежа | +| public | [$test](../classes/YooKassa-Model-Payment.md#property_test) | | Признак тестовой операции | +| public | [$transfers](../classes/YooKassa-Model-Payment.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Payment.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-Payment.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-Payment.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-Payment.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getDescription()](../classes/YooKassa-Model-Payment.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getExpiresAt()](../classes/YooKassa-Model-Payment.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-Payment.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_getIncomeAmount) | | Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [getMetadata()](../classes/YooKassa-Model-Payment.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-Payment.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-Payment.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-Payment.md#method_getRefundable) | | Проверяет возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-Payment.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | +| public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | +| public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [setCapturedAt()](../classes/YooKassa-Model-Payment.md#method_setCapturedAt) | | Устанавливает время подтверждения платежа магазином | +| public | [setConfirmation()](../classes/YooKassa-Model-Payment.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCreatedAt()](../classes/YooKassa-Model-Payment.md#method_setCreatedAt) | | Устанавливает время создания заказа | +| public | [setDescription()](../classes/YooKassa-Model-Payment.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setExpiresAt()](../classes/YooKassa-Model-Payment.md#method_setExpiresAt) | | Устанавливает время до которого можно бесплатно отменить или подтвердить платеж | +| public | [setId()](../classes/YooKassa-Model-Payment.md#method_setId) | | Устанавливает идентификатор платежа | +| public | [setIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_setIncomeAmount) | | Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [setMetadata()](../classes/YooKassa-Model-Payment.md#method_setMetadata) | | Устанавливает метаданные платежа | +| public | [setPaid()](../classes/YooKassa-Model-Payment.md#method_setPaid) | | Устанавливает флаг оплаты заказа | +| public | [setPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_setPaymentMethod) | | Устанавливает используемый способ проведения платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_setReceiptRegistration) | | Устанавливает состояние регистрации фискального чека | +| public | [setRecipient()](../classes/YooKassa-Model-Payment.md#method_setRecipient) | | Устанавливает получателя платежа | +| public | [setRefundable()](../classes/YooKassa-Model-Payment.md#method_setRefundable) | | Устанавливает возможность провести возврат по API | +| public | [setRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_setRefundedAmount) | | Устанавливает сумму возвращенных средств | +| public | [setRequestor()](../classes/YooKassa-Model-Payment.md#method_setRequestor) | | Устанавливает инициатора платежа | +| public | [setStatus()](../classes/YooKassa-Model-Payment.md#method_setStatus) | | Устанавливает статус платежа | +| public | [setTest()](../classes/YooKassa-Model-Payment.md#method_setTest) | | Устанавливает признак тестовой операции | +| public | [setTransfers()](../classes/YooKassa-Model-Payment.md#method_setTransfers) | | Устанавливает массив распределения денег между магазинами | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Payment.php](../../lib/Model/Payment.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Payment +* Implements: + * [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) +--- +## Constants + +###### MAX_LENGTH_DESCRIPTION +Максимальная длина строки описания платежа + +```php +MAX_LENGTH_DESCRIPTION = 128 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма заказа + +**Type:** AmountInterface + +**Details:** + + + +#### public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** + + + +#### public $authorizationDetails : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** + + + +#### public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** + + + +#### public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** + + + +#### public $captured_at : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** + + + +#### public $capturedAt : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** + + + +#### public $confirmation : \YooKassa\Model\Confirmation\AbstractConfirmation +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmation + +**Details:** + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** + + + +#### public $expires_at : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** + + + +#### public $expiresAt : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** + + + +#### public $income_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** + + + +#### public $incomeAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные платежа указанные мерчантом + +**Type:** Metadata + +**Details:** + + + +#### public $paid : bool +--- +***Description*** + +Признак оплаты заказа + +**Type:** bool + +**Details:** + + + +#### public $payment_method : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** + + + +#### public $paymentMethod : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** + + + +#### public $receipt_registration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** + + + +#### public $receiptRegistration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа + +**Type:** RecipientInterface + +**Details:** + + + +#### public $refundable : bool +--- +***Description*** + +Возможность провести возврат по API + +**Type:** bool + +**Details:** + + + +#### public $refunded_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** + + + +#### public $refundedAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** + + + +#### public $requestor : \YooKassa\Model\Requestor +--- +***Description*** + +Инициатор платежа + +**Type:** Requestor + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Текущее состояние платежа + +**Type:** string + +**Details:** + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции + +**Type:** bool + +**Details:** + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount +``` + +**Summary** + +Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Проверяет возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Возможность провести возврат по API, true если есть, false если нет + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setAuthorizationDetails() : mixed + +```php +public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AuthorizationDetailsInterface | value | Данные об авторизации платежа | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : mixed + +```php +public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\CancellationDetailsInterface | value | Комментарий к статусу canceled | + +**Returns:** mixed - + + + +#### public setCapturedAt() : mixed + +```php +public setCapturedAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время подтверждения платежа магазином + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения платежа магазином | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасвается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Confirmation\AbstractConfirmation | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime|string|int value) : mixed +``` + +**Summary** + +Устанавливает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | value | Время создания заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setExpiresAt() : mixed + +```php +public setExpiresAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время до которого можно бесплатно отменить или подтвердить платеж + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время, до которого можно бесплатно отменить или подтвердить платеж | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setIncomeAmount() : mixed + +```php +public setIncomeAmount(\YooKassa\Model\MonetaryAmount amount) : mixed +``` + +**Summary** + +Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\MonetaryAmount | amount | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata value) : mixed +``` + +**Summary** + +Устанавливает метаданные платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata | value | Метаданные платежа указанные мерчантом | + +**Returns:** mixed - + + + +#### public setPaid() : mixed + +```php +public setPaid(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак оплаты заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod value) : mixed +``` + +**Summary** + +Устанавливает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\AbstractPaymentMethod | value | Способ проведения платежа | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface value) : mixed +``` + +**Summary** + +Устанавливает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface | value | Объект с информацией о получателе платежа | + +**Returns:** mixed - + + + +#### public setRefundable() : mixed + +```php +public setRefundable(bool value) : mixed +``` + +**Summary** + +Устанавливает возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность провести возврат по API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setRefundedAmount() : mixed + +```php +public setRefundedAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возвращенных средств платежа | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setTest() : mixed + +```php +public setTest(bool test) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md b/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md new file mode 100644 index 00000000..efe38487 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-AbstractPaymentData.md @@ -0,0 +1,381 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Model\PaymentData\AbstractPaymentData +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Данные используемые для создания метода оплаты. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/AbstractPaymentData.php](../../lib/Model/PaymentData/AbstractPaymentData.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PaymentData\AbstractPaymentData +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md new file mode 100644 index 00000000..34de46b4 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md @@ -0,0 +1,501 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\B2b\Sberbank\VatData +### Namespace: [\YooKassa\Model\PaymentData\B2b\Sberbank](../namespaces/yookassa-model-paymentdata-b2b-sberbank.md) +--- +**Summary:** + +Данные об НДС + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#property_amount) | | Сумма НДС | +| public | [$rate](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#property_rate) | | Данные об НДС в случае, если сумма НДС включена в сумму платежа | +| public | [$type](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#property_type) | | Способ расчёта НДС | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method___construct) | | VatData constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_getAmount) | | Возвращает сумму НДС | +| public | [getRate()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_getRate) | | Возвращает налоговую ставку НДС | +| public | [getType()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_getType) | | Возвращает способ расчёта НДС | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_setAmount) | | Устанавливает сумму НДС | +| public | [setRate()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_setRate) | | Устанавливает налоговую ставку НДС | +| public | [setType()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md#method_setType) | | Устанавливает способ расчёта НДС | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/B2b/Sberbank/VatData.php](../../lib/Model/PaymentData/B2b/Sberbank/VatData.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PaymentData\B2b\Sberbank\VatData +* Implements: + * [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataInterface](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md) +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма НДС + +**Type:** AmountInterface + +**Details:** + + + +#### public $rate : string +--- +***Description*** + +Данные об НДС в случае, если сумма НДС включена в сумму платежа + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Способ расчёта НДС + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(string|null type = null, string|null rate = null, \YooKassa\Model\AmountInterface|null amount = null) : mixed +``` + +**Summary** + +VatData constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | type | Способ расчёта НДС | +| string OR null | rate | Налоговая ставка НДС | +| \YooKassa\Model\AmountInterface OR null | amount | Сумма НДС | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма НДС + + + +#### public getRate() : string + +```php +public getRate() : string +``` + +**Summary** + +Возвращает налоговую ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) + +**Returns:** string - Налоговая ставка НДС + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает способ расчёта НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) + +**Returns:** string - Способ расчёта НДС + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|null value) : mixed +``` + +**Summary** + +Устанавливает сумму НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR null | value | Сумма НДС | + +**Returns:** mixed - + + + +#### public setRate() : mixed + +```php +public setRate(string value) : mixed +``` + +**Summary** + +Устанавливает налоговую ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Налоговая ставка НДС | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидной ставкой | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает способ расчёта НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Способ расчёта НДС | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным способом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md new file mode 100644 index 00000000..5375ed95 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md @@ -0,0 +1,104 @@ +# [YooKassa API SDK](../home.md) + +# Interface: VatDataInterface +### Namespace: [\YooKassa\Model\PaymentData\B2b\Sberbank](../namespaces/yookassa-model-paymentdata-b2b-sberbank.md) +--- +**Summary:** + +Interface VatDataInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md#method_getAmount) | | Возвращает сумму НДС | +| public | [getRate()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md#method_getRate) | | Возвращает данные об НДС | +| public | [getType()](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md#method_getType) | | Возвращает способ расчёта НДС | + +--- +### Details +* File: [lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php](../../lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Способ расчёта НДС | +| property-read | | Данные об НДС в случае, если сумма НДС включена в сумму платежа | +| property-read | | Сумма НДС | +--- +## Methods + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает способ расчёта НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataInterface](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md) + +**Returns:** string - Способ расчёта НДС + + + +#### public getRate() : string + +```php +public getRate() : string +``` + +**Summary** + +Возвращает данные об НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataInterface](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md) + +**Returns:** string - Данные об НДС + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму НДС + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataInterface](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма НДС + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md new file mode 100644 index 00000000..9837e934 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md @@ -0,0 +1,167 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\B2b\Sberbank\VatDataRate +### Namespace: [\YooKassa\Model\PaymentData\B2b\Sberbank](../namespaces/yookassa-model-paymentdata-b2b-sberbank.md) +--- +**Summary:** + +PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС +|Код|Описание| +--- | --- +|7|7%| +|10|10%| +|18|18%| +|20|20%| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [RATE_7](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md#constant_RATE_7) | | 7% | +| public | [RATE_10](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md#constant_RATE_10) | | 10% | +| public | [RATE_18](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md#constant_RATE_18) | | 18% | +| public | [RATE_20](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md#constant_RATE_20) | | 20% | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php](../../lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PaymentData\B2b\Sberbank\VatDataRate +--- +## Constants + +###### RATE_7 +7% + +```php +RATE_7 = '7' +``` + + + +###### RATE_10 +10% + +```php +RATE_10 = '10' +``` + + + +###### RATE_18 +18% + +```php +RATE_18 = '18' +``` + + + +###### RATE_20 +20% + +```php +RATE_20 = '20' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md new file mode 100644 index 00000000..f136cc92 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md @@ -0,0 +1,156 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\B2b\Sberbank\VatDataType +### Namespace: [\YooKassa\Model\PaymentData\B2b\Sberbank](../namespaces/yookassa-model-paymentdata-b2b-sberbank.md) +--- +**Summary:** + +PaymentDataB2bSberbankVatDataType - Способ расчёта НДС +|Код|Описание| +--- | --- +|calculated|Сумма НДС включена в сумму платежа| +|mixed|Разные ставки НДС для разных товаров| +|untaxed|Сумма платежа НДС не облагается| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [CALCULATED](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md#constant_CALCULATED) | | Сумма НДС включена в сумму платежа | +| public | [MIXED](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md#constant_MIXED) | | Разные ставки НДС для разных товаров | +| public | [UNTAXED](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md#constant_UNTAXED) | | Сумма платежа НДС не облагается | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/PaymentData/B2b/Sberbank/VatDataType.php](../../lib/Model/PaymentData/B2b/Sberbank/VatDataType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PaymentData\B2b\Sberbank\VatDataType +--- +## Constants + +###### CALCULATED +Сумма НДС включена в сумму платежа + +```php +CALCULATED = 'calculated' +``` + + + +###### MIXED +Разные ставки НДС для разных товаров + +```php +MIXED = 'mixed' +``` + + + +###### UNTAXED +Сумма платежа НДС не облагается + +```php +UNTAXED = 'untaxed' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md new file mode 100644 index 00000000..dc432948 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md @@ -0,0 +1,429 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataAlfabank +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataAlfabank +Платежные данные для проведения оплаты через Альфа Клик или Альфа Молнию. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$login](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md#property_login) | | Имя пользователя в Альфа-Клике | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getLogin()](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md#method_getLogin) | | Возвращает имя пользователя в Альфа-Клике | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setLogin()](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md#method_setLogin) | | Устанавливает имя пользователя в Альфа-Клике | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataAlfabank.php](../../lib/Model/PaymentData/PaymentDataAlfabank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataAlfabank +--- +## Properties + +#### public $login : string +--- +***Description*** + +Имя пользователя в Альфа-Клике + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataAlfabank](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getLogin() : string + +```php +public getLogin() : string +``` + +**Summary** + +Возвращает имя пользователя в Альфа-Клике + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataAlfabank](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md) + +**Returns:** string - Имя пользователя в Альфа-Клике + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setLogin() : mixed + +```php +public setLogin(string value) : mixed +``` + +**Summary** + +Устанавливает имя пользователя в Альфа-Клике + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataAlfabank](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Имя пользователя в Альфа-Клике | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md new file mode 100644 index 00000000..72d6a390 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md @@ -0,0 +1,455 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataApplePay +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataApplePay +Платежные данные для проведения оплаты при помощи Apple Pay + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$payment_data](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#property_payment_data) | | содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | +| public | [$paymentData](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#property_paymentData) | | содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | +| public | [$type](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#property_type) | | Тип объекта | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getPaymentData()](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#method_getPaymentData) | | Возвращает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setPaymentData()](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md#method_setPaymentData) | | Устанавливает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataApplePay.php](../../lib/Model/PaymentData/PaymentDataApplePay.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataApplePay +--- +## Properties + +#### public $payment_data : string +--- +***Description*** + +содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 + +**Type:** string + +**Details:** + + + +#### public $paymentData : string +--- +***Description*** + +содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataApplePay](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getPaymentData() : string + +```php +public getPaymentData() : string +``` + +**Summary** + +Возвращает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataApplePay](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md) + +**Returns:** string - содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setPaymentData() : mixed + +```php +public setPaymentData(string value) : mixed +``` + +**Summary** + +Устанавливает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataApplePay](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md new file mode 100644 index 00000000..4cbf0134 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md @@ -0,0 +1,482 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataB2bSberbank +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataB2BSberbank +Платежные данные для проведения оплаты при помощи Сбербанк Бизнес Онлайн. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$paymentPurpose](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#property_paymentPurpose) | | Назначение платежа | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +| public | [$vatData](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#property_vatData) | | Данные об НДС | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getPaymentPurpose()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_getPaymentPurpose) | | Возвращает назначение платежа | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [getVatData()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_getVatData) | | Возвращает назначение платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setPaymentPurpose()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_setPaymentPurpose) | | Устанавливает назначение платежа | +| public | [setVatData()](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md#method_setVatData) | | Устанавливает назначение платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataB2bSberbank.php](../../lib/Model/PaymentData/PaymentDataB2bSberbank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataB2bSberbank +--- +## Properties + +#### public $paymentPurpose : string +--- +***Description*** + +Назначение платежа + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +#### public $vatData : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData +--- +***Description*** + +Данные об НДС + +**Type:** VatData + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataB2bSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getPaymentPurpose() : string + +```php +public getPaymentPurpose() : string +``` + +**Summary** + +Возвращает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataB2bSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md) + +**Returns:** string - Назначение платежа + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public getVatData() : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData + +```php +public getVatData() : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData +``` + +**Summary** + +Возвращает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataB2bSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md) + +**Returns:** \YooKassa\Model\PaymentData\B2b\Sberbank\VatData - Данные об НДС + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setPaymentPurpose() : mixed + +```php +public setPaymentPurpose(string value) : mixed +``` + +**Summary** + +Устанавливает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataB2bSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Назначение платежа | + +**Returns:** mixed - + + + +#### public setVatData() : mixed + +```php +public setVatData(\YooKassa\Model\PaymentData\B2b\Sberbank\VatData|array|null value) : mixed +``` + +**Summary** + +Устанавливает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataB2bSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentData\B2b\Sberbank\VatData OR array OR null | value | Данные об НДС | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md new file mode 100644 index 00000000..fd27fcad --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md @@ -0,0 +1,429 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataBankCard +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataBankCard +Платежные данные для проведения оплаты при помощи банковской карты + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$card](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md#property_card) | | Данные банковской карты | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCard()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md#method_getCard) | | Возвращает данные банковской карты | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCard()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md#method_setCard) | | Устанавливает данные банковской карты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataBankCard.php](../../lib/Model/PaymentData/PaymentDataBankCard.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataBankCard +--- +## Properties + +#### public $card : \YooKassa\Model\PaymentData\PaymentDataBankCardCard +--- +***Description*** + +Данные банковской карты + +**Type:** PaymentDataBankCardCard + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCard() : \YooKassa\Model\PaymentData\PaymentDataBankCardCard + +```php +public getCard() : \YooKassa\Model\PaymentData\PaymentDataBankCardCard +``` + +**Summary** + +Возвращает данные банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md) + +**Returns:** \YooKassa\Model\PaymentData\PaymentDataBankCardCard - Данные банковской карты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCard() : mixed + +```php +public setCard(\YooKassa\Model\PaymentData\PaymentDataBankCardCard|array value) : mixed +``` + +**Summary** + +Устанавливает данные банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentData\PaymentDataBankCardCard OR array | value | Данные банковской карты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md new file mode 100644 index 00000000..1888d74a --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md @@ -0,0 +1,620 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataBankCardCard +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Данные банковской карты +Необходим при оплате PCI-DSS данными. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$cardholder](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_cardholder) | | Имя держателя карты | +| public | [$csc](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_csc) | | CVV2/CVC2 код | +| public | [$expiry_month](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_expiry_month) | | Срок действия, месяц, MM | +| public | [$expiry_year](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_expiry_year) | | Срок действия, год, YY | +| public | [$expiryMonth](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_expiryMonth) | | Срок действия, месяц, MM | +| public | [$expiryYear](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_expiryYear) | | Срок действия, год, YY | +| public | [$number](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#property_number) | | Номер банковской карты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCardholder()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getCardholder) | | Возвращает имя держателя карты | +| public | [getCsc()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getCsc) | | Возвращает CVV2/CVC2 код | +| public | [getExpiryMonth()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getExpiryMonth) | | Возвращает месяц срока действия карты | +| public | [getExpiryYear()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getExpiryYear) | | Возвращает год срока действия карты | +| public | [getNumber()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_getNumber) | | Возвращает номер банковской карты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCardholder()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setCardholder) | | Устанавливает имя держателя карты | +| public | [setCsc()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setCsc) | | Устанавливает CVV2/CVC2 код | +| public | [setExpiryMonth()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setExpiryMonth) | | Устанавливает месяц срока действия карты | +| public | [setExpiryYear()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setExpiryYear) | | Устанавливает год срока действия карты | +| public | [setNumber()](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md#method_setNumber) | | Устанавливает номер банковской карты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataBankCardCard.php](../../lib/Model/PaymentData/PaymentDataBankCardCard.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PaymentData\PaymentDataBankCardCard +--- +## Properties + +#### public $cardholder : string +--- +***Description*** + +Имя держателя карты + +**Type:** string + +**Details:** + + + +#### public $csc : string +--- +***Description*** + +CVV2/CVC2 код + +**Type:** string + +**Details:** + + + +#### public $expiry_month : string +--- +***Description*** + +Срок действия, месяц, MM + +**Type:** string + +**Details:** + + + +#### public $expiry_year : string +--- +***Description*** + +Срок действия, год, YY + +**Type:** string + +**Details:** + + + +#### public $expiryMonth : string +--- +***Description*** + +Срок действия, месяц, MM + +**Type:** string + +**Details:** + + + +#### public $expiryYear : string +--- +***Description*** + +Срок действия, год, YY + +**Type:** string + +**Details:** + + + +#### public $number : string +--- +***Description*** + +Номер банковской карты + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCardholder() : string + +```php +public getCardholder() : string +``` + +**Summary** + +Возвращает имя держателя карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) + +**Returns:** string - Имя держателя карты + + + +#### public getCsc() : string + +```php +public getCsc() : string +``` + +**Summary** + +Возвращает CVV2/CVC2 код + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) + +**Returns:** string - CVV2/CVC2 код + + + +#### public getExpiryMonth() : string + +```php +public getExpiryMonth() : string +``` + +**Summary** + +Возвращает месяц срока действия карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) + +**Returns:** string - Срок действия, месяц, MM + + + +#### public getExpiryYear() : string + +```php +public getExpiryYear() : string +``` + +**Summary** + +Возвращает год срока действия карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) + +**Returns:** string - Срок действия, год, YYYY + + + +#### public getNumber() : string + +```php +public getNumber() : string +``` + +**Summary** + +Возвращает номер банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) + +**Returns:** string - Номер банковской карты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCardholder() : mixed + +```php +public setCardholder(string value) : mixed +``` + +**Summary** + +Устанавливает имя держателя карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Имя держателя карты | + +**Returns:** mixed - + + + +#### public setCsc() : mixed + +```php +public setCsc(string value) : mixed +``` + +**Summary** + +Устанавливает CVV2/CVC2 код + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | CVV2/CVC2 код | + +**Returns:** mixed - + + + +#### public setExpiryMonth() : mixed + +```php +public setExpiryMonth(string value) : mixed +``` + +**Summary** + +Устанавливает месяц срока действия карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Срок действия, месяц, MM | + +**Returns:** mixed - + + + +#### public setExpiryYear() : mixed + +```php +public setExpiryYear(string value) : mixed +``` + +**Summary** + +Устанавливает год срока действия карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Срок действия, год, YYYY | + +**Returns:** mixed - + + + +#### public setNumber() : mixed + +```php +public setNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер банковской карты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md new file mode 100644 index 00000000..dd9b4e1c --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataCash.md @@ -0,0 +1,429 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataCash +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataCash +Платежные данные для проведения оплаты Qiwi. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$phone](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md#property_phone) | | Номер телефона в формате ITU-T E.164 | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataCash.php](../../lib/Model/PaymentData/PaymentDataCash.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataCash +--- +## Properties + +#### public $phone : string +--- +***Description*** + +Номер телефона в формате ITU-T E.164 + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataCash](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataCash](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md) + +**Returns:** string - Номер телефона в формате ITU-T E.164 + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataCash](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер телефона в формате ITU-T E.164 | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md new file mode 100644 index 00000000..158128db --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataFactory.md @@ -0,0 +1,89 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataFactory +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Фабрика создания объекта платежных данных из массива + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Model-PaymentData-PaymentDataFactory.md#method_factory) | | Фабричный метод создания объекта платежных данных по типу | +| public | [factoryFromArray()](../classes/YooKassa-Model-PaymentData-PaymentDataFactory.md#method_factoryFromArray) | | Фабричный метод создания объекта платежных данных из массива | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataFactory.php](../../lib/Model/PaymentData/PaymentDataFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Model\PaymentData\PaymentDataFactory + +--- +## Methods + +#### public factory() : \YooKassa\Model\PaymentData\AbstractPaymentData + +```php +public factory(string type) : \YooKassa\Model\PaymentData\AbstractPaymentData +``` + +**Summary** + +Фабричный метод создания объекта платежных данных по типу + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataFactory](../classes/YooKassa-Model-PaymentData-PaymentDataFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип платежных данных | + +**Returns:** \YooKassa\Model\PaymentData\AbstractPaymentData - + + + +#### public factoryFromArray() : \YooKassa\Model\PaymentData\AbstractPaymentData + +```php +public factoryFromArray(array data, string|null type = null) : \YooKassa\Model\PaymentData\AbstractPaymentData +``` + +**Summary** + +Фабричный метод создания объекта платежных данных из массива + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataFactory](../classes/YooKassa-Model-PaymentData-PaymentDataFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | Массив платежных данных | +| string OR null | type | Тип платежных данных | + +**Returns:** \YooKassa\Model\PaymentData\AbstractPaymentData - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md new file mode 100644 index 00000000..4e98e6cf --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md @@ -0,0 +1,482 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataGooglePay +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataGooglePay +Платежные данные для проведения оплаты при помощи Google Pay. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$googleTransactionId](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#property_googleTransactionId) | | Уникальный идентификатор транзакции, выданный Google | +| public | [$paymentMethodToken](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#property_paymentMethodToken) | | Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getGoogleTransactionId()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_getGoogleTransactionId) | | Возвращает уникальный идентификатор транзакции, выданный Google | +| public | [getPaymentMethodToken()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_getPaymentMethodToken) | | Возвращает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setGoogleTransactionId()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_setGoogleTransactionId) | | Устанавливает уникальный идентификатор транзакции, выданный Google | +| public | [setPaymentMethodToken()](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md#method_setPaymentMethodToken) | | Устанавливает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataGooglePay.php](../../lib/Model/PaymentData/PaymentDataGooglePay.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataGooglePay +--- +## Properties + +#### public $googleTransactionId : string +--- +***Description*** + +Уникальный идентификатор транзакции, выданный Google + +**Type:** string + +**Details:** + + + +#### public $paymentMethodToken : string +--- +***Description*** + +Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataGooglePay](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getGoogleTransactionId() : string + +```php +public getGoogleTransactionId() : string +``` + +**Summary** + +Возвращает уникальный идентификатор транзакции, выданный Google + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataGooglePay](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md) + +**Returns:** string - Уникальный идентификатор транзакции, выданный Google + + + +#### public getPaymentMethodToken() : string + +```php +public getPaymentMethodToken() : string +``` + +**Summary** + +Возвращает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataGooglePay](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md) + +**Returns:** string - Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setGoogleTransactionId() : mixed + +```php +public setGoogleTransactionId(string value) : mixed +``` + +**Summary** + +Устанавливает уникальный идентификатор транзакции, выданный Google + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataGooglePay](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Уникальный идентификатор транзакции, выданный Google | + +**Returns:** mixed - + + + +#### public setPaymentMethodToken() : mixed + +```php +public setPaymentMethodToken(string value) : mixed +``` + +**Summary** + +Устанавливает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataGooglePay](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md new file mode 100644 index 00000000..9316e770 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md @@ -0,0 +1,375 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataInstallments +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Данные для проведения оплаты по частям + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataInstallments.php](../../lib/Model/PaymentData/PaymentDataInstallments.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataInstallments +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataInstallments](../classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md new file mode 100644 index 00000000..2d35eb59 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md @@ -0,0 +1,425 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataMobileBalance +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataMobileBalance +Платежные данные для проведения оплаты Qiwi. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$phone](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md#property_phone) | | | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataMobileBalance.php](../../lib/Model/PaymentData/PaymentDataMobileBalance.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataMobileBalance +--- +## Properties + +#### public $phone : string +--- +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataMobileBalance](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataMobileBalance](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataMobileBalance](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md new file mode 100644 index 00000000..d826f646 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md @@ -0,0 +1,416 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataQiwi +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataQiwi +Платежные данные для проведения оплаты Qiwi. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataQiwi.php](../../lib/Model/PaymentData/PaymentDataQiwi.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataQiwi +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataQiwi](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataQiwi](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataQiwi](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md new file mode 100644 index 00000000..765dbef1 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md @@ -0,0 +1,425 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataSberbank +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataSberbank +Платежные данные для проведения оплаты при помощи Сбербанк Онлайн. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$phone](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md#property_phone) | | | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setPhone()](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataSberbank.php](../../lib/Model/PaymentData/PaymentDataSberbank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataSberbank +--- +## Properties + +#### public $phone : string +--- +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md) + +**Returns:** string - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md new file mode 100644 index 00000000..a2ba2500 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md @@ -0,0 +1,375 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataTinkoffBank +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Данные используемые для создания метода оплаты. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataTinkoffBank.php](../../lib/Model/PaymentData/PaymentDataTinkoffBank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataTinkoffBank +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataTinkoffBank](../classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md new file mode 100644 index 00000000..02f34755 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md @@ -0,0 +1,376 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataWebmoney +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +PaymentDataWebmoney +Платежные данные для проведения оплаты Webmoney. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataWebmoney.php](../../lib/Model/PaymentData/PaymentDataWebmoney.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataWebmoney +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataWebmoney](../classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md new file mode 100644 index 00000000..96fe1196 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataWechat.md @@ -0,0 +1,380 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataWechat +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Данные используемые для создания метода оплаты. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataWechat.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataWechat.php](../../lib/Model/PaymentData/PaymentDataWechat.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataWechat +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| deprecated | | Класс будет удалён в одной из будущих версий. | +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataWechat](../classes/YooKassa-Model-PaymentData-PaymentDataWechat.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md b/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md new file mode 100644 index 00000000..cde57783 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md @@ -0,0 +1,375 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentData\PaymentDataYooMoney +### Namespace: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +--- +**Summary:** + +Данные для проведения оплаты через ЮMoney + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$type](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#property_type) | | Тип метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method_getType) | | Возвращает тип метода оплаты | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md#method__setType) | | Устанавливает тип метода оплаты | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentData/PaymentDataYooMoney.php](../../lib/Model/PaymentData/PaymentDataYooMoney.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + * \YooKassa\Model\PaymentData\PaymentDataYooMoney +--- +## Properties + +#### public $type : string +--- +***Description*** + +Тип метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\PaymentDataYooMoney](../classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) + +**Returns:** string - Тип метода оплаты + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип метода оплаты | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentInterface.md b/docs/classes/YooKassa-Model-PaymentInterface.md new file mode 100644 index 00000000..9332f017 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentInterface.md @@ -0,0 +1,431 @@ +# [YooKassa API SDK](../home.md) + +# Interface: PaymentInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface PaymentInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Model-PaymentInterface.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-PaymentInterface.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-PaymentInterface.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-PaymentInterface.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-PaymentInterface.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-PaymentInterface.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getExpiresAt()](../classes/YooKassa-Model-PaymentInterface.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-PaymentInterface.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-PaymentInterface.md#method_getIncomeAmount) | | Возвращает сумму перечисляемая магазину за вычетом комиссий платежной системы.(только для успешных платежей) | +| public | [getMetadata()](../classes/YooKassa-Model-PaymentInterface.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-PaymentInterface.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-PaymentInterface.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-PaymentInterface.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-PaymentInterface.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-PaymentInterface.md#method_getRefundable) | | Возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-PaymentInterface.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-PaymentInterface.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-PaymentInterface.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTransfers()](../classes/YooKassa-Model-PaymentInterface.md#method_getTransfers) | | Возвращает данные о распределении платежа между магазинами | + +--- +### Details +* File: [lib/Model/PaymentInterface.php](../../lib/Model/PaymentInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Идентификатор платежа | +| property-read | | Текущее состояние платежа | +| property-read | | Получатель платежа | +| property-read | | Сумма заказа | +| property-read | | Описание транзакции | +| property-read | | Способ проведения платежа | +| property-read | | Способ проведения платежа | +| property-read | | Время создания заказа | +| property-read | | Время создания заказа | +| property-read | | Время подтверждения платежа магазином | +| property-read | | Время подтверждения платежа магазином | +| property-read | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| property-read | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| property-read | | Способ подтверждения платежа | +| property-read | | Сумма возвращенных средств платежа | +| property-read | | Сумма возвращенных средств платежа | +| property-read | | Признак оплаты заказа | +| property-read | | Возможность провести возврат по API | +| property-read | | Состояние регистрации фискального чека | +| property-read | | Состояние регистрации фискального чека | +| property-read | | Метаданные платежа указанные мерчантом | +| property-read | | Признак тестовой операции | +| property-read | | Комментарий к отмене платежа | +| property-read | | Комментарий к отмене платежа | +| property-read | | Данные об авторизации платежа | +| property-read | | Данные об авторизации платежа | +| property-read | | Данные о распределении платежа между магазинами | +| property-read | | Сумма платежа, которую получит магазин | +| property-read | | Сумма платежа, которую получит магазин | +| property-read | | Инициатор платежа | +--- +## Methods + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** bool - Возможность провести возврат по API + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении платежа между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount|null + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount|null +``` + +**Summary** + +Возвращает сумму перечисляемая магазину за вычетом комиссий платежной системы.(только для успешных платежей) + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\MonetaryAmount|null - + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md b/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md new file mode 100644 index 00000000..38ad99df --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md @@ -0,0 +1,527 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Абстрактный класс, описывающий основные свойства и методы платежных методов + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/AbstractPaymentMethod.php](../../lib/Model/PaymentMethod/AbstractPaymentMethod.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md new file mode 100644 index 00000000..b3dd6079 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md @@ -0,0 +1,807 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails +### Namespace: [\YooKassa\Model\PaymentMethod\B2b\Sberbank](../namespaces/yookassa-model-paymentmethod-b2b-sberbank.md) +--- +**Summary:** + +Банковские реквизиты плательщика + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$account](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_account) | | Номер счета организации | +| public | [$address](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_address) | | Адрес организации | +| public | [$bankBik](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_bankBik) | | БИК банка организации | +| public | [$bankBranch](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_bankBranch) | | Отделение банка организации | +| public | [$bankName](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_bankName) | | Наименование банка организации | +| public | [$fullName](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_fullName) | | Полное наименование организации | +| public | [$inn](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_inn) | | ИНН организации | +| public | [$kpp](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_kpp) | | КПП организации | +| public | [$shortName](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#property_shortName) | | Сокращенное наименование организации | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAccount()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getAccount) | | Возвращает номер счета организации | +| public | [getAddress()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getAddress) | | Возвращает адрес организации | +| public | [getBankBik()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getBankBik) | | Возвращает БИК банка организации | +| public | [getBankBranch()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getBankBranch) | | Возвращает отделение банка организации | +| public | [getBankName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getBankName) | | Возвращает наименование банка организации | +| public | [getFullName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getFullName) | | Возвращает полное наименование организации | +| public | [getInn()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getInn) | | Возвращает ИНН организации | +| public | [getKpp()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getKpp) | | Возвращает КПП организации | +| public | [getShortName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_getShortName) | | Возвращает сокращенное наименование организации | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAccount()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setAccount) | | Устанавливает номер счета организации | +| public | [setAddress()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setAddress) | | Устанавливает адрес организации | +| public | [setBankBik()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setBankBik) | | Устанавливает БИК банка организации | +| public | [setBankBranch()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setBankBranch) | | Устанавливает отделение банка организации | +| public | [setBankName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setBankName) | | Устанавливает наименование банка организации | +| public | [setFullName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setFullName) | | Устанавливает полное наименование организации | +| public | [setInn()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setInn) | | Устанавливает ИНН организации | +| public | [setKpp()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setKpp) | | Устанавливает КПП организации | +| public | [setShortName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md#method_setShortName) | | Устанавливает сокращенное наименование организации | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php](../../lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails +* Implements: + * [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) +--- +## Properties + +#### public $account : string +--- +***Description*** + +Номер счета организации + +**Type:** string + +**Details:** + + + +#### public $address : string +--- +***Description*** + +Адрес организации + +**Type:** string + +**Details:** + + + +#### public $bankBik : string +--- +***Description*** + +БИК банка организации + +**Type:** string + +**Details:** + + + +#### public $bankBranch : string +--- +***Description*** + +Отделение банка организации + +**Type:** string + +**Details:** + + + +#### public $bankName : string +--- +***Description*** + +Наименование банка организации + +**Type:** string + +**Details:** + + + +#### public $fullName : string +--- +***Description*** + +Полное наименование организации + +**Type:** string + +**Details:** + + + +#### public $inn : string +--- +***Description*** + +ИНН организации + +**Type:** string + +**Details:** + + + +#### public $kpp : string +--- +***Description*** + +КПП организации + +**Type:** string + +**Details:** + + + +#### public $shortName : string +--- +***Description*** + +Сокращенное наименование организации + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAccount() : string + +```php +public getAccount() : string +``` + +**Summary** + +Возвращает номер счета организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - Номер счета организации + + + +#### public getAddress() : string + +```php +public getAddress() : string +``` + +**Summary** + +Возвращает адрес организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - Адрес организации + + + +#### public getBankBik() : string + +```php +public getBankBik() : string +``` + +**Summary** + +Возвращает БИК банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - БИК банка организации + + + +#### public getBankBranch() : string + +```php +public getBankBranch() : string +``` + +**Summary** + +Возвращает отделение банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - Отделение банка организации + + + +#### public getBankName() : string + +```php +public getBankName() : string +``` + +**Summary** + +Возвращает наименование банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - Наименование банка организации + + + +#### public getFullName() : string + +```php +public getFullName() : string +``` + +**Summary** + +Возвращает полное наименование организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - Полное наименование организации + + + +#### public getInn() : string + +```php +public getInn() : string +``` + +**Summary** + +Возвращает ИНН организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - ИНН организации + + + +#### public getKpp() : string + +```php +public getKpp() : string +``` + +**Summary** + +Возвращает КПП организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - КПП организации + + + +#### public getShortName() : string + +```php +public getShortName() : string +``` + +**Summary** + +Возвращает сокращенное наименование организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) + +**Returns:** string - Сокращенное наименование организации + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAccount() : mixed + +```php +public setAccount(string value) : mixed +``` + +**Summary** + +Устанавливает номер счета организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер счета организации | + +**Returns:** mixed - + + + +#### public setAddress() : mixed + +```php +public setAddress(string value) : mixed +``` + +**Summary** + +Устанавливает адрес организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Адрес организации | + +**Returns:** mixed - + + + +#### public setBankBik() : mixed + +```php +public setBankBik(string value) : mixed +``` + +**Summary** + +Устанавливает БИК банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | БИК банка организации | + +**Returns:** mixed - + + + +#### public setBankBranch() : mixed + +```php +public setBankBranch(string value) : mixed +``` + +**Summary** + +Устанавливает отделение банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Отделение банка организации | + +**Returns:** mixed - + + + +#### public setBankName() : mixed + +```php +public setBankName(string value) : mixed +``` + +**Summary** + +Устанавливает наименование банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Наименование банка организации | + +**Returns:** mixed - + + + +#### public setFullName() : mixed + +```php +public setFullName(string value) : mixed +``` + +**Summary** + +Устанавливает полное наименование организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Полное наименование организации | + +**Returns:** mixed - + + + +#### public setInn() : mixed + +```php +public setInn(string value) : mixed +``` + +**Summary** + +Устанавливает ИНН организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | ИНН организации | + +**Returns:** mixed - + + + +#### public setKpp() : mixed + +```php +public setKpp(string value) : mixed +``` + +**Summary** + +Устанавливает КПП организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | КПП организации | + +**Returns:** mixed - + + + +#### public setShortName() : mixed + +```php +public setShortName(string value) : mixed +``` + +**Summary** + +Устанавливает сокращенное наименование организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Сокращенное наименование организации | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md new file mode 100644 index 00000000..e3fe4f78 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md @@ -0,0 +1,218 @@ +# [YooKassa API SDK](../home.md) + +# Interface: PayerBankDetailsInterface +### Namespace: [\YooKassa\Model\PaymentMethod\B2b\Sberbank](../namespaces/yookassa-model-paymentmethod-b2b-sberbank.md) +--- +**Summary:** + +Interface PayerBankDetailsInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAccount()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getAccount) | | Возвращает номер счета организации | +| public | [getAddress()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getAddress) | | Возвращает адрес организации | +| public | [getBankBik()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getBankBik) | | Возвращает БИК банка организации | +| public | [getBankBranch()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getBankBranch) | | Возвращает отделение банка организации | +| public | [getBankName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getBankName) | | Возвращает наименование банка организации | +| public | [getFullName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getFullName) | | Возвращает полное наименование организации | +| public | [getInn()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getInn) | | Возвращает ИНН организации | +| public | [getKpp()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getKpp) | | Возвращает КПП организации | +| public | [getShortName()](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md#method_getShortName) | | Возвращает сокращенное наименование организации | + +--- +### Details +* File: [lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php](../../lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Полное наименование организации | +| property-read | | Сокращенное наименование организации | +| property-read | | Адрес организации | +| property-read | | ИНН организации | +| property-read | | КПП организации | +| property-read | | Наименование банка организации | +| property-read | | Отделение банка организации | +| property-read | | БИК банка организации | +| property-read | | Номер счета организации | +--- +## Methods + +#### public getFullName() : string + +```php +public getFullName() : string +``` + +**Summary** + +Возвращает полное наименование организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - Полное наименование организации + + + +#### public getShortName() : string + +```php +public getShortName() : string +``` + +**Summary** + +Возвращает сокращенное наименование организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - Сокращенное наименование организации + + + +#### public getAddress() : string + +```php +public getAddress() : string +``` + +**Summary** + +Возвращает адрес организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - Адрес организации + + + +#### public getInn() : string + +```php +public getInn() : string +``` + +**Summary** + +Возвращает ИНН организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - ИНН организации + + + +#### public getKpp() : string + +```php +public getKpp() : string +``` + +**Summary** + +Возвращает КПП организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - КПП организации + + + +#### public getBankName() : string + +```php +public getBankName() : string +``` + +**Summary** + +Возвращает наименование банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - Наименование банка организации + + + +#### public getBankBranch() : string + +```php +public getBankBranch() : string +``` + +**Summary** + +Возвращает отделение банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - Отделение банка организации + + + +#### public getBankBik() : string + +```php +public getBankBik() : string +``` + +**Summary** + +Возвращает БИК банка организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - БИК банка организации + + + +#### public getAccount() : string + +```php +public getAccount() : string +``` + +**Summary** + +Возвращает номер счета организации + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) + +**Returns:** string - Номер счета организации + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md b/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md new file mode 100644 index 00000000..9b1f21a8 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-BankCardSource.md @@ -0,0 +1,141 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\BankCardSource +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +BankCardSource - Источник данных банковской карты +|Код|Описание| +--- | --- +|apple_pay|Источник данных apple_pay| +|google_pay|Источник данных google_pay| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [APPLE_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_APPLE_PAY) | | | +| public | [GOOGLE_PAY](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#constant_GOOGLE_PAY) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/PaymentMethod/BankCardSource.php](../../lib/Model/PaymentMethod/BankCardSource.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PaymentMethod\BankCardSource +--- +## Constants + +###### APPLE_PAY +```php +APPLE_PAY = 'apple_pay' +``` + + + +###### GOOGLE_PAY +```php +GOOGLE_PAY = 'google_pay' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md new file mode 100644 index 00000000..5ef4d5c1 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md @@ -0,0 +1,589 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Альфа Банк + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$login](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md#property_login) | | Имя пользователя в Альфа-Клике | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getLogin()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md#method_getLogin) | | Возвращает имя пользователя в Альфа-Клике | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setLogin()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md#method_setLogin) | | Устанавливает имя пользователя в Альфа-Клике | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodAlfaBank.php](../../lib/Model/PaymentMethod/PaymentMethodAlfaBank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $login : string +--- +***Description*** + +Имя пользователя в Альфа-Клике + +**Type:** string + +**Details:** + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getLogin() : string + +```php +public getLogin() : string +``` + +**Summary** + +Возвращает имя пользователя в Альфа-Клике + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md) + +**Returns:** string - Имя пользователя в Альфа-Клике + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setLogin() : mixed + +```php +public setLogin(string value) : mixed +``` + +**Summary** + +Устанавливает имя пользователя в Альфа-Клике + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Имя пользователя в Альфа-Клике | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md new file mode 100644 index 00000000..c4d609f7 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md @@ -0,0 +1,536 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodApplePay +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Apple Pay + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodApplePay.php](../../lib/Model/PaymentMethod/PaymentMethodApplePay.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodApplePay +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodApplePay](../classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md new file mode 100644 index 00000000..ec848ca6 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md @@ -0,0 +1,708 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Сбербанк Бизнес Онлайн + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$payer_bank_details](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#property_payer_bank_details) | | Банковские реквизиты плательщика | +| public | [$payerBankDetails](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#property_payerBankDetails) | | Банковские реквизиты плательщика | +| public | [$payment_purpose](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#property_payment_purpose) | | Назначение платежа | +| public | [$paymentPurpose](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#property_paymentPurpose) | | Назначение платежа | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$vatData](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#property_vatData) | | Данные об НДС | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getPayerBankDetails()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_getPayerBankDetails) | | Возвращает банковские реквизиты плательщика (юридического лица или ИП) | +| public | [getPaymentPurpose()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_getPaymentPurpose) | | Возвращает назначение платежа | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [getVatData()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_getVatData) | | Возвращает назначение платежа | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setPayerBankDetails()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_setPayerBankDetails) | | Устанавливает Банковские реквизиты плательщика (юридического лица или ИП). | +| public | [setPaymentPurpose()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_setPaymentPurpose) | | Устанавливает назначение платежа | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [setVatData()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md#method_setVatData) | | Устанавливает назначение платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php](../../lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $payer_bank_details : \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails +--- +***Description*** + +Банковские реквизиты плательщика + +**Type:** PayerBankDetails + +**Details:** + + + +#### public $payerBankDetails : \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails +--- +***Description*** + +Банковские реквизиты плательщика + +**Type:** PayerBankDetails + +**Details:** + + + +#### public $payment_purpose : string +--- +***Description*** + +Назначение платежа + +**Type:** string + +**Details:** + + + +#### public $paymentPurpose : string +--- +***Description*** + +Назначение платежа + +**Type:** string + +**Details:** + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $vatData : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData +--- +***Description*** + +Данные об НДС + +**Type:** VatData + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getPayerBankDetails() : \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails + +```php +public getPayerBankDetails() : \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails +``` + +**Summary** + +Возвращает банковские реквизиты плательщика (юридического лица или ИП) + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) + +**Returns:** \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails - Банковские реквизиты плательщика + + + +#### public getPaymentPurpose() : string + +```php +public getPaymentPurpose() : string +``` + +**Summary** + +Возвращает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) + +**Returns:** string - Назначение платежа + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public getVatData() : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData + +```php +public getVatData() : \YooKassa\Model\PaymentData\B2b\Sberbank\VatData +``` + +**Summary** + +Возвращает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) + +**Returns:** \YooKassa\Model\PaymentData\B2b\Sberbank\VatData - Данные об НДС + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setPayerBankDetails() : mixed + +```php +public setPayerBankDetails(\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails|array payerBankDetails) : mixed +``` + +**Summary** + +Устанавливает Банковские реквизиты плательщика (юридического лица или ИП). + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails OR array | payerBankDetails | Банковские реквизиты плательщика | + +**Returns:** mixed - + + + +#### public setPaymentPurpose() : mixed + +```php +public setPaymentPurpose(string paymentPurpose) : mixed +``` + +**Summary** + +Устанавливает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | paymentPurpose | Назначение платежа | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public setVatData() : mixed + +```php +public setVatData(\YooKassa\Model\PaymentData\B2b\Sberbank\VatData vatData) : mixed +``` + +**Summary** + +Устанавливает назначение платежа + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentData\B2b\Sberbank\VatData | vatData | Данные об НДС | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md new file mode 100644 index 00000000..e9be5270 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md @@ -0,0 +1,1044 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodBankCard +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты банковской картой + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [ISO_3166_CODE_LENGTH](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#constant_ISO_3166_CODE_LENGTH) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$card_type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_card_type) | | Тип банковской карты | +| public | [$cardType](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_cardType) | | Тип банковской карты | +| public | [$expiry_month](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_expiry_month) | | Срок действия, месяц | +| public | [$expiry_year](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_expiry_year) | | Срок действия, год | +| public | [$expiryMonth](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_expiryMonth) | | Срок действия, месяц | +| public | [$expiryYear](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_expiryYear) | | Срок действия, год | +| public | [$first6](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_first6) | | Первые 6 цифр номера карты | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$issuer_country](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_issuer_country) | | Код страны, в которой выпущена карта | +| public | [$issuer_name](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_issuer_name) | | Тип банковской карты | +| public | [$issuerCountry](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_issuerCountry) | | Код страны, в которой выпущена карта | +| public | [$issuerName](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_issuerName) | | Тип банковской карты | +| public | [$last4](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_last4) | | Последние 4 цифры номера карты | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$source](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_source) | | Тип банковской карты | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCardType()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getCardType) | | Возвращает тип банковской карты | +| public | [getExpiryMonth()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getExpiryMonth) | | Возвращает срок действия, месяц | +| public | [getExpiryYear()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getExpiryYear) | | Возвращает срок действия, год | +| public | [getFirst6()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getFirst6) | | Возвращает первые 6 цифр номера карты | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getIssuerCountry()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getIssuerCountry) | | Возвращает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 | +| public | [getIssuerName()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getIssuerName) | | Возвращает наименование банка, выпустившего карту | +| public | [getLast4()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getLast4) | | Возвращает последние 4 цифры номера карты | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getSource()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_getSource) | | Возвращает источник данных банковской карты | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCardType()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setCardType) | | Устанавливает тип банковской карты | +| public | [setExpiryMonth()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setExpiryMonth) | | Устанавливает срок действия, месяц | +| public | [setExpiryYear()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setExpiryYear) | | Устанавливает срок действия, год | +| public | [setFirst6()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setFirst6) | | Устанавливает первые 6 цифр номера карты | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setIssuerCountry()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setIssuerCountry) | | Устанавливает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 | +| public | [setIssuerName()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setIssuerName) | | Устанавливает наименование банка, выпустившего карту | +| public | [setLast4()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setLast4) | | Устанавливает последние 4 цифры номера карты | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setSource()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md#method_setSource) | | Устанавливает источник данных банковской карты | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodBankCard.php](../../lib/Model/PaymentMethod/PaymentMethodBankCard.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodBankCard +--- +## Constants + +###### ISO_3166_CODE_LENGTH +```php +ISO_3166_CODE_LENGTH = 2 : string +``` + + +--- +## Properties + +#### public $card_type : string +--- +***Description*** + +Тип банковской карты + +**Type:** string + +**Details:** + + + +#### public $cardType : string +--- +***Description*** + +Тип банковской карты + +**Type:** string + +**Details:** + + + +#### public $expiry_month : string +--- +***Description*** + +Срок действия, месяц + +**Type:** string + +**Details:** + + + +#### public $expiry_year : string +--- +***Description*** + +Срок действия, год + +**Type:** string + +**Details:** + + + +#### public $expiryMonth : string +--- +***Description*** + +Срок действия, месяц + +**Type:** string + +**Details:** + + + +#### public $expiryYear : string +--- +***Description*** + +Срок действия, год + +**Type:** string + +**Details:** + + + +#### public $first6 : string +--- +***Description*** + +Первые 6 цифр номера карты + +**Type:** string + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $issuer_country : string +--- +***Description*** + +Код страны, в которой выпущена карта + +**Type:** string + +**Details:** + + + +#### public $issuer_name : string +--- +***Description*** + +Тип банковской карты + +**Type:** string + +**Details:** + + + +#### public $issuerCountry : string +--- +***Description*** + +Код страны, в которой выпущена карта + +**Type:** string + +**Details:** + + + +#### public $issuerName : string +--- +***Description*** + +Тип банковской карты + +**Type:** string + +**Details:** + + + +#### public $last4 : string +--- +***Description*** + +Последние 4 цифры номера карты + +**Type:** string + +**Details:** + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $source : string +--- +***Description*** + +Тип банковской карты + +**Type:** string + +**Details:** + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCardType() : string + +```php +public getCardType() : string +``` + +**Summary** + +Возвращает тип банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Тип банковской карты + + + +#### public getExpiryMonth() : string + +```php +public getExpiryMonth() : string +``` + +**Summary** + +Возвращает срок действия, месяц + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Срок действия, месяц + + + +#### public getExpiryYear() : string + +```php +public getExpiryYear() : string +``` + +**Summary** + +Возвращает срок действия, год + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Срок действия, год + + + +#### public getFirst6() : string + +```php +public getFirst6() : string +``` + +**Summary** + +Возвращает первые 6 цифр номера карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Первые 6 цифр номера карты + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.14 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getIssuerCountry() : string + +```php +public getIssuerCountry() : string +``` + +**Summary** + +Возвращает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Код страны, в которой выпущена карта + + + +#### public getIssuerName() : string + +```php +public getIssuerName() : string +``` + +**Summary** + +Возвращает наименование банка, выпустившего карту + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Наименование банка, выпустившего карту. + + + +#### public getLast4() : string + +```php +public getLast4() : string +``` + +**Summary** + +Возвращает последние 4 цифры номера карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Последние 4 цифры номера карты + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getSource() : string + +```php +public getSource() : string +``` + +**Summary** + +Возвращает источник данных банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) + +**Returns:** string - Источник данных банковской карты + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCardType() : mixed + +```php +public setCardType(string value) : mixed +``` + +**Summary** + +Устанавливает тип банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип банковской карты | + +**Returns:** mixed - + + + +#### public setExpiryMonth() : mixed + +```php +public setExpiryMonth(string value) : mixed +``` + +**Summary** + +Устанавливает срок действия, месяц + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Срок действия, месяц | + +**Returns:** mixed - + + + +#### public setExpiryYear() : mixed + +```php +public setExpiryYear(string value) : mixed +``` + +**Summary** + +Устанавливает срок действия, год + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Срок действия, год | + +**Returns:** mixed - + + + +#### public setFirst6() : mixed + +```php +public setFirst6(string value) : mixed +``` + +**Summary** + +Устанавливает первые 6 цифр номера карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Первые 6 цифр номера карты | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.14 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setIssuerCountry() : mixed + +```php +public setIssuerCountry(string value) : mixed +``` + +**Summary** + +Устанавливает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Код страны, в которой выпущена карта | + +**Returns:** mixed - + + + +#### public setIssuerName() : mixed + +```php +public setIssuerName(string value) : mixed +``` + +**Summary** + +Устанавливает наименование банка, выпустившего карту + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Наименование банка, выпустившего карту | + +**Returns:** mixed - + + + +#### public setLast4() : mixed + +```php +public setLast4(string value) : mixed +``` + +**Summary** + +Устанавливает последние 4 цифры номера карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Последние 4 цифры номера карты | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setSource() : mixed + +```php +public setSource(string value) : mixed +``` + +**Summary** + +Устанавливает источник данных банковской карты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Источник данных банковской карты | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md new file mode 100644 index 00000000..6cd2264c --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md @@ -0,0 +1,193 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodCardType +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Тип банковской карты. Возможные значения: +- `MasterCard` (для карт Mastercard и Maestro), +- `Visa` (для карт Visa и Visa Electron), +- `Mir`, +- `UnionPay`, +- `JCB`, +- `AmericanExpress`, +- `DinersClub` +- `Unknown`. + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MASTER_CARD](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_MASTER_CARD) | | | +| public | [VISA](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_VISA) | | | +| public | [MIR](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_MIR) | | | +| public | [UNION_PAY](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_UNION_PAY) | | | +| public | [JCB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_JCB) | | | +| public | [AMERICAN_EXPRESS](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_AMERICAN_EXPRESS) | | | +| public | [DINERS_CLUB](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_DINERS_CLUB) | | | +| public | [UNKNOWN](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#constant_UNKNOWN) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodCardType.php](../../lib/Model/PaymentMethod/PaymentMethodCardType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodCardType +--- +## Constants + +###### MASTER_CARD +```php +MASTER_CARD = 'MasterCard' +``` + + + +###### VISA +```php +VISA = 'Visa' +``` + + + +###### MIR +```php +MIR = 'Mir' +``` + + + +###### UNION_PAY +```php +UNION_PAY = 'UnionPay' +``` + + + +###### JCB +```php +JCB = 'JCB' +``` + + + +###### AMERICAN_EXPRESS +```php +AMERICAN_EXPRESS = 'AmericanExpress' +``` + + + +###### DINERS_CLUB +```php +DINERS_CLUB = 'DinersClub' +``` + + + +###### UNKNOWN +```php +UNKNOWN = 'Unknown' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md new file mode 100644 index 00000000..8c78c70d --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md @@ -0,0 +1,536 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodCash +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате наличными через терминал + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodCash.php](../../lib/Model/PaymentMethod/PaymentMethodCash.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodCash +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodCash](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md new file mode 100644 index 00000000..35c715b8 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md @@ -0,0 +1,89 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodFactory +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Фабрика создания объекта платежных методов из массива + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md#method_factory) | | Фабричный метод создания объекта платежных данных по типу | +| public | [factoryFromArray()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md#method_factoryFromArray) | | Фабричный метод создания объекта платежных данных из массива | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodFactory.php](../../lib/Model/PaymentMethod/PaymentMethodFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Model\PaymentMethod\PaymentMethodFactory + +--- +## Methods + +#### public factory() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public factory(string type) : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Фабричный метод создания объекта платежных данных по типу + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodFactory](../classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | type | Тип платежного метода | + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - + + + +#### public factoryFromArray() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public factoryFromArray(array data, string|null type = null) : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Фабричный метод создания объекта платежных данных из массива + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodFactory](../classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | Массив платежных данных | +| string OR null | type | Тип платежного метода | + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md new file mode 100644 index 00000000..bbee701a --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md @@ -0,0 +1,536 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodGooglePay +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Google Pay + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodGooglePay.php](../../lib/Model/PaymentMethod/PaymentMethodGooglePay.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodGooglePay +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodGooglePay](../classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md new file mode 100644 index 00000000..6a43433d --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md @@ -0,0 +1,536 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodInstallments +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты при оплате по частям + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodInstallments.php](../../lib/Model/PaymentMethod/PaymentMethodInstallments.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodInstallments +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodInstallments](../classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md new file mode 100644 index 00000000..3ddbc0e1 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md @@ -0,0 +1,589 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodMobileBalance +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате с баланса мобильного телефона + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$phone](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md#property_phone) | | Номер телефона в формате ITU-T E.164 с которого плательщик собирается произвести оплату | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getPhone()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setPhone()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodMobileBalance.php](../../lib/Model/PaymentMethod/PaymentMethodMobileBalance.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodMobileBalance +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $phone : string +--- +***Description*** + +Номер телефона в формате ITU-T E.164 с которого плательщик собирается произвести оплату + +**Type:** string + +**Details:** + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodMobileBalance](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodMobileBalance](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md) + +**Returns:** string - + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodMobileBalance](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md new file mode 100644 index 00000000..65fff6ea --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md @@ -0,0 +1,523 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodPsb +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Абстрактный класс, описывающий основные свойства и методы платежных методов + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodPsb.php](../../lib/Model/PaymentMethod/PaymentMethodPsb.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodPsb +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodPsb](../classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md new file mode 100644 index 00000000..633a1800 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md @@ -0,0 +1,536 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodQiwi +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Qiwi + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodQiwi.php](../../lib/Model/PaymentMethod/PaymentMethodQiwi.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodQiwi +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodQiwi](../classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md new file mode 100644 index 00000000..be5c0385 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md @@ -0,0 +1,589 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodSberbank +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Сбербанк Онлайн + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$phone](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md#property_phone) | | Телефон пользователя | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getPhone()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md#method_getPhone) | | Возвращает номер телефона в формате ITU-T E.164 | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setPhone()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md#method_setPhone) | | Устанавливает номер телефона в формате ITU-T E.164 | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodSberbank.php](../../lib/Model/PaymentMethod/PaymentMethodSberbank.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodSberbank +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $phone : string +--- +***Description*** + +Телефон пользователя + +**Type:** string + +**Details:** + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md) + +**Returns:** string - Номер телефона в формате ITU-T E.164 + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер телефона в формате ITU-T E.164 | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md new file mode 100644 index 00000000..b49dfa2f --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md @@ -0,0 +1,523 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodTinkoffBank +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Tinkoff + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php](../../lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodTinkoffBank +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodTinkoffBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md new file mode 100644 index 00000000..2c8cfb22 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md @@ -0,0 +1,536 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodWebmoney +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через Webmoney. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodWebmoney.php](../../lib/Model/PaymentMethod/PaymentMethodWebmoney.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodWebmoney +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodWebmoney](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md new file mode 100644 index 00000000..ae11ba1e --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md @@ -0,0 +1,528 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodWechat +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Абстрактный класс, описывающий основные свойства и методы платежных методов + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodWechat.php](../../lib/Model/PaymentMethod/PaymentMethodWechat.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodWechat +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| deprecated | | Класс будет удалён в одной из будущих версий. | +--- +## Properties + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodWechat](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md new file mode 100644 index 00000000..289cc6af --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md @@ -0,0 +1,602 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethod\PaymentMethodYooMoney +### Namespace: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +--- +**Summary:** + +Класс, описывающий метод оплаты, при оплате через ЮMoney + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$account_number](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#property_account_number) | | Номер кошелька в ЮMoney, с которого была произведена оплата | +| public | [$accountNumber](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#property_accountNumber) | | Номер кошелька в ЮMoney, с которого была произведена оплата | +| public | [$id](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_id) | | Идентификатор записи о сохраненных платежных данных | +| public | [$saved](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_saved) | | Возможность многократного использования | +| public | [$title](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#property_title) | | Название метода оплаты | +| public | [$type](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#property_type) | | Тип объекта | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#method___construct) | | | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAccountNumber()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#method_getAccountNumber) | | Возвращает номер кошелька в ЮMoney, с которого была произведена оплата | +| public | [getId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getId) | | Устанавливает идентификатор записи о сохраненных платежных данных | +| public | [getSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getSaved) | | Возвращает признак возможности многократного использования | +| public | [getTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getTitle) | | Возвращает название метода оплаты | +| public | [getType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_getType) | | Возвращает тип объекта | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAccountNumber()](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md#method_setAccountNumber) | | Устанавливает номер кошелька в ЮMoney, с которого была произведена оплата | +| public | [setId()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setId) | | Возвращает идентификатор записи о сохраненных платежных данных | +| public | [setSaved()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setSaved) | | Устанавливает признак возможности многократного использования | +| public | [setTitle()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method_setTitle) | | Устанавливает название метода оплаты | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [_setType()](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md#method__setType) | | Устанавливает тип объекта | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/PaymentMethod/PaymentMethodYooMoney.php](../../lib/Model/PaymentMethod/PaymentMethodYooMoney.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + * \YooKassa\Model\PaymentMethod\PaymentMethodYooMoney +--- +## Properties + +#### public $account_number : string +--- +***Description*** + +Номер кошелька в ЮMoney, с которого была произведена оплата + +**Type:** string + +**Details:** + + + +#### public $accountNumber : string +--- +***Description*** + +Номер кошелька в ЮMoney, с которого была произведена оплата + +**Type:** string + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $saved : bool +--- +***Description*** + +Возможность многократного использования + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $title : string +--- +***Description*** + +Название метода оплаты + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + + + +#### public $type : string +--- +***Description*** + +Тип объекта + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodYooMoney](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md) + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAccountNumber() : string + +```php +public getAccountNumber() : string +``` + +**Summary** + +Возвращает номер кошелька в ЮMoney, с которого была произведена оплата + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodYooMoney](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md) + +**Returns:** string - Номер кошелька в ЮMoney + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Устанавливает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных + + + +#### public getSaved() : bool + +```php +public getSaved() : bool +``` + +**Summary** + +Возвращает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** bool - Возможность многократного использования + + + +#### public getTitle() : string|null + +```php +public getTitle() : string|null +``` + +**Summary** + +Возвращает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string|null - Название метода оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) + +**Returns:** string - Тип объекта + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAccountNumber() : mixed + +```php +public setAccountNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер кошелька в ЮMoney, с которого была произведена оплата + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\PaymentMethodYooMoney](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер кошелька в ЮMoney | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор записи о сохраненных платежных данных + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных | + +**Returns:** mixed - + + + +#### public setSaved() : mixed + +```php +public setSaved(bool value) : mixed +``` + +**Summary** + +Устанавливает признак возможности многократного использования + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность многократного использования | + +**Returns:** mixed - + + + +#### public setTitle() : mixed + +```php +public setTitle(string value) : mixed +``` + +**Summary** + +Устанавливает название метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название метода оплаты | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected _setType() : mixed + +```php +protected _setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип объекта + +**Details:** +* Inherited From: [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип объекта | + +**Returns:** mixed - + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentMethodType.md b/docs/classes/YooKassa-Model-PaymentMethodType.md new file mode 100644 index 00000000..2b1f8f50 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentMethodType.md @@ -0,0 +1,290 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentMethodType +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +PaymentMethodType - Тип источника средств для проведения платежа +|Код|Описание| +--- | --- +|yoo_money|Платеж из кошелька ЮMoney| +|bank_card|Платеж с произвольной банковской карты| +|sberbank|Платеж СбербанкОнлайн| +|cash|Платеж наличными| +|mobile_balance|Платеж с баланса мобильного телефона| +|apple_pay|Платеж ApplePay| +|google_pay|Платеж Google Pay| +|qiwi|Платеж из кошелька Qiwi| +|webmoney|Платеж из кошелька Webmoney| +|alfabank|Платеж через Альфа-Клик| +|b2b_sberbank|Сбербанк Бизнес Онлайн| +|tinkoff_bank|Интернет-банк Тинькофф| +|psb|ПромсвязьБанк| +|installments|Заплатить по частям| +|wechat|Платеж через WeChat| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [YOO_MONEY](../classes/YooKassa-Model-PaymentMethodType.md#constant_YOO_MONEY) | | Платеж из кошелька ЮMoney | +| public | [BANK_CARD](../classes/YooKassa-Model-PaymentMethodType.md#constant_BANK_CARD) | | Платеж с произвольной банковской карты | +| public | [SBERBANK](../classes/YooKassa-Model-PaymentMethodType.md#constant_SBERBANK) | | Платеж СбербанкОнлайн | +| public | [CASH](../classes/YooKassa-Model-PaymentMethodType.md#constant_CASH) | | Платеж наличными | +| public | [MOBILE_BALANCE](../classes/YooKassa-Model-PaymentMethodType.md#constant_MOBILE_BALANCE) | | Платеж с баланса мобильного телефона | +| public | [APPLE_PAY](../classes/YooKassa-Model-PaymentMethodType.md#constant_APPLE_PAY) | | латеж ApplePay | +| public | [GOOGLE_PAY](../classes/YooKassa-Model-PaymentMethodType.md#constant_GOOGLE_PAY) | | Платеж Google Pay | +| public | [QIWI](../classes/YooKassa-Model-PaymentMethodType.md#constant_QIWI) | | Платеж из кошелька Qiwi | +| public | [WEBMONEY](../classes/YooKassa-Model-PaymentMethodType.md#constant_WEBMONEY) | | Платеж из кошелька Webmoney | +| public | [ALFABANK](../classes/YooKassa-Model-PaymentMethodType.md#constant_ALFABANK) | | Платеж через Альфа-Клик | +| public | [B2B_SBERBANK](../classes/YooKassa-Model-PaymentMethodType.md#constant_B2B_SBERBANK) | | Сбербанк Бизнес Онлайн | +| public | [TINKOFF_BANK](../classes/YooKassa-Model-PaymentMethodType.md#constant_TINKOFF_BANK) | | Интернет-банк Тинькофф | +| public | [PSB](../classes/YooKassa-Model-PaymentMethodType.md#constant_PSB) | | ПромсвязьБанк | +| public | [INSTALLMENTS](../classes/YooKassa-Model-PaymentMethodType.md#constant_INSTALLMENTS) | | Заплатить по частям | +| public | [WECHAT](../classes/YooKassa-Model-PaymentMethodType.md#constant_WECHAT) | *deprecated* | Оплата через WeChat | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PaymentMethodType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/PaymentMethodType.php](../../lib/Model/PaymentMethodType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PaymentMethodType +--- +## Constants + +###### YOO_MONEY +Платеж из кошелька ЮMoney + +```php +YOO_MONEY = 'yoo_money' +``` + + + +###### BANK_CARD +Платеж с произвольной банковской карты + +```php +BANK_CARD = 'bank_card' +``` + + + +###### SBERBANK +Платеж СбербанкОнлайн + +```php +SBERBANK = 'sberbank' +``` + + + +###### CASH +Платеж наличными + +```php +CASH = 'cash' +``` + + + +###### MOBILE_BALANCE +Платеж с баланса мобильного телефона + +```php +MOBILE_BALANCE = 'mobile_balance' +``` + + + +###### APPLE_PAY +латеж ApplePay + +```php +APPLE_PAY = 'apple_pay' +``` + + + +###### GOOGLE_PAY +Платеж Google Pay + +```php +GOOGLE_PAY = 'google_pay' +``` + + + +###### QIWI +Платеж из кошелька Qiwi + +```php +QIWI = 'qiwi' +``` + + + +###### WEBMONEY +Платеж из кошелька Webmoney + +```php +WEBMONEY = 'webmoney' +``` + + + +###### ALFABANK +Платеж через Альфа-Клик + +```php +ALFABANK = 'alfabank' +``` + + + +###### B2B_SBERBANK +Сбербанк Бизнес Онлайн + +```php +B2B_SBERBANK = 'b2b_sberbank' +``` + + + +###### TINKOFF_BANK +Интернет-банк Тинькофф + +```php +TINKOFF_BANK = 'tinkoff_bank' +``` + + + +###### PSB +ПромсвязьБанк + +```php +PSB = 'psb' +``` + + + +###### INSTALLMENTS +Заплатить по частям + +```php +INSTALLMENTS = 'installments' +``` + + + +###### ~~WECHAT~~ +Оплата через WeChat + +```php +WECHAT = 'wechat' +``` + +**deprecated** +Будет удален в следующих версиях + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-PaymentStatus.md b/docs/classes/YooKassa-Model-PaymentStatus.md new file mode 100644 index 00000000..ad31d7f1 --- /dev/null +++ b/docs/classes/YooKassa-Model-PaymentStatus.md @@ -0,0 +1,167 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\PaymentStatus +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +PaymentStatus - Состояние платежа +|Код|Описание| +--- | --- +|pending|Ожидает оплаты покупателем| +|waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| +|succeeded|Успешно оплачен и подтвержден магазином| +|canceled|Неуспех оплаты или отменен магазином (cancel)| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PENDING](../classes/YooKassa-Model-PaymentStatus.md#constant_PENDING) | | Ожидает оплаты покупателем | +| public | [WAITING_FOR_CAPTURE](../classes/YooKassa-Model-PaymentStatus.md#constant_WAITING_FOR_CAPTURE) | | Ожидает подтверждения магазином | +| public | [SUCCEEDED](../classes/YooKassa-Model-PaymentStatus.md#constant_SUCCEEDED) | | Успешно оплачен и подтвержден магазином | +| public | [CANCELED](../classes/YooKassa-Model-PaymentStatus.md#constant_CANCELED) | | Неуспех оплаты или отменен магазином | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-PaymentStatus.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/PaymentStatus.php](../../lib/Model/PaymentStatus.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\PaymentStatus +--- +## Constants + +###### PENDING +Ожидает оплаты покупателем + +```php +PENDING = 'pending' +``` + + + +###### WAITING_FOR_CAPTURE +Ожидает подтверждения магазином + +```php +WAITING_FOR_CAPTURE = 'waiting_for_capture' +``` + + + +###### SUCCEEDED +Успешно оплачен и подтвержден магазином + +```php +SUCCEEDED = 'succeeded' +``` + + + +###### CANCELED +Неуспех оплаты или отменен магазином + +```php +CANCELED = 'canceled' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-AgentType.md b/docs/classes/YooKassa-Model-Receipt-AgentType.md new file mode 100644 index 00000000..0f497c13 --- /dev/null +++ b/docs/classes/YooKassa-Model-Receipt-AgentType.md @@ -0,0 +1,177 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Receipt\AgentType +### Namespace: [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [BANKING_PAYMENT_AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_BANKING_PAYMENT_AGENT) | | | +| public | [BANKING_PAYMENT_SUBAGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_BANKING_PAYMENT_SUBAGENT) | | | +| public | [PAYMENT_AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_PAYMENT_AGENT) | | | +| public | [PAYMENT_SUBAGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_PAYMENT_SUBAGENT) | | | +| public | [ATTORNEY](../classes/YooKassa-Model-Receipt-AgentType.md#constant_ATTORNEY) | | | +| public | [COMMISSIONER](../classes/YooKassa-Model-Receipt-AgentType.md#constant_COMMISSIONER) | | | +| public | [AGENT](../classes/YooKassa-Model-Receipt-AgentType.md#constant_AGENT) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-Receipt-AgentType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/Receipt/AgentType.php](../../lib/Model/Receipt/AgentType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\Receipt\AgentType +--- +## Constants + +###### BANKING_PAYMENT_AGENT +```php +BANKING_PAYMENT_AGENT = 'banking_payment_agent' +``` + + + +###### BANKING_PAYMENT_SUBAGENT +```php +BANKING_PAYMENT_SUBAGENT = 'banking_payment_subagent' +``` + + + +###### PAYMENT_AGENT +```php +PAYMENT_AGENT = 'payment_agent' +``` + + + +###### PAYMENT_SUBAGENT +```php +PAYMENT_SUBAGENT = 'payment_subagent' +``` + + + +###### ATTORNEY +```php +ATTORNEY = 'attorney' +``` + + + +###### COMMISSIONER +```php +COMMISSIONER = 'commissioner' +``` + + + +###### AGENT +```php +AGENT = 'agent' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-PaymentMode.md b/docs/classes/YooKassa-Model-Receipt-PaymentMode.md new file mode 100644 index 00000000..987e6d58 --- /dev/null +++ b/docs/classes/YooKassa-Model-Receipt-PaymentMode.md @@ -0,0 +1,177 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Receipt\PaymentMode +### Namespace: [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [FULL_PREPAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_FULL_PREPAYMENT) | | | +| public | [PARTIAL_PREPAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_PARTIAL_PREPAYMENT) | | | +| public | [ADVANCE](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_ADVANCE) | | | +| public | [FULL_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_FULL_PAYMENT) | | | +| public | [PARTIAL_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_PARTIAL_PAYMENT) | | | +| public | [CREDIT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_CREDIT) | | | +| public | [CREDIT_PAYMENT](../classes/YooKassa-Model-Receipt-PaymentMode.md#constant_CREDIT_PAYMENT) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-Receipt-PaymentMode.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/Receipt/PaymentMode.php](../../lib/Model/Receipt/PaymentMode.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\Receipt\PaymentMode +--- +## Constants + +###### FULL_PREPAYMENT +```php +FULL_PREPAYMENT = 'full_prepayment' +``` + + + +###### PARTIAL_PREPAYMENT +```php +PARTIAL_PREPAYMENT = 'partial_prepayment' +``` + + + +###### ADVANCE +```php +ADVANCE = 'advance' +``` + + + +###### FULL_PAYMENT +```php +FULL_PAYMENT = 'full_payment' +``` + + + +###### PARTIAL_PAYMENT +```php +PARTIAL_PAYMENT = 'partial_payment' +``` + + + +###### CREDIT +```php +CREDIT = 'credit' +``` + + + +###### CREDIT_PAYMENT +```php +CREDIT_PAYMENT = 'credit_payment' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md b/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md new file mode 100644 index 00000000..c7cb1b39 --- /dev/null +++ b/docs/classes/YooKassa-Model-Receipt-PaymentSubject.md @@ -0,0 +1,265 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Receipt\PaymentSubject +### Namespace: [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [COMMODITY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COMMODITY) | | | +| public | [EXCISE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_EXCISE) | | | +| public | [JOB](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_JOB) | | | +| public | [SERVICE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_SERVICE) | | | +| public | [GAMBLING_BET](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_GAMBLING_BET) | | | +| public | [GAMBLING_PRIZE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_GAMBLING_PRIZE) | | | +| public | [LOTTERY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LOTTERY) | | | +| public | [LOTTERY_PRIZE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_LOTTERY_PRIZE) | | | +| public | [INTELLECTUAL_ACTIVITY](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_INTELLECTUAL_ACTIVITY) | | | +| public | [PAYMENT](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PAYMENT) | | | +| public | [AGENT_COMMISSION](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_AGENT_COMMISSION) | | | +| public | [PROPERTY_RIGHT](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_PROPERTY_RIGHT) | | | +| public | [NON_OPERATING_GAIN](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_NON_OPERATING_GAIN) | | | +| public | [INSURANCE_PREMIUM](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_INSURANCE_PREMIUM) | | | +| public | [SALES_TAX](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_SALES_TAX) | | | +| public | [RESORT_FEE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_RESORT_FEE) | | | +| public | [COMPOSITE](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_COMPOSITE) | | | +| public | [ANOTHER](../classes/YooKassa-Model-Receipt-PaymentSubject.md#constant_ANOTHER) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-Receipt-PaymentSubject.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/Receipt/PaymentSubject.php](../../lib/Model/Receipt/PaymentSubject.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\Receipt\PaymentSubject +--- +## Constants + +###### COMMODITY +```php +COMMODITY = 'commodity' +``` + + + +###### EXCISE +```php +EXCISE = 'excise' +``` + + + +###### JOB +```php +JOB = 'job' +``` + + + +###### SERVICE +```php +SERVICE = 'service' +``` + + + +###### GAMBLING_BET +```php +GAMBLING_BET = 'gambling_bet' +``` + + + +###### GAMBLING_PRIZE +```php +GAMBLING_PRIZE = 'gambling_prize' +``` + + + +###### LOTTERY +```php +LOTTERY = 'lottery' +``` + + + +###### LOTTERY_PRIZE +```php +LOTTERY_PRIZE = 'lottery_prize' +``` + + + +###### INTELLECTUAL_ACTIVITY +```php +INTELLECTUAL_ACTIVITY = 'intellectual_activity' +``` + + + +###### PAYMENT +```php +PAYMENT = 'payment' +``` + + + +###### AGENT_COMMISSION +```php +AGENT_COMMISSION = 'agent_commission' +``` + + + +###### PROPERTY_RIGHT +```php +PROPERTY_RIGHT = 'property_right' +``` + + + +###### NON_OPERATING_GAIN +```php +NON_OPERATING_GAIN = 'non_operating_gain' +``` + + + +###### INSURANCE_PREMIUM +```php +INSURANCE_PREMIUM = 'insurance_premium' +``` + + + +###### SALES_TAX +```php +SALES_TAX = 'sales_tax' +``` + + + +###### RESORT_FEE +```php +RESORT_FEE = 'resort_fee' +``` + + + +###### COMPOSITE +```php +COMPOSITE = 'composite' +``` + + + +###### ANOTHER +```php +ANOTHER = 'another' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md b/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md new file mode 100644 index 00000000..5b554efa --- /dev/null +++ b/docs/classes/YooKassa-Model-Receipt-ReceiptItemAmount.md @@ -0,0 +1,511 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Receipt\ReceiptItemAmount +### Namespace: [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +--- +**Summary:** + +Class ReceiptItemAmount + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method___construct) | | MonetaryAmount constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [fromArray()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCurrency()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_getCurrency) | | Возвращает валюту | +| public | [getIntegerValue()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_getIntegerValue) | | Возвращает сумму в копейках в виде целого числа | +| public | [getValue()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_getValue) | | Возвращает значение суммы | +| public | [increase()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_increase) | | Увеличивает сумму на указанное значение | +| public | [jsonSerialize()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [multiply()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_multiply) | | Умножает текущую сумму на указанный коэффициент | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCurrency()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_setCurrency) | | Устанавливает код валюты | +| public | [setValue()](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md#method_setValue) | | Устанавливает значение суммы | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Receipt/ReceiptItemAmount.php](../../lib/Model/Receipt/ReceiptItemAmount.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Receipt\ReceiptItemAmount +* Implements: + * [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(\YooKassa\Model\Receipt\numeric|null value = null, string|null currency = null) : mixed +``` + +**Summary** + +MonetaryAmount constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Receipt\numeric OR null | value | Сумма | +| string OR null | currency | Код валюты | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public fromArray() + +```php +public fromArray(mixed sourceArray) +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | sourceArray | Ассоциативный массив с настройками | + +**Returns:** - + + + +#### public getCurrency() : string + +```php +public getCurrency() : string +``` + +**Summary** + +Возвращает валюту + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) + +**Returns:** string - Код валюты + + + +#### public getIntegerValue() : int + +```php +public getIntegerValue() : int +``` + +**Summary** + +Возвращает сумму в копейках в виде целого числа + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) + +**Returns:** int - Сумма в копейках/центах + + + +#### public getValue() : string + +```php +public getValue() : string +``` + +**Summary** + +Возвращает значение суммы + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) + +**Returns:** string - Сумма + + + +#### public increase() : mixed + +```php +public increase(int value) : mixed +``` + +**Summary** + +Увеличивает сумму на указанное значение + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Значение которое будет прибавлено к текущему | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если после сложения получилась сумма меньше или равная нулю | + +**Returns:** mixed - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) + +**Returns:** array - + + + +#### public multiply() : mixed + +```php +public multiply(float coefficient) : mixed +``` + +**Summary** + +Умножает текущую сумму на указанный коэффициент + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float | coefficient | Множитель | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение меньше или равно нулю, либо если после умножения получили значение равное нулю | + +**Returns:** mixed - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCurrency() : mixed + +```php +public setCurrency(string value) : mixed +``` + +**Summary** + +Устанавливает код валюты + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Код валюты | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Генерируется если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если был передан неподдерживаемый код валюты | + +**Returns:** mixed - + + + +#### public setValue() : mixed + +```php +public setValue(mixed value) : mixed +``` + +**Summary** + +Устанавливает значение суммы + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Сумма | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt-SettlementType.md b/docs/classes/YooKassa-Model-Receipt-SettlementType.md new file mode 100644 index 00000000..a0d2e0cb --- /dev/null +++ b/docs/classes/YooKassa-Model-Receipt-SettlementType.md @@ -0,0 +1,153 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Receipt\SettlementType +### Namespace: [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +--- +**Summary:** + +Базовый класс генерируемых enum'ов + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [CASHLESS](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_CASHLESS) | | | +| public | [PREPAYMENT](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_PREPAYMENT) | | | +| public | [POSTPAYMENT](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_POSTPAYMENT) | | | +| public | [CONSIDERATION](../classes/YooKassa-Model-Receipt-SettlementType.md#constant_CONSIDERATION) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-Receipt-SettlementType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/Receipt/SettlementType.php](../../lib/Model/Receipt/SettlementType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\Receipt\SettlementType +--- +## Constants + +###### CASHLESS +```php +CASHLESS = 'cashless' +``` + + + +###### PREPAYMENT +```php +PREPAYMENT = 'prepayment' +``` + + + +###### POSTPAYMENT +```php +POSTPAYMENT = 'postpayment' +``` + + + +###### CONSIDERATION +```php +CONSIDERATION = 'consideration' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Receipt.md b/docs/classes/YooKassa-Model-Receipt.md new file mode 100644 index 00000000..07aeb6db --- /dev/null +++ b/docs/classes/YooKassa-Model-Receipt.md @@ -0,0 +1,810 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Receipt +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс данных для формирования чека в онлайн-кассе (для соблюдения 54-ФЗ) + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$customer](../classes/YooKassa-Model-Receipt.md#property_customer) | | Информация о плательщике | +| public | [$items](../classes/YooKassa-Model-Receipt.md#property_items) | | Список товаров в заказе | +| public | [$settlements](../classes/YooKassa-Model-Receipt.md#property_settlements) | | Массив оплат, обеспечивающих выдачу товара | +| public | [$tax_system_code](../classes/YooKassa-Model-Receipt.md#property_tax_system_code) | | Код системы налогообложения. Число 1-6. | +| public | [$taxSystemCode](../classes/YooKassa-Model-Receipt.md#property_taxSystemCode) | | Код системы налогообложения. Число 1-6. | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addItem()](../classes/YooKassa-Model-Receipt.md#method_addItem) | | Добавляет товар в чек | +| public | [addSettlement()](../classes/YooKassa-Model-Receipt.md#method_addSettlement) | | Добавляет оплату в чек | +| public | [fromArray()](../classes/YooKassa-Model-Receipt.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmountValue()](../classes/YooKassa-Model-Receipt.md#method_getAmountValue) | | Возвращает стоимость заказа исходя из состава чека | +| public | [getCustomer()](../classes/YooKassa-Model-Receipt.md#method_getCustomer) | | Возвращает информацию о плательщике | +| public | [getEmail()](../classes/YooKassa-Model-Receipt.md#method_getEmail) | *deprecated* | Возвращает адрес электронной почты на который будет выслан чек | +| public | [getItems()](../classes/YooKassa-Model-Receipt.md#method_getItems) | | Возвращает список позиций в текущем чеке | +| public | [getObjectId()](../classes/YooKassa-Model-Receipt.md#method_getObjectId) | | Возвращает Id объекта чека | +| public | [getPhone()](../classes/YooKassa-Model-Receipt.md#method_getPhone) | *deprecated* | Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек | +| public | [getSettlements()](../classes/YooKassa-Model-Receipt.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | +| public | [getShippingAmountValue()](../classes/YooKassa-Model-Receipt.md#method_getShippingAmountValue) | | Возвращает стоимость доставки исходя из состава чека | +| public | [getTaxSystemCode()](../classes/YooKassa-Model-Receipt.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [normalize()](../classes/YooKassa-Model-Receipt.md#method_normalize) | | Подгоняет стоимость товаров в чеке к общей цене заказа | +| public | [notEmpty()](../classes/YooKassa-Model-Receipt.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCustomer()](../classes/YooKassa-Model-Receipt.md#method_setCustomer) | | Устанавливает информацию о плательщике | +| public | [setEmail()](../classes/YooKassa-Model-Receipt.md#method_setEmail) | *deprecated* | Устанавливает адрес электронной почты на который будет выслан чек | +| public | [setItems()](../classes/YooKassa-Model-Receipt.md#method_setItems) | | Устанавливает список позиций в чеке | +| public | [setPhone()](../classes/YooKassa-Model-Receipt.md#method_setPhone) | *deprecated* | Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек | +| public | [setSettlements()](../classes/YooKassa-Model-Receipt.md#method_setSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара | +| public | [setTaxSystemCode()](../classes/YooKassa-Model-Receipt.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Receipt.php](../../lib/Model/Receipt.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Receipt +* Implements: + * [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) +--- +## Properties + +#### public $customer : \YooKassa\Model\ReceiptCustomer +--- +***Description*** + +Информация о плательщике + +**Type:** ReceiptCustomer + +**Details:** + + + +#### public $items : \YooKassa\Model\ReceiptItemInterface[] +--- +***Description*** + +Список товаров в заказе + +**Type:** ReceiptItemInterface[] + +**Details:** + + + +#### public $settlements : \YooKassa\Model\SettlementInterface[] +--- +***Description*** + +Массив оплат, обеспечивающих выдачу товара + +**Type:** SettlementInterface[] + +**Details:** + + + +#### public $tax_system_code : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** + + + +#### public $taxSystemCode : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addItem() : mixed + +```php +public addItem(\YooKassa\Model\ReceiptItemInterface value) : mixed +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface | value | Объект добавляемой в чек позиции | + +**Returns:** mixed - + + + +#### public addSettlement() : mixed + +```php +public addSettlement(\YooKassa\Model\SettlementInterface value) : mixed +``` + +**Summary** + +Добавляет оплату в чек + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface | value | Объект добавляемой в чек позиции | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmountValue() : int + +```php +public getAmountValue(bool withShipping = true) : int +``` + +**Summary** + +Возвращает стоимость заказа исходя из состава чека + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | withShipping | Добавить ли к стоимости заказа стоимость доставки | + +**Returns:** int - Общая стоимость заказа в центах/копейках + + + +#### public getCustomer() : \YooKassa\Model\ReceiptCustomer + +```php +public getCustomer() : \YooKassa\Model\ReceiptCustomer +``` + +**Summary** + +Возвращает информацию о плательщике + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** \YooKassa\Model\ReceiptCustomer - Информация о плательщике + + + +#### (deprecated) - public getEmail() : string + +```php +public getEmail() : string +``` + +**Summary** + +Возвращает адрес электронной почты на который будет выслан чек + +**Deprecated** +Deprecated since 1.3.0Устарел — данные рекомендуется брать в параметре receipt.customer.email. +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** string - E-mail адрес плательщика + + + +#### public getItems() : \YooKassa\Model\ReceiptItemInterface[] + +```php +public getItems() : \YooKassa\Model\ReceiptItemInterface[] +``` + +**Summary** + +Возвращает список позиций в текущем чеке + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** \YooKassa\Model\ReceiptItemInterface[] - Список товаров в заказе + + + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает Id объекта чека + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** string - Id объекта чека + + + +#### (deprecated) - public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек + +**Deprecated** +Deprecated since 1.3.0Устарел — данные рекомендуется брать в параметре receipt.customer.phone. +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** string - Номер телефона плательщика + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - Массив оплат, обеспечивающих выдачу товара. + + + +#### public getShippingAmountValue() : int + +```php +public getShippingAmountValue() : int +``` + +**Summary** + +Возвращает стоимость доставки исходя из состава чека + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** int - Стоимость доставки из состава чека в центах/копейках + + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** int - Код системы налогообложения. Число 1-6. + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public normalize() : mixed + +```php +public normalize(\YooKassa\Model\AmountInterface orderAmount, bool withShipping = false) : mixed +``` + +**Summary** + +Подгоняет стоимость товаров в чеке к общей цене заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | orderAmount | Общая стоимость заказа | +| bool | withShipping | Поменять ли заодно и цену доставки | + +**Returns:** mixed - + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCustomer() : mixed + +```php +public setCustomer(\YooKassa\Model\ReceiptCustomer customer) : mixed +``` + +**Summary** + +Устанавливает информацию о плательщике + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptCustomer | customer | | + +**Returns:** mixed - + + + +#### (deprecated) - public setEmail() : mixed + +```php +public setEmail(string value) : mixed +``` + +**Summary** + +Устанавливает адрес электронной почты на который будет выслан чек + +**Deprecated** +Deprecated since 1.3.0Устарел — данные рекомендуется передавать в параметре receipt.customer.email. +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | E-mail адрес плательщика | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** mixed - + + + +#### public setItems() : mixed + +```php +public setItems(\YooKassa\Model\ReceiptItemInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список позиций в чеке + +**Description** + +Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком +позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс +ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface[] | value | Список товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передали пустой массив значений | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения был передан не массив и не итератор, либо если одно из переданных значений не реализует интерфейс ReceiptItemInterface | + +**Returns:** mixed - + + + +#### (deprecated) - public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек + +**Deprecated** +Deprecated since 1.3.0Устарел — данные рекомендуется передавать в параметре receipt.customer.phone. +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер телефона плательщика в формате ITU-T E.164 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** mixed - + + + +#### public setSettlements() : mixed + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[] value) : mixed +``` + +**Summary** + +Возвращает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] | value | | + +**Returns:** mixed - + + + +#### public setTaxSystemCode() : mixed + +```php +public setTaxSystemCode(int value) : mixed +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданный аргумент меньше одного или больше шести | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptCustomer.md b/docs/classes/YooKassa-Model-ReceiptCustomer.md new file mode 100644 index 00000000..256f4105 --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptCustomer.md @@ -0,0 +1,590 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ReceiptCustomer +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Информация о плательщике + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$email](../classes/YooKassa-Model-ReceiptCustomer.md#property_email) | | E-mail адрес плательщика на который будет выслан чек. | +| public | [$full_name](../classes/YooKassa-Model-ReceiptCustomer.md#property_full_name) | | Для юрлица — название организации, для ИП и физического лица — ФИО. | +| public | [$fullName](../classes/YooKassa-Model-ReceiptCustomer.md#property_fullName) | | Для юрлица — название организации, для ИП и физического лица — ФИО. | +| public | [$inn](../classes/YooKassa-Model-ReceiptCustomer.md#property_inn) | | ИНН плательщика (10 или 12 цифр). | +| public | [$phone](../classes/YooKassa-Model-ReceiptCustomer.md#property_phone) | | Номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек. | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEmail()](../classes/YooKassa-Model-ReceiptCustomer.md#method_getEmail) | | Возвращает адрес электронной почты на который будет выслан чек | +| public | [getFullName()](../classes/YooKassa-Model-ReceiptCustomer.md#method_getFullName) | | Возвращает для юрлица — название организации, для ИП и физического лица — ФИО | +| public | [getInn()](../classes/YooKassa-Model-ReceiptCustomer.md#method_getInn) | | Возвращает ИНН плательщика | +| public | [getPhone()](../classes/YooKassa-Model-ReceiptCustomer.md#method_getPhone) | | Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек | +| public | [isEmpty()](../classes/YooKassa-Model-ReceiptCustomer.md#method_isEmpty) | | Проверка на заполненность объекта | +| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptCustomer.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setEmail()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setEmail) | | Устанавливает адрес электронной почты на который будет выслан чек | +| public | [setFullName()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setFullName) | | Устанавливает Название организации или ФИО | +| public | [setInn()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setInn) | | Устанавливает ИНН плательщика | +| public | [setPhone()](../classes/YooKassa-Model-ReceiptCustomer.md#method_setPhone) | | Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ReceiptCustomer.php](../../lib/Model/ReceiptCustomer.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\ReceiptCustomer +* Implements: + * [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) +--- +## Properties + +#### public $email : string +--- +***Description*** + +E-mail адрес плательщика на который будет выслан чек. + +**Type:** string + +**Details:** + + + +#### public $full_name : string +--- +***Description*** + +Для юрлица — название организации, для ИП и физического лица — ФИО. + +**Type:** string + +**Details:** + + + +#### public $fullName : string +--- +***Description*** + +Для юрлица — название организации, для ИП и физического лица — ФИО. + +**Type:** string + +**Details:** + + + +#### public $inn : string +--- +***Description*** + +ИНН плательщика (10 или 12 цифр). + +**Type:** string + +**Details:** + + + +#### public $phone : string +--- +***Description*** + +Номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек. + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEmail() : string + +```php +public getEmail() : string +``` + +**Summary** + +Возвращает адрес электронной почты на который будет выслан чек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) + +**Returns:** string - E-mail адрес плательщика + + + +#### public getFullName() : string + +```php +public getFullName() : string +``` + +**Summary** + +Возвращает для юрлица — название организации, для ИП и физического лица — ФИО + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) + +**Returns:** string - Название организации или ФИО + + + +#### public getInn() : string + +```php +public getInn() : string +``` + +**Summary** + +Возвращает ИНН плательщика + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) + +**Returns:** string - + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) + +**Returns:** string - Номер телефона плательщика + + + +#### public isEmpty() : bool + +```php +public isEmpty() : bool +``` + +**Summary** + +Проверка на заполненность объекта + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) + +**Returns:** bool - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) + +**Returns:** array - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setEmail() : mixed + +```php +public setEmail(string value) : mixed +``` + +**Summary** + +Устанавливает адрес электронной почты на который будет выслан чек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | E-mail адрес плательщика | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** mixed - + + + +#### public setFullName() : mixed + +```php +public setFullName(string value) : mixed +``` + +**Summary** + +Устанавливает Название организации или ФИО + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название организации или ФИО | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** mixed - + + + +#### public setInn() : mixed + +```php +public setInn(string value) : mixed +``` + +**Summary** + +Устанавливает ИНН плательщика + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | ИНН плательщика (10 или 12 цифр) | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если ИНН не соответствует формату 10 или 12 цифр | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер телефона плательщика в формате ITU-T E.164 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md b/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md new file mode 100644 index 00000000..50f716ba --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptCustomerInterface.md @@ -0,0 +1,142 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ReceiptCustomerInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface ReceiptCustomerInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEmail()](../classes/YooKassa-Model-ReceiptCustomerInterface.md#method_getEmail) | | Возвращает адрес электронной почты на который будет выслан чек | +| public | [getFullName()](../classes/YooKassa-Model-ReceiptCustomerInterface.md#method_getFullName) | | Возвращает название организации или ФИО физического лица | +| public | [getInn()](../classes/YooKassa-Model-ReceiptCustomerInterface.md#method_getInn) | | Возвращает ИНН плательщика | +| public | [getPhone()](../classes/YooKassa-Model-ReceiptCustomerInterface.md#method_getPhone) | | Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек | +| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptCustomerInterface.md#method_jsonSerialize) | | Возвращает массив полей плательщика | + +--- +### Details +* File: [lib/Model/ReceiptCustomerInterface.php](../../lib/Model/ReceiptCustomerInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Для юрлица — название организации, для ИП и физического лица — ФИО. | +| property-read | | Для юрлица — название организации, для ИП и физического лица — ФИО. | +| property-read | | Номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек. | +| property-read | | E-mail адрес плательщика на который будет выслан чек. | +| property-read | | ИНН плательщика (10 или 12 цифр). | +--- +## Methods + +#### public getFullName() : string + +```php +public getFullName() : string +``` + +**Summary** + +Возвращает название организации или ФИО физического лица + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) + +**Returns:** string - название организации или ФИО физического лица + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) + +**Returns:** string - Номер телефона плательщика + + + +#### public getEmail() : string + +```php +public getEmail() : string +``` + +**Summary** + +Возвращает адрес электронной почты на который будет выслан чек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) + +**Returns:** string - E-mail адрес плательщика + + + +#### public getInn() : string + +```php +public getInn() : string +``` + +**Summary** + +Возвращает ИНН плательщика + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) + +**Returns:** string - ИНН плательщика + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает массив полей плательщика + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) + +**Returns:** array - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptInterface.md b/docs/classes/YooKassa-Model-ReceiptInterface.md new file mode 100644 index 00000000..7909c25d --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptInterface.md @@ -0,0 +1,182 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ReceiptInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface ReceiptInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getCustomer()](../classes/YooKassa-Model-ReceiptInterface.md#method_getCustomer) | | Возвращает информацию о плательщике | +| public | [getItems()](../classes/YooKassa-Model-ReceiptInterface.md#method_getItems) | | Возвращает список позиций в текущем чеке | +| public | [getObjectId()](../classes/YooKassa-Model-ReceiptInterface.md#method_getObjectId) | | Возвращает Id объекта чека | +| public | [getSettlements()](../classes/YooKassa-Model-ReceiptInterface.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара. | +| public | [getTaxSystemCode()](../classes/YooKassa-Model-ReceiptInterface.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [normalize()](../classes/YooKassa-Model-ReceiptInterface.md#method_normalize) | | Подгоняет стоимость товаров в чеке к общей цене заказа | +| public | [notEmpty()](../classes/YooKassa-Model-ReceiptInterface.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | + +--- +### Details +* File: [lib/Model/ReceiptInterface.php](../../lib/Model/ReceiptInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Информация о плательщике | +| property-read | | Список товаров в заказе | +| property-read | | Код системы налогообложения. Число 1-6. | +| property-read | | Код системы налогообложения. Число 1-6. | +--- +## Methods + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает Id объекта чека + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) + +**Returns:** string - Id объекта чека + + + +#### public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface + +```php +public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface +``` + +**Summary** + +Возвращает информацию о плательщике + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) + +**Returns:** \YooKassa\Model\ReceiptCustomerInterface - Информация о плательщике + + + +#### public getItems() : \YooKassa\Model\ReceiptItemInterface[] + +```php +public getItems() : \YooKassa\Model\ReceiptItemInterface[] +``` + +**Summary** + +Возвращает список позиций в текущем чеке + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) + +**Returns:** \YooKassa\Model\ReceiptItemInterface[] - Список товаров в заказе + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает массив оплат, обеспечивающих выдачу товара. + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - Массив оплат, обеспечивающих выдачу товара. + + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) + +**Returns:** int - Код системы налогообложения. Число 1-6. + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public normalize() : mixed + +```php +public normalize(\YooKassa\Model\AmountInterface orderAmount, bool withShipping = false) : mixed +``` + +**Summary** + +Подгоняет стоимость товаров в чеке к общей цене заказа + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | orderAmount | Общая стоимость заказа | +| bool | withShipping | Поменять ли заодно и цену доставки | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptItem.md b/docs/classes/YooKassa-Model-ReceiptItem.md new file mode 100644 index 00000000..b218c0bb --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptItem.md @@ -0,0 +1,1235 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ReceiptItem +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Информация о товарной позиции в заказе, позиция фискального чека + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-ReceiptItem.md#property_amount) | | Суммарная стоимость покупаемого товара в копейках/центах | +| public | [$country_of_origin_code](../classes/YooKassa-Model-ReceiptItem.md#property_country_of_origin_code) | | Код страны происхождения товара | +| public | [$countryOfOriginCode](../classes/YooKassa-Model-ReceiptItem.md#property_countryOfOriginCode) | | Код страны происхождения товара | +| public | [$customs_declaration_number](../classes/YooKassa-Model-ReceiptItem.md#property_customs_declaration_number) | | Номер таможенной декларации (от 1 до 32 символов) | +| public | [$customsDeclarationNumber](../classes/YooKassa-Model-ReceiptItem.md#property_customsDeclarationNumber) | | Номер таможенной декларации (от 1 до 32 символов) | +| public | [$description](../classes/YooKassa-Model-ReceiptItem.md#property_description) | | Наименование товара | +| public | [$excise](../classes/YooKassa-Model-ReceiptItem.md#property_excise) | | Сумма акциза товара с учетом копеек | +| public | [$isShipping](../classes/YooKassa-Model-ReceiptItem.md#property_isShipping) | | Флаг доставки | +| public | [$payment_mode](../classes/YooKassa-Model-ReceiptItem.md#property_payment_mode) | | Признак способа расчета | +| public | [$payment_subject](../classes/YooKassa-Model-ReceiptItem.md#property_payment_subject) | | Признак предмета расчета | +| public | [$paymentMode](../classes/YooKassa-Model-ReceiptItem.md#property_paymentMode) | | Признак способа расчета | +| public | [$paymentSubject](../classes/YooKassa-Model-ReceiptItem.md#property_paymentSubject) | | Признак предмета расчета | +| public | [$price](../classes/YooKassa-Model-ReceiptItem.md#property_price) | | Цена товара | +| public | [$product_code](../classes/YooKassa-Model-ReceiptItem.md#property_product_code) | | Код товара | +| public | [$productCode](../classes/YooKassa-Model-ReceiptItem.md#property_productCode) | | Код товара | +| public | [$quantity](../classes/YooKassa-Model-ReceiptItem.md#property_quantity) | | Количество | +| public | [$supplier](../classes/YooKassa-Model-ReceiptItem.md#property_supplier) | | Информация о поставщике товара или услуги | +| public | [$vat_code](../classes/YooKassa-Model-ReceiptItem.md#property_vat_code) | | Ставка НДС, число 1-6 | +| public | [$vatCode](../classes/YooKassa-Model-ReceiptItem.md#property_vatCode) | | Ставка НДС, число 1-6 | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-ReceiptItem.md#method___construct) | | ReceiptItem constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [applyDiscountCoefficient()](../classes/YooKassa-Model-ReceiptItem.md#method_applyDiscountCoefficient) | | Применяет для товара скидку | +| public | [fetchItem()](../classes/YooKassa-Model-ReceiptItem.md#method_fetchItem) | | Уменьшает количество покупаемого товара на указанное, возвращает объект позиции в чеке с уменьшаемым количеством | +| public | [fromArray()](../classes/YooKassa-Model-ReceiptItem.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAgentType()](../classes/YooKassa-Model-ReceiptItem.md#method_getAgentType) | | Возвращает тип посредника, реализующего товар или услугу | +| public | [getAmount()](../classes/YooKassa-Model-ReceiptItem.md#method_getAmount) | | Возвращает общую стоимость покупаемого товара в копейках/центах | +| public | [getCountryOfOriginCode()](../classes/YooKassa-Model-ReceiptItem.md#method_getCountryOfOriginCode) | | Возвращает код страны происхождения товара по общероссийскому классификатору стран мира | +| public | [getCustomsDeclarationNumber()](../classes/YooKassa-Model-ReceiptItem.md#method_getCustomsDeclarationNumber) | | Возвращает номер таможенной декларации | +| public | [getDescription()](../classes/YooKassa-Model-ReceiptItem.md#method_getDescription) | | Возвращает наименование товара | +| public | [getExcise()](../classes/YooKassa-Model-ReceiptItem.md#method_getExcise) | | Возвращает сумму акциза товара с учетом копеек | +| public | [getPaymentMode()](../classes/YooKassa-Model-ReceiptItem.md#method_getPaymentMode) | | Возвращает признак способа расчета | +| public | [getPaymentSubject()](../classes/YooKassa-Model-ReceiptItem.md#method_getPaymentSubject) | | Возвращает признак предмета расчета | +| public | [getPrice()](../classes/YooKassa-Model-ReceiptItem.md#method_getPrice) | | Возвращает цену товара | +| public | [getProductCode()](../classes/YooKassa-Model-ReceiptItem.md#method_getProductCode) | | Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке | +| public | [getQuantity()](../classes/YooKassa-Model-ReceiptItem.md#method_getQuantity) | | Возвращает количество товара | +| public | [getSupplier()](../classes/YooKassa-Model-ReceiptItem.md#method_getSupplier) | | Возвращает информацию о поставщике товара или услуги. | +| public | [getVatCode()](../classes/YooKassa-Model-ReceiptItem.md#method_getVatCode) | | Возвращает ставку НДС | +| public | [increasePrice()](../classes/YooKassa-Model-ReceiptItem.md#method_increasePrice) | | Увеличивает цену товара на указанную величину | +| public | [isShipping()](../classes/YooKassa-Model-ReceiptItem.md#method_isShipping) | | Проверяет, является ли текущий элемент чека доставкой | +| public | [jsonSerialize()](../classes/YooKassa-Model-ReceiptItem.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAgentType()](../classes/YooKassa-Model-ReceiptItem.md#method_setAgentType) | | Устанавливает тип посредника, реализующего товар или услугу | +| public | [setCountryOfOriginCode()](../classes/YooKassa-Model-ReceiptItem.md#method_setCountryOfOriginCode) | | Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира | +| public | [setCustomsDeclarationNumber()](../classes/YooKassa-Model-ReceiptItem.md#method_setCustomsDeclarationNumber) | | Устанавливает номер таможенной декларации (от 1 до 32 символов) | +| public | [setDescription()](../classes/YooKassa-Model-ReceiptItem.md#method_setDescription) | | Устанавливает наименование товара | +| public | [setExcise()](../classes/YooKassa-Model-ReceiptItem.md#method_setExcise) | | Устанавливает сумму акциза товара с учетом копеек | +| public | [setIsShipping()](../classes/YooKassa-Model-ReceiptItem.md#method_setIsShipping) | | Устанавливает флаг доставки для текущего объекта айтема в чеке | +| public | [setPaymentMode()](../classes/YooKassa-Model-ReceiptItem.md#method_setPaymentMode) | | Устанавливает признак способа расчета | +| public | [setPaymentSubject()](../classes/YooKassa-Model-ReceiptItem.md#method_setPaymentSubject) | | Устанавливает признак предмета расчета | +| public | [setPrice()](../classes/YooKassa-Model-ReceiptItem.md#method_setPrice) | | Устанавливает цену товара | +| public | [setProductCode()](../classes/YooKassa-Model-ReceiptItem.md#method_setProductCode) | | Устанавливает код товара — уникальный номер, который присваивается экземпляру товара при маркировке | +| public | [setQuantity()](../classes/YooKassa-Model-ReceiptItem.md#method_setQuantity) | | Устанавливает количество покупаемого товара | +| public | [setSupplier()](../classes/YooKassa-Model-ReceiptItem.md#method_setSupplier) | | Устанавливает информацию о поставщике товара или услуги. | +| public | [setVatCode()](../classes/YooKassa-Model-ReceiptItem.md#method_setVatCode) | | Устанавливает ставку НДС | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/ReceiptItem.php](../../lib/Model/ReceiptItem.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\ReceiptItem +* Implements: + * [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) +--- +## Properties + +#### public $amount : float +--- +***Description*** + +Суммарная стоимость покупаемого товара в копейках/центах + +**Type:** float + +**Details:** + + + +#### public $country_of_origin_code : string +--- +***Description*** + +Код страны происхождения товара + +**Type:** string + +**Details:** + + + +#### public $countryOfOriginCode : string +--- +***Description*** + +Код страны происхождения товара + +**Type:** string + +**Details:** + + + +#### public $customs_declaration_number : string +--- +***Description*** + +Номер таможенной декларации (от 1 до 32 символов) + +**Type:** string + +**Details:** + + + +#### public $customsDeclarationNumber : string +--- +***Description*** + +Номер таможенной декларации (от 1 до 32 символов) + +**Type:** string + +**Details:** + + + +#### public $description : string +--- +***Description*** + +Наименование товара + +**Type:** string + +**Details:** + + + +#### public $excise : float +--- +***Description*** + +Сумма акциза товара с учетом копеек + +**Type:** float + +**Details:** + + + +#### public $isShipping : bool +--- +***Description*** + +Флаг доставки + +**Type:** bool + +**Details:** + + + +#### public $payment_mode : string +--- +***Description*** + +Признак способа расчета + +**Type:** string + +**Details:** + + + +#### public $payment_subject : string +--- +***Description*** + +Признак предмета расчета + +**Type:** string + +**Details:** + + + +#### public $paymentMode : string +--- +***Description*** + +Признак способа расчета + +**Type:** string + +**Details:** + + + +#### public $paymentSubject : string +--- +***Description*** + +Признак предмета расчета + +**Type:** string + +**Details:** + + + +#### public $price : \YooKassa\Model\AmountInterface +--- +***Description*** + +Цена товара + +**Type:** AmountInterface + +**Details:** + + + +#### public $product_code : string +--- +***Description*** + +Код товара + +**Type:** string + +**Details:** + + + +#### public $productCode : string +--- +***Description*** + +Код товара + +**Type:** string + +**Details:** + + + +#### public $quantity : float +--- +***Description*** + +Количество + +**Type:** float + +**Details:** + + + +#### public $supplier : \YooKassa\Model\Supplier +--- +***Description*** + +Информация о поставщике товара или услуги + +**Type:** Supplier + +**Details:** + + + +#### public $vat_code : int +--- +***Description*** + +Ставка НДС, число 1-6 + +**Type:** int + +**Details:** + + + +#### public $vatCode : int +--- +***Description*** + +Ставка НДС, число 1-6 + +**Type:** int + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array|null data = null) : mixed +``` + +**Summary** + +ReceiptItem constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | data | Массив для инициализации нового объекта | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public applyDiscountCoefficient() : mixed + +```php +public applyDiscountCoefficient(float coefficient) : mixed +``` + +**Summary** + +Применяет для товара скидку + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float | coefficient | Множитель скидки | + +**Returns:** mixed - + + + +#### public fetchItem() : \YooKassa\Model\ReceiptItem + +```php +public fetchItem(float count) : \YooKassa\Model\ReceiptItem +``` + +**Summary** + +Уменьшает количество покупаемого товара на указанное, возвращает объект позиции в чеке с уменьшаемым количеством + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float | count | Количество на которое уменьшаем позицию в чеке | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если в качестве аргумента был передан ноль или отрицательное число, или число больше текущего количества покупаемого товара | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента было передано не число | + +**Returns:** \YooKassa\Model\ReceiptItem - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAgentType() : string + +```php +public getAgentType() : string +``` + +**Summary** + +Возвращает тип посредника, реализующего товар или услугу + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string - Тип посредника + + + +#### public getAmount() : int + +```php +public getAmount() : int +``` + +**Summary** + +Возвращает общую стоимость покупаемого товара в копейках/центах + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** int - Сумма стоимости покупаемого товара + + + +#### public getCountryOfOriginCode() : string|null + +```php +public getCountryOfOriginCode() : string|null +``` + +**Summary** + +Возвращает код страны происхождения товара по общероссийскому классификатору стран мира + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string|null - Код страны происхождения товара + + + +#### public getCustomsDeclarationNumber() : string|null + +```php +public getCustomsDeclarationNumber() : string|null +``` + +**Summary** + +Возвращает номер таможенной декларации + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string|null - Номер таможенной декларации (от 1 до 32 символов) + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает наименование товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string - Наименование товара + + + +#### public getExcise() : float|null + +```php +public getExcise() : float|null +``` + +**Summary** + +Возвращает сумму акциза товара с учетом копеек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** float|null - Сумма акциза товара с учетом копеек + + + +#### public getPaymentMode() : string|null + +```php +public getPaymentMode() : string|null +``` + +**Summary** + +Возвращает признак способа расчета + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string|null - Признак способа расчета + + + +#### public getPaymentSubject() : string|null + +```php +public getPaymentSubject() : string|null +``` + +**Summary** + +Возвращает признак предмета расчета + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string|null - Признак предмета расчета + + + +#### public getPrice() : \YooKassa\Model\AmountInterface + +```php +public getPrice() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает цену товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** \YooKassa\Model\AmountInterface - Цена товара + + + +#### public getProductCode() : string|null + +```php +public getProductCode() : string|null +``` + +**Summary** + +Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** string|null - Код товара + + + +#### public getQuantity() : float + +```php +public getQuantity() : float +``` + +**Summary** + +Возвращает количество товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** float - Количество купленного товара + + + +#### public getSupplier() : \YooKassa\Model\Supplier + +```php +public getSupplier() : \YooKassa\Model\Supplier +``` + +**Summary** + +Возвращает информацию о поставщике товара или услуги. + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** \YooKassa\Model\Supplier - + + + +#### public getVatCode() : int|null + +```php +public getVatCode() : int|null +``` + +**Summary** + +Возвращает ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** int|null - Ставка НДС, число 1-6, или null если ставка не задана + + + +#### public increasePrice() : mixed + +```php +public increasePrice(float value) : mixed +``` + +**Summary** + +Увеличивает цену товара на указанную величину + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float | value | Сумма на которую цену товара увеличиваем | + +**Returns:** mixed - + + + +#### public isShipping() : bool + +```php +public isShipping() : bool +``` + +**Summary** + +Проверяет, является ли текущий элемент чека доставкой + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** bool - True если доставка, false если обычный товар + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) + +**Returns:** array - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAgentType() : mixed + +```php +public setAgentType(string value) : mixed +``` + +**Summary** + +Устанавливает тип посредника, реализующего товар или услугу + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип посредника | + +**Returns:** mixed - + + + +#### public setCountryOfOriginCode() : mixed + +```php +public setCountryOfOriginCode(string value) : mixed +``` + +**Summary** + +Устанавливает код страны происхождения товара по общероссийскому классификатору стран мира + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Код страны происхождения товара | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setCustomsDeclarationNumber() : mixed + +```php +public setCustomsDeclarationNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер таможенной декларации (от 1 до 32 символов) + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер таможенной декларации | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает наименование товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Наименование товара | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setExcise() : mixed + +```php +public setExcise(float value) : mixed +``` + +**Summary** + +Устанавливает сумму акциза товара с учетом копеек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| float | value | Сумма акциза товара с учетом копеек | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента было передано не число | + +**Returns:** mixed - + + + +#### public setIsShipping() : \YooKassa\Model\ReceiptItem + +```php +public setIsShipping(bool value) : \YooKassa\Model\ReceiptItem +``` + +**Summary** + +Устанавливает флаг доставки для текущего объекта айтема в чеке + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | True если айтем является доставкой, false если нет | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если передано значение невалидного типа | + +**Returns:** \YooKassa\Model\ReceiptItem - + + + +#### public setPaymentMode() : mixed + +```php +public setPaymentMode(string value) : mixed +``` + +**Summary** + +Устанавливает признак способа расчета + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Признак способа расчета | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setPaymentSubject() : mixed + +```php +public setPaymentSubject(string value) : mixed +``` + +**Summary** + +Устанавливает признак предмета расчета + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Признак предмета расчета | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setPrice() : mixed + +```php +public setPrice(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает цену товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Цена товара | + +**Returns:** mixed - + + + +#### public setProductCode() : mixed + +```php +public setProductCode(string|\YooKassa\Helpers\ProductCode value) : mixed +``` + +**Summary** + +Устанавливает код товара — уникальный номер, который присваивается экземпляру товара при маркировке + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR \YooKassa\Helpers\ProductCode | value | Код товара | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setQuantity() : mixed + +```php +public setQuantity(int value) : mixed +``` + +**Summary** + +Устанавливает количество покупаемого товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Количество | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если в качестве аргумента был передан ноль или отрицательное число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента было передано не число | + +**Returns:** mixed - + + + +#### public setSupplier() : mixed + +```php +public setSupplier(\YooKassa\Model\SupplierInterface|array value) : mixed +``` + +**Summary** + +Устанавливает информацию о поставщике товара или услуги. + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SupplierInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setVatCode() : mixed + +```php +public setVatCode(int value) : mixed +``` + +**Summary** + +Устанавливает ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Ставка НДС, число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если в качестве аргумента было передано число меньше одного или больше шести | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента было передано не число | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptItemInterface.md b/docs/classes/YooKassa-Model-ReceiptItemInterface.md new file mode 100644 index 00000000..fadb28ec --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptItemInterface.md @@ -0,0 +1,312 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ReceiptItemInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface ReceiptItemInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAgentType()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getAgentType) | | | +| public | [getAmount()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getAmount) | | Возвращает общую стоимость покупаемого товара в копейках/центах | +| public | [getCountryOfOriginCode()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getCountryOfOriginCode) | | Возвращает код страны происхождения товара по общероссийскому классификатору стран мира | +| public | [getCustomsDeclarationNumber()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getCustomsDeclarationNumber) | | Возвращает номер таможенной декларации | +| public | [getDescription()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getDescription) | | Возвращает наименование товара | +| public | [getExcise()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getExcise) | | Возвращает сумму акциза товара с учетом копеек | +| public | [getPaymentMode()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getPaymentMode) | | Возвращает признак способа расчета | +| public | [getPaymentSubject()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getPaymentSubject) | | Возвращает признак предмета расчета | +| public | [getPrice()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getPrice) | | Возвращает цену товара | +| public | [getProductCode()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getProductCode) | | Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке | +| public | [getQuantity()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getQuantity) | | Возвращает количество товара | +| public | [getSupplier()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getSupplier) | | Возвращает информацию о поставщике товара или услуги. | +| public | [getVatCode()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_getVatCode) | | Возвращает ставку НДС | +| public | [isShipping()](../classes/YooKassa-Model-ReceiptItemInterface.md#method_isShipping) | | Проверяет, является ли текущий элемент чека доставкой | + +--- +### Details +* File: [lib/Model/ReceiptItemInterface.php](../../lib/Model/ReceiptItemInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Наименование товара | +| property-read | | Количество | +| property-read | | Суммарная стоимость покупаемого товара в копейках/центах | +| property-read | | Цена товара | +| property-read | | Ставка НДС, число 1-6 | +| property-read | | Ставка НДС, число 1-6 | +| property-read | | Признак предмета расчета | +| property-read | | Признак предмета расчета | +| property-read | | Признак способа расчета | +| property-read | | Признак способа расчета | +| property-read | | Код товара | +| property-read | | Код товара | +| property-read | | Код страны происхождения товара | +| property-read | | Код страны происхождения товара | +| property-read | | Номер таможенной декларации (от 1 до 32 символов) | +| property-read | | Номер таможенной декларации (от 1 до 32 символов) | +| property-read | | Сумма акциза товара с учетом копеек | +--- +## Methods + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает наименование товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string - Наименование товара + + + +#### public getQuantity() : float + +```php +public getQuantity() : float +``` + +**Summary** + +Возвращает количество товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** float - Количество купленного товара + + + +#### public getAmount() : float + +```php +public getAmount() : float +``` + +**Summary** + +Возвращает общую стоимость покупаемого товара в копейках/центах + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** float - Сумма стоимости покупаемого товара + + + +#### public getPrice() : \YooKassa\Model\AmountInterface + +```php +public getPrice() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает цену товара + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Цена товара + + + +#### public getVatCode() : int|null + +```php +public getVatCode() : int|null +``` + +**Summary** + +Возвращает ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** int|null - Ставка НДС, число 1-6, или null если ставка не задана + + + +#### public getPaymentSubject() : string|null + +```php +public getPaymentSubject() : string|null +``` + +**Summary** + +Возвращает признак предмета расчета + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string|null - Признак предмета расчета + + + +#### public getPaymentMode() : string|null + +```php +public getPaymentMode() : string|null +``` + +**Summary** + +Возвращает признак способа расчета + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string|null - Признак способа расчета + + + +#### public getProductCode() : string|null + +```php +public getProductCode() : string|null +``` + +**Summary** + +Возвращает код товара — уникальный номер, который присваивается экземпляру товара при маркировке + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string|null - Код товара + + + +#### public getCountryOfOriginCode() : string|null + +```php +public getCountryOfOriginCode() : string|null +``` + +**Summary** + +Возвращает код страны происхождения товара по общероссийскому классификатору стран мира + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string|null - Код страны происхождения товара + + + +#### public getCustomsDeclarationNumber() : string|null + +```php +public getCustomsDeclarationNumber() : string|null +``` + +**Summary** + +Возвращает номер таможенной декларации + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string|null - Номер таможенной декларации (от 1 до 32 символов) + + + +#### public getExcise() : float|null + +```php +public getExcise() : float|null +``` + +**Summary** + +Возвращает сумму акциза товара с учетом копеек + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** float|null - Сумма акциза товара с учетом копеек + + + +#### public getSupplier() : \YooKassa\Model\SupplierInterface + +```php +public getSupplier() : \YooKassa\Model\SupplierInterface +``` + +**Summary** + +Возвращает информацию о поставщике товара или услуги. + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** \YooKassa\Model\SupplierInterface - + + + +#### public getAgentType() : string + +```php +public getAgentType() : string +``` + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** string - + + + +#### public isShipping() : bool + +```php +public isShipping() : bool +``` + +**Summary** + +Проверяет, является ли текущий элемент чека доставкой + +**Details:** +* Inherited From: [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) + +**Returns:** bool - True если доставка, false если обычный товар + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md b/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md new file mode 100644 index 00000000..bdaccad1 --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptRegistrationStatus.md @@ -0,0 +1,154 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ReceiptRegistrationStatus +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс с перечислением статусов доставки данных для чека в онлайн-кассу (`pending`, `succeeded` или `canceled`) + +**Description:** + +Состояние регистрации фискального чека: + + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PENDING](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_PENDING) | | | +| public | [SUCCEEDED](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_SUCCEEDED) | | | +| public | [CANCELED](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#constant_CANCELED) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-ReceiptRegistrationStatus.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/ReceiptRegistrationStatus.php](../../lib/Model/ReceiptRegistrationStatus.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\ReceiptRegistrationStatus +--- +## Constants + +###### PENDING +```php +PENDING = 'pending' : string +``` + + + +###### SUCCEEDED +```php +SUCCEEDED = 'succeeded' : string +``` + + + +###### CANCELED +```php +CANCELED = 'canceled' : string +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-ReceiptType.md b/docs/classes/YooKassa-Model-ReceiptType.md new file mode 100644 index 00000000..106cc625 --- /dev/null +++ b/docs/classes/YooKassa-Model-ReceiptType.md @@ -0,0 +1,153 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\ReceiptType +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +ReceiptType - Тип чека в онлайн-кассе. + +**Description:** + +|Код|Описание| +--- | --- +|payment|Приход| +|refund|Возврат| +|simple|Простой| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PAYMENT](../classes/YooKassa-Model-ReceiptType.md#constant_PAYMENT) | | | +| public | [REFUND](../classes/YooKassa-Model-ReceiptType.md#constant_REFUND) | | | +| public | [SIMPLE](../classes/YooKassa-Model-ReceiptType.md#constant_SIMPLE) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-ReceiptType.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/ReceiptType.php](../../lib/Model/ReceiptType.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\ReceiptType +--- +## Constants + +###### PAYMENT +```php +PAYMENT = 'payment' : string +``` + + + +###### REFUND +```php +REFUND = 'refund' : string +``` + + + +###### SIMPLE +```php +SIMPLE = 'simple' : string +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Recipient.md b/docs/classes/YooKassa-Model-Recipient.md new file mode 100644 index 00000000..47bae1fd --- /dev/null +++ b/docs/classes/YooKassa-Model-Recipient.md @@ -0,0 +1,481 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Recipient +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс получателя платежа. + +**Description:** + +Получатель платежа нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес +другого аккаунта. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$account_id](../classes/YooKassa-Model-Recipient.md#property_account_id) | | Идентификатор магазина | +| public | [$accountId](../classes/YooKassa-Model-Recipient.md#property_accountId) | | Идентификатор магазина | +| public | [$gateway_id](../classes/YooKassa-Model-Recipient.md#property_gateway_id) | | Идентификатор шлюза | +| public | [$gatewayId](../classes/YooKassa-Model-Recipient.md#property_gatewayId) | | Идентификатор шлюза | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAccountId()](../classes/YooKassa-Model-Recipient.md#method_getAccountId) | | Возвращает идентификатор магазина | +| public | [getGatewayId()](../classes/YooKassa-Model-Recipient.md#method_getGatewayId) | | Возвращает идентификатор шлюза. | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAccountId()](../classes/YooKassa-Model-Recipient.md#method_setAccountId) | | Устанавливает идентификатор магазина | +| public | [setGatewayId()](../classes/YooKassa-Model-Recipient.md#method_setGatewayId) | | Устанавливает идентификатор шлюза | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Recipient.php](../../lib/Model/Recipient.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Recipient +* Implements: + * [\YooKassa\Model\RecipientInterface](../classes/YooKassa-Model-RecipientInterface.md) +--- +## Properties + +#### public $account_id : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** + + + +#### public $accountId : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** + + + +#### public $gateway_id : string +--- +***Description*** + +Идентификатор шлюза + +**Type:** string + +**Details:** + + + +#### public $gatewayId : string +--- +***Description*** + +Идентификатор шлюза + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAccountId() : string + +```php +public getAccountId() : string +``` + +**Summary** + +Возвращает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\Recipient](../classes/YooKassa-Model-Recipient.md) + +**Returns:** string - Идентификатор магазина + + + +#### public getGatewayId() : string + +```php +public getGatewayId() : string +``` + +**Summary** + +Возвращает идентификатор шлюза. + +**Description** + +Идентификатор шлюза используется для разделения потоков платежей в рамках одного аккаунта. + +**Details:** +* Inherited From: [\YooKassa\Model\Recipient](../classes/YooKassa-Model-Recipient.md) + +**Returns:** string - Идентификатор шлюза + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAccountId() : mixed + +```php +public setAccountId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\Recipient](../classes/YooKassa-Model-Recipient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не строковое значение | + +**Returns:** mixed - + + + +#### public setGatewayId() : mixed + +```php +public setGatewayId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор шлюза + +**Details:** +* Inherited From: [\YooKassa\Model\Recipient](../classes/YooKassa-Model-Recipient.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор шлюза | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не строковое значение | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RecipientInterface.md b/docs/classes/YooKassa-Model-RecipientInterface.md new file mode 100644 index 00000000..cfc50701 --- /dev/null +++ b/docs/classes/YooKassa-Model-RecipientInterface.md @@ -0,0 +1,96 @@ +# [YooKassa API SDK](../home.md) + +# Interface: RecipientInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Интерфейс получателя платежа. + +**Description:** + +Получатель платежа нужен, если вы разделяете потоки платежей в рамках одного аккаунта или создаете платеж в адрес +другого аккаунта. + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAccountId()](../classes/YooKassa-Model-RecipientInterface.md#method_getAccountId) | | Возвращает идентификатор магазина | +| public | [getGatewayId()](../classes/YooKassa-Model-RecipientInterface.md#method_getGatewayId) | | Возвращает идентификатор шлюза. | + +--- +### Details +* File: [lib/Model/RecipientInterface.php](../../lib/Model/RecipientInterface.php) +* Package: \Default +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Идентификатор магазина | +| property-read | | Идентификатор магазина | +| property-read | | Идентификатор шлюза | +| property-read | | Идентификатор шлюза | +--- +## Methods + +#### public getAccountId() : string + +```php +public getAccountId() : string +``` + +**Summary** + +Возвращает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\RecipientInterface](../classes/YooKassa-Model-RecipientInterface.md) + +**Returns:** string - Идентификатор магазина + + + +#### public getGatewayId() : string + +```php +public getGatewayId() : string +``` + +**Summary** + +Возвращает идентификатор шлюза. + +**Description** + +Идентификатор шлюза используется для разделения потоков платежей в рамках одного аккаунта. + +**Details:** +* Inherited From: [\YooKassa\Model\RecipientInterface](../classes/YooKassa-Model-RecipientInterface.md) + +**Returns:** string - Идентификатор шлюза + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Refund.md b/docs/classes/YooKassa-Model-Refund.md new file mode 100644 index 00000000..dabee373 --- /dev/null +++ b/docs/classes/YooKassa-Model-Refund.md @@ -0,0 +1,863 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Refund +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс объекта с информацией о возврате платежа + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Refund.md#property_amount) | | Сумма возврата | +| public | [$created_at](../classes/YooKassa-Model-Refund.md#property_created_at) | | Время создания возврата | +| public | [$createdAt](../classes/YooKassa-Model-Refund.md#property_createdAt) | | Время создания возврата | +| public | [$description](../classes/YooKassa-Model-Refund.md#property_description) | | Комментарий, основание для возврата средств покупателю | +| public | [$id](../classes/YooKassa-Model-Refund.md#property_id) | | Идентификатор возврата платежа | +| public | [$payment_id](../classes/YooKassa-Model-Refund.md#property_payment_id) | | Идентификатор платежа | +| public | [$paymentId](../classes/YooKassa-Model-Refund.md#property_paymentId) | | Идентификатор платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Refund.md#property_receipt_registration) | | Статус регистрации чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Refund.md#property_receiptRegistration) | | Статус регистрации чека | +| public | [$status](../classes/YooKassa-Model-Refund.md#property_status) | | Статус возврата | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Refund.md#method_getAmount) | | Возвращает сумму возврата | +| public | [getCreatedAt()](../classes/YooKassa-Model-Refund.md#method_getCreatedAt) | | Возвращает дату создания возврата | +| public | [getDescription()](../classes/YooKassa-Model-Refund.md#method_getDescription) | | Возвращает комментарий к возврату | +| public | [getId()](../classes/YooKassa-Model-Refund.md#method_getId) | | Возвращает идентификатор возврата платежа | +| public | [getPaymentId()](../classes/YooKassa-Model-Refund.md#method_getPaymentId) | | Возвращает идентификатор платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_getReceiptRegistration) | | Возвращает статус регистрации чека | +| public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | | Возвращает инициатора платежа или возврата | +| public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | +| public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | +| public | [setDescription()](../classes/YooKassa-Model-Refund.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setId()](../classes/YooKassa-Model-Refund.md#method_setId) | | Устанавливает идентификатор возврата | +| public | [setPaymentId()](../classes/YooKassa-Model-Refund.md#method_setPaymentId) | | Устанавливает идентификатор платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_setReceiptRegistration) | | Устанавливает статус регистрации чека | +| public | [setRequestor()](../classes/YooKassa-Model-Refund.md#method_setRequestor) | | Устанавливает инициатора платежа или возврата | +| public | [setSources()](../classes/YooKassa-Model-Refund.md#method_setSources) | | Устанавливает sources (массив распределения денег между магазинами) | +| public | [setStatus()](../classes/YooKassa-Model-Refund.md#method_setStatus) | | Усианавливает стутус возврата платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Refund.php](../../lib/Model/Refund.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Refund +* Implements: + * [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** + + + +#### public $description : string +--- +***Description*** + +Комментарий, основание для возврата средств покупателю + +**Type:** string + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор возврата платежа + +**Type:** string + +**Details:** + + + +#### public $payment_id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** + + + +#### public $receipt_registration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** + + + +#### public $receiptRegistration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Статус возврата + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает дату создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \DateTime - Время создания возврата + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Комментарий, основание для возврата средств покупателю + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус регистрации чека + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\RequestorInterface - Инициатор платежа или возврата + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус текущего возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус возврата + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная сумма меньше или равна нулю | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime value) : mixed +``` + +**Summary** + +Устанавливает вермя создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Время создания возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если быо передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданную строку или число не удалось интерпретировать как дату и время | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если было передано значение невалидного типа | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий, основание для возврата средств покупателю | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус регистрации чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | Инициатор платежа или возврата | + +**Returns:** mixed - + + + +#### public setSources() : mixed + +```php +public setSources(\YooKassa\Model\SourceInterface[]|array value) : mixed +``` + +**Summary** + +Устанавливает sources (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Усианавливает стутус возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус возврата платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RefundInterface.md b/docs/classes/YooKassa-Model-RefundInterface.md new file mode 100644 index 00000000..be30f387 --- /dev/null +++ b/docs/classes/YooKassa-Model-RefundInterface.md @@ -0,0 +1,219 @@ +# [YooKassa API SDK](../home.md) + +# Interface: RefundInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface RefundInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Model-RefundInterface.md#method_getAmount) | | Возвращает сумму возврата | +| public | [getCreatedAt()](../classes/YooKassa-Model-RefundInterface.md#method_getCreatedAt) | | Возвращает дату создания возврата | +| public | [getDescription()](../classes/YooKassa-Model-RefundInterface.md#method_getDescription) | | Возвращает комментарий к возврату | +| public | [getId()](../classes/YooKassa-Model-RefundInterface.md#method_getId) | | Возвращает идентификатор возврата платежа | +| public | [getPaymentId()](../classes/YooKassa-Model-RefundInterface.md#method_getPaymentId) | | Возвращает идентификатор платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-RefundInterface.md#method_getReceiptRegistration) | | Возвращает статус регистрации чека | +| public | [getRequestor()](../classes/YooKassa-Model-RefundInterface.md#method_getRequestor) | | Возвращает информацию об инициаторе платежа или возврата | +| public | [getSources()](../classes/YooKassa-Model-RefundInterface.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [getStatus()](../classes/YooKassa-Model-RefundInterface.md#method_getStatus) | | Возвращает статус текущего возврата | + +--- +### Details +* File: [lib/Model/RefundInterface.php](../../lib/Model/RefundInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Идентификатор возврата платежа | +| property-read | | Идентификатор платежа | +| property-read | | Идентификатор платежа | +| property-read | | Статус возврата | +| property-read | | Время создания возврата | +| property-read | | Время создания возврата | +| property-read | | Сумма возврата | +| property-read | | Статус регистрации чека | +| property-read | | Статус регистрации чека | +| property-read | | Комментарий, основание для возврата средств покупателю | +--- +## Methods + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус текущего возврата + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** string - Статус возврата + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает дату создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** \DateTime - Время создания возврата + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** string - Статус регистрации чека + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** string - Комментарий, основание для возврата средств покупателю + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает информацию об инициаторе платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RefundStatus.md b/docs/classes/YooKassa-Model-RefundStatus.md new file mode 100644 index 00000000..540038af --- /dev/null +++ b/docs/classes/YooKassa-Model-RefundStatus.md @@ -0,0 +1,150 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\RefundStatus +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +RefundStatus - Состояние возврата платежа +|Код|Описание| +--- | --- +|pending|Ожидает обработки| +|succeeded|Успешно возвращен| +|canceled|В проведении возврата отказано| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PENDING](../classes/YooKassa-Model-RefundStatus.md#constant_PENDING) | | | +| public | [SUCCEEDED](../classes/YooKassa-Model-RefundStatus.md#constant_SUCCEEDED) | | | +| public | [CANCELED](../classes/YooKassa-Model-RefundStatus.md#constant_CANCELED) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-RefundStatus.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/RefundStatus.php](../../lib/Model/RefundStatus.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\RefundStatus +--- +## Constants + +###### PENDING +```php +PENDING = 'pending' +``` + + + +###### SUCCEEDED +```php +SUCCEEDED = 'succeeded' +``` + + + +###### CANCELED +```php +CANCELED = 'canceled' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Requestor.md b/docs/classes/YooKassa-Model-Requestor.md new file mode 100644 index 00000000..6b871650 --- /dev/null +++ b/docs/classes/YooKassa-Model-Requestor.md @@ -0,0 +1,618 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Requestor +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Инициатор платежа или возврата. + +**Description:** + +Инициатором может быть магазин, подключенный к ЮKassa, `merchant` или приложение, которому владелец магазина +[разрешил](https://yookassa.ru/developers/partners-api/basics) совершать операции от своего имени `third_party_client`. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$account_id](../classes/YooKassa-Model-Requestor.md#property_account_id) | | Идентификатор магазина | +| public | [$accountId](../classes/YooKassa-Model-Requestor.md#property_accountId) | | Идентификатор магазина | +| public | [$client_id](../classes/YooKassa-Model-Requestor.md#property_client_id) | | Идентификатор приложения | +| public | [$client_name](../classes/YooKassa-Model-Requestor.md#property_client_name) | | Название приложения (только для type = RequestorThirdPartyService) | +| public | [$clientId](../classes/YooKassa-Model-Requestor.md#property_clientId) | | Идентификатор приложения | +| public | [$clientName](../classes/YooKassa-Model-Requestor.md#property_clientName) | | Название приложения (только для type = RequestorThirdPartyService) | +| public | [$type](../classes/YooKassa-Model-Requestor.md#property_type) | | Тип инициатора | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Requestor.md#method___construct) | | Requestor constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAccountId()](../classes/YooKassa-Model-Requestor.md#method_getAccountId) | | Возвращает идентификатор магазина | +| public | [getClientId()](../classes/YooKassa-Model-Requestor.md#method_getClientId) | | Возвращает идентификатор приложения | +| public | [getClientName()](../classes/YooKassa-Model-Requestor.md#method_getClientName) | | Возвращает название приложения | +| public | [getType()](../classes/YooKassa-Model-Requestor.md#method_getType) | | Возвращает тип инициатора | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAccountId()](../classes/YooKassa-Model-Requestor.md#method_setAccountId) | | Устанавливает идентификатор магазина | +| public | [setClientId()](../classes/YooKassa-Model-Requestor.md#method_setClientId) | | Устанавливает идентификатор приложения | +| public | [setClientName()](../classes/YooKassa-Model-Requestor.md#method_setClientName) | | Устанавливает название приложения | +| public | [setType()](../classes/YooKassa-Model-Requestor.md#method_setType) | | Устанавливает тип инициатора | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Requestor.php](../../lib/Model/Requestor.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Requestor +* Implements: + * [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) +--- +## Properties + +#### public $account_id : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** + + + +#### public $accountId : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** + + + +#### public $client_id : string +--- +***Description*** + +Идентификатор приложения + +**Type:** string + +**Details:** + + + +#### public $client_name : string +--- +***Description*** + +Название приложения (только для type = RequestorThirdPartyService) + +**Type:** string + +**Details:** + + + +#### public $clientId : string +--- +***Description*** + +Идентификатор приложения + +**Type:** string + +**Details:** + + + +#### public $clientName : string +--- +***Description*** + +Название приложения (только для type = RequestorThirdPartyService) + +**Type:** string + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип инициатора + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(null|array data = null) : mixed +``` + +**Summary** + +Requestor constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| null OR array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAccountId() : string|null + +```php +public getAccountId() : string|null +``` + +**Summary** + +Возвращает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getClientId() : string|null + +```php +public getClientId() : string|null +``` + +**Summary** + +Возвращает идентификатор приложения + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getClientName() : string|null + +```php +public getClientName() : string|null +``` + +**Summary** + +Возвращает название приложения + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип инициатора + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAccountId() : mixed + +```php +public setAccountId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public setClientId() : mixed + +```php +public setClientId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор приложения + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор приложения | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public setClientName() : mixed + +```php +public setClientName(string value) : mixed +``` + +**Summary** + +Устанавливает название приложения + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название приложения | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип инициатора + +**Details:** +* Inherited From: [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип инициатора | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-RequestorInterface.md b/docs/classes/YooKassa-Model-RequestorInterface.md new file mode 100644 index 00000000..7e756d58 --- /dev/null +++ b/docs/classes/YooKassa-Model-RequestorInterface.md @@ -0,0 +1,210 @@ +# [YooKassa API SDK](../home.md) + +# Interface: RequestorInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface RequestorInterface + +**Description:** + +Инициатор платежа или возврата + +Инициатором может быть магазин, подключенный к ЮKassa, `merchant` или приложение, которому владелец магазина +[разрешил](https://yookassa.ru/developers/partners-api/basics) совершать операции от своего имени `third_party_client`. + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAccountId()](../classes/YooKassa-Model-RequestorInterface.md#method_getAccountId) | | Возвращает идентификатор магазина | +| public | [getClientId()](../classes/YooKassa-Model-RequestorInterface.md#method_getClientId) | | Возвращает идентификатор приложения | +| public | [getClientName()](../classes/YooKassa-Model-RequestorInterface.md#method_getClientName) | | Возвращает название приложения | +| public | [getType()](../classes/YooKassa-Model-RequestorInterface.md#method_getType) | | Возвращает тип инициатора | +| public | [setAccountId()](../classes/YooKassa-Model-RequestorInterface.md#method_setAccountId) | | Устанавливает идентификатор магазина | +| public | [setClientId()](../classes/YooKassa-Model-RequestorInterface.md#method_setClientId) | | Устанавливает идентификатор приложения | +| public | [setClientName()](../classes/YooKassa-Model-RequestorInterface.md#method_setClientName) | | Устанавливает название приложения | +| public | [setType()](../classes/YooKassa-Model-RequestorInterface.md#method_setType) | | Устанавливает тип инициатора | + +--- +### Details +* File: [lib/Model/RequestorInterface.php](../../lib/Model/RequestorInterface.php) +* Package: \YooKassa +--- +## Methods + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип инициатора + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) + +**Returns:** string - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает тип инициатора + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип инициатора | + +**Returns:** mixed - + + + +#### public getAccountId() : string|null + +```php +public getAccountId() : string|null +``` + +**Summary** + +Возвращает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) + +**Returns:** string|null - + + + +#### public setAccountId() : mixed + +```php +public setAccountId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор магазина + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина | + +**Returns:** mixed - + + + +#### public getClientId() : string|null + +```php +public getClientId() : string|null +``` + +**Summary** + +Возвращает идентификатор приложения + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) + +**Returns:** string|null - + + + +#### public setClientId() : mixed + +```php +public setClientId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор приложения + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор приложения | + +**Returns:** mixed - + + + +#### public getClientName() : string|null + +```php +public getClientName() : string|null +``` + +**Summary** + +Возвращает название приложения + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) + +**Returns:** string|null - + + + +#### public setClientName() : mixed + +```php +public setClientName(string value) : mixed +``` + +**Summary** + +Устанавливает название приложения + +**Details:** +* Inherited From: [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Название приложения | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Settlement.md b/docs/classes/YooKassa-Model-Settlement.md new file mode 100644 index 00000000..3842f15d --- /dev/null +++ b/docs/classes/YooKassa-Model-Settlement.md @@ -0,0 +1,436 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Settlement +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Class Settlement + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Settlement.md#property_amount) | | Размер оплаты | +| public | [$type](../classes/YooKassa-Model-Settlement.md#property_type) | | Вид оплаты в чеке | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Settlement.md#method___construct) | | Settlement constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Settlement.md#method_getAmount) | | Возвращает размер оплаты | +| public | [getType()](../classes/YooKassa-Model-Settlement.md#method_getType) | | Возвращает вид оплаты в чеке (cashless | prepayment | postpayment | consideration) | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Settlement.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setType()](../classes/YooKassa-Model-Settlement.md#method_setType) | | Устанавливает вид оплаты в чеке | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Settlement.php](../../lib/Model/Settlement.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Settlement +* Implements: + * [\YooKassa\Model\SettlementInterface](../classes/YooKassa-Model-SettlementInterface.md) +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Размер оплаты + +**Type:** AmountInterface + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Вид оплаты в чеке + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = null) : mixed +``` + +**Summary** + +Settlement constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает размер оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) + +**Returns:** \YooKassa\Model\AmountInterface - Размер оплаты + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает вид оплаты в чеке (cashless | prepayment | postpayment | consideration) + +**Details:** +* Inherited From: [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) + +**Returns:** string - Вид оплаты в чеке + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface|array value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает вид оплаты в чеке + +**Details:** +* Inherited From: [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SettlementInterface.md b/docs/classes/YooKassa-Model-SettlementInterface.md new file mode 100644 index 00000000..73bc58b1 --- /dev/null +++ b/docs/classes/YooKassa-Model-SettlementInterface.md @@ -0,0 +1,85 @@ +# [YooKassa API SDK](../home.md) + +# Interface: SettlementInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface PostReceiptResponseSettlementInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Model-SettlementInterface.md#method_getAmount) | | Возвращает размер оплаты | +| public | [getType()](../classes/YooKassa-Model-SettlementInterface.md#method_getType) | | Возвращает вид оплаты в чеке (cashless | prepayment | postpayment | consideration) | + +--- +### Details +* File: [lib/Model/SettlementInterface.php](../../lib/Model/SettlementInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Вид оплаты в чеке | +| property-read | | Размер оплаты | +--- +## Methods + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает вид оплаты в чеке (cashless | prepayment | postpayment | consideration) + +**Details:** +* Inherited From: [\YooKassa\Model\SettlementInterface](../classes/YooKassa-Model-SettlementInterface.md) + +**Returns:** string - Вид оплаты в чеке + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает размер оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\SettlementInterface](../classes/YooKassa-Model-SettlementInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Размер оплаты + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Source.md b/docs/classes/YooKassa-Model-Source.md new file mode 100644 index 00000000..72d42914 --- /dev/null +++ b/docs/classes/YooKassa-Model-Source.md @@ -0,0 +1,557 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Source +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс объекта распределения денег в магазин + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$accountId](../classes/YooKassa-Model-Source.md#property_accountId) | | Идентификатор магазина, для которого вы хотите провести возврат | +| public | [$amount](../classes/YooKassa-Model-Source.md#property_amount) | | Сумма возврата | +| public | [$platform_fee_amount](../classes/YooKassa-Model-Source.md#property_platform_fee_amount) | | Комиссия, которую вы удержали при оплате, и хотите вернуть | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Source.md#method___construct) | | Transfer constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAccountId()](../classes/YooKassa-Model-Source.md#method_getAccountId) | | Возвращает id магазина с которого будут списаны средства | +| public | [getAmount()](../classes/YooKassa-Model-Source.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [hasAmount()](../classes/YooKassa-Model-Source.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_hasPlatformFeeAmount) | | Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAccountId()](../classes/YooKassa-Model-Source.md#method_setAccountId) | | Устаналивает id магазина-получателя средств | +| public | [setAmount()](../classes/YooKassa-Model-Source.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setPlatformFeeAmount()](../classes/YooKassa-Model-Source.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Source.php](../../lib/Model/Source.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Source +* Implements: + * [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) +--- +## Properties + +#### public $accountId : string +--- +***Description*** + +Идентификатор магазина, для которого вы хотите провести возврат + +**Type:** string + +**Details:** + + + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** + + + +#### public $platform_fee_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Комиссия, которую вы удержали при оплате, и хотите вернуть + +**Type:** AmountInterface + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = null) : mixed +``` + +**Summary** + +Transfer constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAccountId() : string|null + +```php +public getAccountId() : string|null +``` + +**Summary** + +Возвращает id магазина с которого будут списаны средства + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface + +```php +public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма комиссии + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public hasPlatformFeeAmount() : bool + +```php +public hasPlatformFeeAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) + +**Returns:** bool - True если комиссия была установлена, false если нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAccountId() : void + +```php +public setAccountId(mixed value) : void +``` + +**Summary** + +Устаналивает id магазина-получателя средств + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | | + +**Returns:** void - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public setAmount() : mixed + +```php +public setAmount(mixed value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Сумма оплаты | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public setPlatformFeeAmount() : mixed + +```php +public setPlatformFeeAmount(mixed value) : mixed +``` + +**Summary** + +Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Сумма комиссии | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SourceInterface.md b/docs/classes/YooKassa-Model-SourceInterface.md new file mode 100644 index 00000000..d77bc373 --- /dev/null +++ b/docs/classes/YooKassa-Model-SourceInterface.md @@ -0,0 +1,206 @@ +# [YooKassa API SDK](../home.md) + +# Interface: SourceInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface TransferInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAccountId()](../classes/YooKassa-Model-SourceInterface.md#method_getAccountId) | | Возвращает id магазина с которого будут списаны средства | +| public | [getAmount()](../classes/YooKassa-Model-SourceInterface.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getPlatformFeeAmount()](../classes/YooKassa-Model-SourceInterface.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [hasAmount()](../classes/YooKassa-Model-SourceInterface.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-SourceInterface.md#method_hasPlatformFeeAmount) | | Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [setAccountId()](../classes/YooKassa-Model-SourceInterface.md#method_setAccountId) | | Устаналивает id магазина-получателя средств | +| public | [setAmount()](../classes/YooKassa-Model-SourceInterface.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setPlatformFeeAmount()](../classes/YooKassa-Model-SourceInterface.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | + +--- +### Details +* File: [lib/Model/SourceInterface.php](../../lib/Model/SourceInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property | | Сумма возврата | +| property | | Комиссия, которую вы удержали при оплате, и хотите вернуть | +| property | | Идентификатор магазина, для которого вы хотите провести возврат | +--- +## Methods + +#### public setAccountId() : void + +```php +public setAccountId(string value) : void +``` + +**Summary** + +Устаналивает id магазина-получателя средств + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** void - + + + +#### public getAccountId() : string|null + +```php +public getAccountId() : string|null +``` + +**Summary** + +Возвращает id магазина с которого будут списаны средства + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) + +**Returns:** string|null - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface|array value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface + +```php +public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма комиссии + + + +#### public hasPlatformFeeAmount() : bool + +```php +public hasPlatformFeeAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) + +**Returns:** bool - True если комиссия была установлена, false если нет + + + +#### public setPlatformFeeAmount() : mixed + +```php +public setPlatformFeeAmount(\YooKassa\Model\AmountInterface|array value) : mixed +``` + +**Summary** + +Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array | value | Сумма комиссии | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Supplier.md b/docs/classes/YooKassa-Model-Supplier.md new file mode 100644 index 00000000..5abe2684 --- /dev/null +++ b/docs/classes/YooKassa-Model-Supplier.md @@ -0,0 +1,493 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Supplier +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Информация о поставщике товара или услуги. + +**Description:** + +Можно передавать, если вы отправляете данные для формирования чека по сценарию - сначала платеж, потом чек. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$inn](../classes/YooKassa-Model-Supplier.md#property_inn) | | ИНН пользователя (10 или 12 цифр) | +| public | [$name](../classes/YooKassa-Model-Supplier.md#property_name) | | Наименование поставщика | +| public | [$phone](../classes/YooKassa-Model-Supplier.md#property_phone) | | Телефон пользователя. Указывается в формате ITU-T E.164 | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Supplier.md#method___construct) | | Supplier constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getInn()](../classes/YooKassa-Model-Supplier.md#method_getInn) | | Возвращает ИНН пользователя (10 или 12 цифр) | +| public | [getName()](../classes/YooKassa-Model-Supplier.md#method_getName) | | Возвращает наименование поставщика | +| public | [getPhone()](../classes/YooKassa-Model-Supplier.md#method_getPhone) | | Возвращает Телефон пользователя. Указывается в формате ITU-T E.164 | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setInn()](../classes/YooKassa-Model-Supplier.md#method_setInn) | | Устанавливает ИНН пользователя (10 или 12 цифр) | +| public | [setName()](../classes/YooKassa-Model-Supplier.md#method_setName) | | Устанавливает наименование поставщика | +| public | [setPhone()](../classes/YooKassa-Model-Supplier.md#method_setPhone) | | Устанавливает Телефон пользователя. Указывается в формате ITU-T E.164 | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Supplier.php](../../lib/Model/Supplier.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Supplier +* Implements: + * [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) +--- +## Properties + +#### public $inn : string +--- +***Description*** + +ИНН пользователя (10 или 12 цифр) + +**Type:** string + +**Details:** + + + +#### public $name : string +--- +***Description*** + +Наименование поставщика + +**Type:** string + +**Details:** + + + +#### public $phone : string +--- +***Description*** + +Телефон пользователя. Указывается в формате ITU-T E.164 + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(null|array data = null) : mixed +``` + +**Summary** + +Supplier constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| null OR array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getInn() : string + +```php +public getInn() : string +``` + +**Summary** + +Возвращает ИНН пользователя (10 или 12 цифр) + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) + +**Returns:** string - + + + +#### public getName() : string + +```php +public getName() : string +``` + +**Summary** + +Возвращает наименование поставщика + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) + +**Returns:** string - + + + +#### public getPhone() : string + +```php +public getPhone() : string +``` + +**Summary** + +Возвращает Телефон пользователя. Указывается в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) + +**Returns:** string - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setInn() : mixed + +```php +public setInn(string value) : mixed +``` + +**Summary** + +Устанавливает ИНН пользователя (10 или 12 цифр) + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | ИНН пользователя (10 или 12 цифр) | + +**Returns:** mixed - + + + +#### public setName() : mixed + +```php +public setName(string value) : mixed +``` + +**Summary** + +Устанавливает наименование поставщика + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Наименование поставщика | + +**Returns:** mixed - + + + +#### public setPhone() : mixed + +```php +public setPhone(string value) : mixed +``` + +**Summary** + +Устанавливает Телефон пользователя. Указывается в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер телефона пользователя в формате ITU-T E.164 | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-SupplierInterface.md b/docs/classes/YooKassa-Model-SupplierInterface.md new file mode 100644 index 00000000..7318acca --- /dev/null +++ b/docs/classes/YooKassa-Model-SupplierInterface.md @@ -0,0 +1,176 @@ +# [YooKassa API SDK](../home.md) + +# Interface: SupplierInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface SupplierInterface + +**Description:** + +Информация о поставщике товара или услуги. + +Можно передавать, если вы отправляете данные для формирования чека по сценарию - сначала платеж, потом чек. + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getInn()](../classes/YooKassa-Model-SupplierInterface.md#method_getInn) | | Возвращает ИНН пользователя (10 или 12 цифр) | +| public | [getName()](../classes/YooKassa-Model-SupplierInterface.md#method_getName) | | Возвращает наименование поставщика | +| public | [getPhone()](../classes/YooKassa-Model-SupplierInterface.md#method_getPhone) | | Возвращает Телефон пользователя. Указывается в формате ITU-T E.164 | +| public | [setInn()](../classes/YooKassa-Model-SupplierInterface.md#method_setInn) | | Устанавливает ИНН пользователя (10 или 12 цифр) | +| public | [setName()](../classes/YooKassa-Model-SupplierInterface.md#method_setName) | | Устанавливает наименование поставщика | +| public | [setPhone()](../classes/YooKassa-Model-SupplierInterface.md#method_setPhone) | | Устанавливает Телефон пользователя. Указывается в формате ITU-T E.164 | + +--- +### Details +* File: [lib/Model/SupplierInterface.php](../../lib/Model/SupplierInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property | | Наименование поставщика | +| property | | Телефон пользователя. Указывается в формате ITU-T E.164 | +| property | | ИНН пользователя (10 или 12 цифр) | +--- +## Methods + +#### public getName() : string|null + +```php +public getName() : string|null +``` + +**Summary** + +Возвращает наименование поставщика + +**Details:** +* Inherited From: [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) + +**Returns:** string|null - + + + +#### public setName() : mixed + +```php +public setName(string|null value) : mixed +``` + +**Summary** + +Устанавливает наименование поставщика + +**Details:** +* Inherited From: [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Наименование поставщика | + +**Returns:** mixed - + + + +#### public getPhone() : string|null + +```php +public getPhone() : string|null +``` + +**Summary** + +Возвращает Телефон пользователя. Указывается в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) + +**Returns:** string|null - Телефон пользователя + + + +#### public setPhone() : mixed + +```php +public setPhone(string|null value) : mixed +``` + +**Summary** + +Устанавливает Телефон пользователя. Указывается в формате ITU-T E.164 + +**Details:** +* Inherited From: [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Телефон пользователя | + +**Returns:** mixed - + + + +#### public getInn() : string|null + +```php +public getInn() : string|null +``` + +**Summary** + +Возвращает ИНН пользователя (10 или 12 цифр) + +**Details:** +* Inherited From: [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) + +**Returns:** string|null - ИНН пользователя + + + +#### public setInn() : mixed + +```php +public setInn( value) : mixed +``` + +**Summary** + +Устанавливает ИНН пользователя (10 или 12 цифр) + +**Details:** +* Inherited From: [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | ИНН пользователя | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Transfer.md b/docs/classes/YooKassa-Model-Transfer.md new file mode 100644 index 00000000..8b35d975 --- /dev/null +++ b/docs/classes/YooKassa-Model-Transfer.md @@ -0,0 +1,702 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Transfer +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Класс объекта распределения денег в магазин + +**Description:** + +Данные о распределении денег — сколько и в какой магазин нужно перевести. +Присутствует, если вы используете решение ЮKassa для платформ. + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$accountId](../classes/YooKassa-Model-Transfer.md#property_accountId) | | Идентификатор магазина, в пользу которого вы принимаете оплату | +| public | [$amount](../classes/YooKassa-Model-Transfer.md#property_amount) | | Сумма, которую необходимо перечислить магазину | +| public | [$metadata](../classes/YooKassa-Model-Transfer.md#property_metadata) | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) | +| public | [$platform_fee_amount](../classes/YooKassa-Model-Transfer.md#property_platform_fee_amount) | | Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [$status](../classes/YooKassa-Model-Transfer.md#property_status) | | Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Model-Transfer.md#method___construct) | | Transfer constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAccountId()](../classes/YooKassa-Model-Transfer.md#method_getAccountId) | | Возвращает идентификатор магазина-получателя средств | +| public | [getAmount()](../classes/YooKassa-Model-Transfer.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getMetadata()](../classes/YooKassa-Model-Transfer.md#method_getMetadata) | | Возвращает метаданные | +| public | [getPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [getStatus()](../classes/YooKassa-Model-Transfer.md#method_getStatus) | | Возвращает статус операции распределения средств конечному получателю | +| public | [hasAmount()](../classes/YooKassa-Model-Transfer.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasMetadata()](../classes/YooKassa-Model-Transfer.md#method_hasMetadata) | | Проверяет были ли установлены метаданные | +| public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.md#method_hasPlatformFeeAmount) | | Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAccountId()](../classes/YooKassa-Model-Transfer.md#method_setAccountId) | | Устанавливает идентификатор магазина-получателя средств | +| public | [setAmount()](../classes/YooKassa-Model-Transfer.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setMetadata()](../classes/YooKassa-Model-Transfer.md#method_setMetadata) | | Устанавливает метаданные | +| public | [setPlatformFeeAmount()](../classes/YooKassa-Model-Transfer.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [setStatus()](../classes/YooKassa-Model-Transfer.md#method_setStatus) | | Устанавливает статус операции распределения средств конечному получателю | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Transfer.php](../../lib/Model/Transfer.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Transfer +* Implements: + * [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) +--- +## Properties + +#### public $accountId : string +--- +***Description*** + +Идентификатор магазина, в пользу которого вы принимаете оплату + +**Type:** string + +**Details:** + + + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма, которую необходимо перечислить магазину + +**Type:** AmountInterface + +**Details:** + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) + +**Type:** Metadata + +**Details:** + + + +#### public $platform_fee_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Type:** AmountInterface + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = null) : mixed +``` + +**Summary** + +Transfer constructor. + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAccountId() : string|null + +```php +public getAccountId() : string|null +``` + +**Summary** + +Возвращает идентификатор магазина-получателя средств + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** string|null - Идентификатор магазина-получателя средств + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public getMetadata() : \YooKassa\Model\Metadata|null + +```php +public getMetadata() : \YooKassa\Model\Metadata|null +``` + +**Summary** + +Возвращает метаданные + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** \YooKassa\Model\Metadata|null - Метаданные + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface + +```php +public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма комиссии + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус операции распределения средств конечному получателю + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** string|null - Статус операции распределения средств конечному получателю + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public hasMetadata() : bool + +```php +public hasMetadata() : bool +``` + +**Summary** + +Проверяет были ли установлены метаданные + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** bool - True если метаданные были установлены, false если нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public hasPlatformFeeAmount() : bool + +```php +public hasPlatformFeeAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) + +**Returns:** bool - True если комиссия была установлена, false если нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAccountId() : void + +```php +public setAccountId(mixed value) : void +``` + +**Summary** + +Устанавливает идентификатор магазина-получателя средств + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Идентификатор магазина-получателя средств | + +**Returns:** void - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public setAmount() : mixed + +```php +public setAmount(mixed value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Сумма оплаты | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public setMetadata() : mixed + +```php +public setMetadata(mixed value) : mixed +``` + +**Summary** + +Устанавливает метаданные + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Метаданные | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public setPlatformFeeAmount() : mixed + +```php +public setPlatformFeeAmount(mixed value) : mixed +``` + +**Summary** + +Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Сумма комиссии | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritDoc | | | + + +#### public setStatus() : mixed + +```php +public setStatus(string|null value) : mixed +``` + +**Summary** + +Устанавливает статус операции распределения средств конечному получателю + +**Details:** +* Inherited From: [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-TransferInterface.md b/docs/classes/YooKassa-Model-TransferInterface.md new file mode 100644 index 00000000..cbf9ef37 --- /dev/null +++ b/docs/classes/YooKassa-Model-TransferInterface.md @@ -0,0 +1,311 @@ +# [YooKassa API SDK](../home.md) + +# Interface: TransferInterface +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +Interface TransferInterface + +**Description:** + +Данные о распределении денег — сколько и в какой магазин нужно перевести. +Присутствует, если вы используете решение ЮKassa для платформ. + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAccountId()](../classes/YooKassa-Model-TransferInterface.md#method_getAccountId) | | Возвращает идентификатор магазина-получателя средств | +| public | [getAmount()](../classes/YooKassa-Model-TransferInterface.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getMetadata()](../classes/YooKassa-Model-TransferInterface.md#method_getMetadata) | | Возвращает метаданные | +| public | [getPlatformFeeAmount()](../classes/YooKassa-Model-TransferInterface.md#method_getPlatformFeeAmount) | | Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [getStatus()](../classes/YooKassa-Model-TransferInterface.md#method_getStatus) | | Возвращает статус операции распределения средств конечному получателю | +| public | [hasAmount()](../classes/YooKassa-Model-TransferInterface.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasMetadata()](../classes/YooKassa-Model-TransferInterface.md#method_hasMetadata) | | Проверяет были ли установлены метаданные | +| public | [hasPlatformFeeAmount()](../classes/YooKassa-Model-TransferInterface.md#method_hasPlatformFeeAmount) | | Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [setAccountId()](../classes/YooKassa-Model-TransferInterface.md#method_setAccountId) | | Устанавливает идентификатор магазина-получателя средств | +| public | [setAmount()](../classes/YooKassa-Model-TransferInterface.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setMetadata()](../classes/YooKassa-Model-TransferInterface.md#method_setMetadata) | | Устанавливает метаданные | +| public | [setPlatformFeeAmount()](../classes/YooKassa-Model-TransferInterface.md#method_setPlatformFeeAmount) | | Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| public | [setStatus()](../classes/YooKassa-Model-TransferInterface.md#method_setStatus) | | Устанавливает статус операции распределения средств конечному получателю | + +--- +### Details +* File: [lib/Model/TransferInterface.php](../../lib/Model/TransferInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property | | Сумма, которую необходимо перечислить магазину | +| property | | Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу | +| property | | Идентификатор магазина, в пользу которого вы принимаете оплату | +| property | | Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` | +| property | | Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) | +--- +## Methods + +#### public setAccountId() : void + +```php +public setAccountId(string value) : void +``` + +**Summary** + +Устанавливает идентификатор магазина-получателя средств + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина-получателя средств | + +**Returns:** void - + + + +#### public getAccountId() : string|null + +```php +public getAccountId() : string|null +``` + +**Summary** + +Возвращает идентификатор магазина-получателя средств + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** string|null - Идентификатор магазина-получателя средств + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface|array value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface + +```php +public getPlatformFeeAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма комиссии + + + +#### public hasPlatformFeeAmount() : bool + +```php +public hasPlatformFeeAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** bool - True если комиссия была установлена, false если нет + + + +#### public setPlatformFeeAmount() : mixed + +```php +public setPlatformFeeAmount(\YooKassa\Model\AmountInterface|array value) : mixed +``` + +**Summary** + +Устанавливает комиссию за проданные товары и услуги, которая удерживается с магазина в вашу пользу + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array | value | Сумма комиссии | + +**Returns:** mixed - + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус операции распределения средств конечному получателю + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** string|null - Статус операции распределения средств конечному получателю + + + +#### public setStatus() : mixed + +```php +public setStatus(string|null value) : mixed +``` + +**Summary** + +Устанавливает статус операции распределения средств конечному получателю + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata|array value) : mixed +``` + +**Summary** + +Устанавливает метаданные + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array | value | Метаданные | + +**Returns:** mixed - + + + +#### public getMetadata() : \YooKassa\Model\Metadata|null + +```php +public getMetadata() : \YooKassa\Model\Metadata|null +``` + +**Summary** + +Возвращает метаданные + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** \YooKassa\Model\Metadata|null - Метаданные + + + +#### public hasMetadata() : bool + +```php +public hasMetadata() : bool +``` + +**Summary** + +Проверяет были ли установлены метаданные + +**Details:** +* Inherited From: [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) + +**Returns:** bool - True если метаданные были установлены, false если нет + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-TransferStatus.md b/docs/classes/YooKassa-Model-TransferStatus.md new file mode 100644 index 00000000..0a5c5d29 --- /dev/null +++ b/docs/classes/YooKassa-Model-TransferStatus.md @@ -0,0 +1,159 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\TransferStatus +### Namespace: [\YooKassa\Model](../namespaces/yookassa-model.md) +--- +**Summary:** + +PaymentStatus - Статус операции распределения средств конечному получателю +|Код|Описание| +--- | --- +|pending|Ожидает оплаты покупателем| +|waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| +|succeeded|Успешно оплачен и получен магазином| +|canceled|Неуспех оплаты или отменен магазином (cancel)| + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [PENDING](../classes/YooKassa-Model-TransferStatus.md#constant_PENDING) | | | +| public | [WAITING_FOR_CAPTURE](../classes/YooKassa-Model-TransferStatus.md#constant_WAITING_FOR_CAPTURE) | | | +| public | [SUCCEEDED](../classes/YooKassa-Model-TransferStatus.md#constant_SUCCEEDED) | | | +| public | [CANCELED](../classes/YooKassa-Model-TransferStatus.md#constant_CANCELED) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$validValues](../classes/YooKassa-Model-TransferStatus.md#property_validValues) | | | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getEnabledValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getEnabledValues) | | Возвращает значения в enum'е значения которых разрешены | +| public | [getValidValues()](../classes/YooKassa-Common-AbstractEnum.md#method_getValidValues) | | Возвращает все значения в enum'e | +| public | [valueExists()](../classes/YooKassa-Common-AbstractEnum.md#method_valueExists) | | Проверяет наличие значения в enum'e | +--- +### Details +* File: [lib/Model/TransferStatus.php](../../lib/Model/TransferStatus.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + * \YooKassa\Model\TransferStatus +--- +## Constants + +###### PENDING +```php +PENDING = 'pending' +``` + + + +###### WAITING_FOR_CAPTURE +```php +WAITING_FOR_CAPTURE = 'waiting_for_capture' +``` + + + +###### SUCCEEDED +```php +SUCCEEDED = 'succeeded' +``` + + + +###### CANCELED +```php +CANCELED = 'canceled' +``` + + +--- +## Properties + +#### protected $validValues : array +--- +**Type:** array +Массив принимаемых enum'ом значений +**Details:** + + + +--- +## Methods + +#### public getEnabledValues() : string[] + +```php +Static public getEnabledValues() : string[] +``` + +**Summary** + +Возвращает значения в enum'е значения которых разрешены + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** string[] - Массив разрешённых значений + + + +#### public getValidValues() : array + +```php +Static public getValidValues() : array +``` + +**Summary** + +Возвращает все значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) + +**Returns:** array - Массив значений в перечислении + + + +#### public valueExists() : bool + +```php +Static public valueExists(mixed value) : bool +``` + +**Summary** + +Проверяет наличие значения в enum'e + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | Проверяемое значение | + +**Returns:** bool - True если значение имеется, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Model-Webhook-Webhook.md b/docs/classes/YooKassa-Model-Webhook-Webhook.md new file mode 100644 index 00000000..216f6088 --- /dev/null +++ b/docs/classes/YooKassa-Model-Webhook-Webhook.md @@ -0,0 +1,487 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Model\Webhook\Webhook +### Namespace: [\YooKassa\Model\Webhook](../namespaces/yookassa-model-webhook.md) +--- +**Summary:** + +Класс Webhook содержит информацию о подписке на одно событие + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$event](../classes/YooKassa-Model-Webhook-Webhook.md#property_event) | | Событие, о котором уведомляет ЮKassa | +| public | [$id](../classes/YooKassa-Model-Webhook-Webhook.md#property_id) | | Идентификатор webhook | +| public | [$url](../classes/YooKassa-Model-Webhook-Webhook.md#property_url) | | URL, на который ЮKassa будет отправлять уведомления | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getEvent()](../classes/YooKassa-Model-Webhook-Webhook.md#method_getEvent) | | Возвращает событие, о котором уведомляет ЮKassa | +| public | [getId()](../classes/YooKassa-Model-Webhook-Webhook.md#method_getId) | | Возвращает идентификатор webhook | +| public | [getUrl()](../classes/YooKassa-Model-Webhook-Webhook.md#method_getUrl) | | Возвращает URL, на который ЮKassa будет отправлять уведомления | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setEvent()](../classes/YooKassa-Model-Webhook-Webhook.md#method_setEvent) | | Устанавливает событие, о котором уведомляет ЮKassa | +| public | [setId()](../classes/YooKassa-Model-Webhook-Webhook.md#method_setId) | | Устанавливает идентификатор webhook | +| public | [setUrl()](../classes/YooKassa-Model-Webhook-Webhook.md#method_setUrl) | | Устанавливает URL, на который ЮKassa будет отправлять уведомления | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Model/Webhook/Webhook.php](../../lib/Model/Webhook/Webhook.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Model\Webhook\Webhook +--- +## Properties + +#### public $event : string +--- +***Description*** + +Событие, о котором уведомляет ЮKassa + +**Type:** string + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор webhook + +**Type:** string + +**Details:** + + + +#### public $url : string +--- +***Description*** + +URL, на который ЮKassa будет отправлять уведомления + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getEvent() : string + +```php +public getEvent() : string +``` + +**Summary** + +Возвращает событие, о котором уведомляет ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) + +**Returns:** string - Событие, о котором уведомляет ЮKassa + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор webhook + +**Details:** +* Inherited From: [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) + +**Returns:** string - Идентификатор webhook + + + +#### public getUrl() : string + +```php +public getUrl() : string +``` + +**Summary** + +Возвращает URL, на который ЮKassa будет отправлять уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) + +**Returns:** string - URL, на который ЮKassa будет отправлять уведомления + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setEvent() : mixed + +```php +public setEvent(string event) : mixed +``` + +**Summary** + +Устанавливает событие, о котором уведомляет ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | event | Событие, о котором уведомляет ЮKassa | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(mixed id) : mixed +``` + +**Summary** + +Устанавливает идентификатор webhook + +**Details:** +* Inherited From: [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | id | Идентификатор webhook | + +**Returns:** mixed - + + + +#### public setUrl() : mixed + +```php +public setUrl(string url) : mixed +``` + +**Summary** + +Устанавливает URL, на который ЮKassa будет отправлять уведомления + +**Details:** +* Inherited From: [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | url | URL, на который ЮKassa будет отправлять уведомления | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md b/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md new file mode 100644 index 00000000..e6a13787 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-AbstractPaymentResponse.md @@ -0,0 +1,1672 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Request\Payments\AbstractPaymentResponse +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Абстрактный класс ответа от API, возвращающего информацию о платеже + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Payment.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payment.md#property_amount) | | Сумма заказа | +| public | [$authorization_details](../classes/YooKassa-Model-Payment.md#property_authorization_details) | | Данные об авторизации платежа | +| public | [$authorizationDetails](../classes/YooKassa-Model-Payment.md#property_authorizationDetails) | | Данные об авторизации платежа | +| public | [$cancellation_details](../classes/YooKassa-Model-Payment.md#property_cancellation_details) | | Комментарий к отмене платежа | +| public | [$cancellationDetails](../classes/YooKassa-Model-Payment.md#property_cancellationDetails) | | Комментарий к отмене платежа | +| public | [$captured_at](../classes/YooKassa-Model-Payment.md#property_captured_at) | | Время подтверждения платежа магазином | +| public | [$capturedAt](../classes/YooKassa-Model-Payment.md#property_capturedAt) | | Время подтверждения платежа магазином | +| public | [$confirmation](../classes/YooKassa-Model-Payment.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$created_at](../classes/YooKassa-Model-Payment.md#property_created_at) | | Время создания заказа | +| public | [$createdAt](../classes/YooKassa-Model-Payment.md#property_createdAt) | | Время создания заказа | +| public | [$description](../classes/YooKassa-Model-Payment.md#property_description) | | Описание транзакции | +| public | [$expires_at](../classes/YooKassa-Model-Payment.md#property_expires_at) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$expiresAt](../classes/YooKassa-Model-Payment.md#property_expiresAt) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$id](../classes/YooKassa-Model-Payment.md#property_id) | | Идентификатор платежа | +| public | [$income_amount](../classes/YooKassa-Model-Payment.md#property_income_amount) | | Сумма платежа, которую получит магазин | +| public | [$incomeAmount](../classes/YooKassa-Model-Payment.md#property_incomeAmount) | | Сумма платежа, которую получит магазин | +| public | [$metadata](../classes/YooKassa-Model-Payment.md#property_metadata) | | Метаданные платежа указанные мерчантом | +| public | [$paid](../classes/YooKassa-Model-Payment.md#property_paid) | | Признак оплаты заказа | +| public | [$payment_method](../classes/YooKassa-Model-Payment.md#property_payment_method) | | Способ проведения платежа | +| public | [$paymentMethod](../classes/YooKassa-Model-Payment.md#property_paymentMethod) | | Способ проведения платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Payment.md#property_receipt_registration) | | Состояние регистрации фискального чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Payment.md#property_receiptRegistration) | | Состояние регистрации фискального чека | +| public | [$recipient](../classes/YooKassa-Model-Payment.md#property_recipient) | | Получатель платежа | +| public | [$refundable](../classes/YooKassa-Model-Payment.md#property_refundable) | | Возможность провести возврат по API | +| public | [$refunded_amount](../classes/YooKassa-Model-Payment.md#property_refunded_amount) | | Сумма возвращенных средств платежа | +| public | [$refundedAmount](../classes/YooKassa-Model-Payment.md#property_refundedAmount) | | Сумма возвращенных средств платежа | +| public | [$requestor](../classes/YooKassa-Model-Payment.md#property_requestor) | | Инициатор платежа | +| public | [$status](../classes/YooKassa-Model-Payment.md#property_status) | | Текущее состояние платежа | +| public | [$test](../classes/YooKassa-Model-Payment.md#property_test) | | Признак тестовой операции | +| public | [$transfers](../classes/YooKassa-Model-Payment.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md#method_fromArray) | | Конструктор, устанавливает настройки платежа из ассоциативного массива | +| public | [getAmount()](../classes/YooKassa-Model-Payment.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-Payment.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-Payment.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-Payment.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getDescription()](../classes/YooKassa-Model-Payment.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getExpiresAt()](../classes/YooKassa-Model-Payment.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-Payment.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_getIncomeAmount) | | Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [getMetadata()](../classes/YooKassa-Model-Payment.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-Payment.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-Payment.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-Payment.md#method_getRefundable) | | Проверяет возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-Payment.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | +| public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | +| public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [setCapturedAt()](../classes/YooKassa-Model-Payment.md#method_setCapturedAt) | | Устанавливает время подтверждения платежа магазином | +| public | [setConfirmation()](../classes/YooKassa-Model-Payment.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCreatedAt()](../classes/YooKassa-Model-Payment.md#method_setCreatedAt) | | Устанавливает время создания заказа | +| public | [setDescription()](../classes/YooKassa-Model-Payment.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setExpiresAt()](../classes/YooKassa-Model-Payment.md#method_setExpiresAt) | | Устанавливает время до которого можно бесплатно отменить или подтвердить платеж | +| public | [setId()](../classes/YooKassa-Model-Payment.md#method_setId) | | Устанавливает идентификатор платежа | +| public | [setIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_setIncomeAmount) | | Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [setMetadata()](../classes/YooKassa-Model-Payment.md#method_setMetadata) | | Устанавливает метаданные платежа | +| public | [setPaid()](../classes/YooKassa-Model-Payment.md#method_setPaid) | | Устанавливает флаг оплаты заказа | +| public | [setPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_setPaymentMethod) | | Устанавливает используемый способ проведения платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_setReceiptRegistration) | | Устанавливает состояние регистрации фискального чека | +| public | [setRecipient()](../classes/YooKassa-Model-Payment.md#method_setRecipient) | | Устанавливает получателя платежа | +| public | [setRefundable()](../classes/YooKassa-Model-Payment.md#method_setRefundable) | | Устанавливает возможность провести возврат по API | +| public | [setRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_setRefundedAmount) | | Устанавливает сумму возвращенных средств | +| public | [setRequestor()](../classes/YooKassa-Model-Payment.md#method_setRequestor) | | Устанавливает инициатора платежа | +| public | [setStatus()](../classes/YooKassa-Model-Payment.md#method_setStatus) | | Устанавливает статус платежа | +| public | [setTest()](../classes/YooKassa-Model-Payment.md#method_setTest) | | Устанавливает признак тестовой операции | +| public | [setTransfers()](../classes/YooKassa-Model-Payment.md#method_setTransfers) | | Устанавливает массив распределения денег между магазинами | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Payments/AbstractPaymentResponse.php](../../lib/Request/Payments/AbstractPaymentResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + * \YooKassa\Request\Payments\AbstractPaymentResponse +* Implements: + * [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) +--- +## Constants + +###### MAX_LENGTH_DESCRIPTION +Inherited from [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +Максимальная длина строки описания платежа + +```php +MAX_LENGTH_DESCRIPTION = 128 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма заказа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorizationDetails : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $captured_at : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $capturedAt : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $confirmation : \YooKassa\Model\Confirmation\AbstractConfirmation +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmation + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expires_at : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expiresAt : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $income_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $incomeAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные платежа указанные мерчантом + +**Type:** Metadata + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paid : bool +--- +***Description*** + +Признак оплаты заказа + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $payment_method : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paymentMethod : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа + +**Type:** RecipientInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundable : bool +--- +***Description*** + +Возможность провести возврат по API + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refunded_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundedAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $requestor : \YooKassa\Model\Requestor +--- +***Description*** + +Инициатор платежа + +**Type:** Requestor + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $status : string +--- +***Description*** + +Текущее состояние платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array sourceArray) : mixed +``` + +**Summary** + +Конструктор, устанавливает настройки платежа из ассоциативного массива + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\AbstractPaymentResponse](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | sourceArray | Массив с информацией о платеже, пришедший от API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount +``` + +**Summary** + +Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Проверяет возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Возможность провести возврат по API, true если есть, false если нет + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setAuthorizationDetails() : mixed + +```php +public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AuthorizationDetailsInterface | value | Данные об авторизации платежа | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : mixed + +```php +public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\CancellationDetailsInterface | value | Комментарий к статусу canceled | + +**Returns:** mixed - + + + +#### public setCapturedAt() : mixed + +```php +public setCapturedAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время подтверждения платежа магазином + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения платежа магазином | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасвается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Confirmation\AbstractConfirmation | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime|string|int value) : mixed +``` + +**Summary** + +Устанавливает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | value | Время создания заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setExpiresAt() : mixed + +```php +public setExpiresAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время до которого можно бесплатно отменить или подтвердить платеж + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время, до которого можно бесплатно отменить или подтвердить платеж | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setIncomeAmount() : mixed + +```php +public setIncomeAmount(\YooKassa\Model\MonetaryAmount amount) : mixed +``` + +**Summary** + +Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\MonetaryAmount | amount | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata value) : mixed +``` + +**Summary** + +Устанавливает метаданные платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata | value | Метаданные платежа указанные мерчантом | + +**Returns:** mixed - + + + +#### public setPaid() : mixed + +```php +public setPaid(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак оплаты заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod value) : mixed +``` + +**Summary** + +Устанавливает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\AbstractPaymentMethod | value | Способ проведения платежа | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface value) : mixed +``` + +**Summary** + +Устанавливает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface | value | Объект с информацией о получателе платежа | + +**Returns:** mixed - + + + +#### public setRefundable() : mixed + +```php +public setRefundable(bool value) : mixed +``` + +**Summary** + +Устанавливает возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность провести возврат по API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setRefundedAmount() : mixed + +```php +public setRefundedAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возвращенных средств платежа | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setTest() : mixed + +```php +public setTest(bool test) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md new file mode 100644 index 00000000..a6de70b0 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequest.md @@ -0,0 +1,1662 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\CreatePaymentRequest +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс объекта запроса к API на проведение нового платежа + +--- +### Examples +Пример использования билдера + +```php +try { + $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); + $builder->setAmount(100) + ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) + ->setCapture(true) + ->setDescription('Оплата заказа 112233') + ->setMetadata(array( + 'cms_name' => 'yoo_api_test', + 'order_id' => '112233', + 'language' => 'ru', + 'transaction_id' => '123-456-789', + )); + + // Устанавливаем страницу для редиректа после оплаты + $builder->setConfirmation(array( + 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, + 'returnUrl' => 'https://merchant-site.ru/payment-return-page', + )); + + // Можем установить конкретный способ оплаты + $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); + + // Составляем чек + $builder->setReceiptEmail('john.doe@merchant.com'); + $builder->setReceiptPhone('71111111111'); + // Добавим товар + $builder->addReceiptItem( + 'Платок Gucci', + 3000, + 1.0, + 2, + 'full_payment', + 'commodity' + ); + // Добавим доставку + $builder->addReceiptShipping( + 'Delivery/Shipping/Доставка', + 100, + 1, + \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, + \YooKassa\Model\Receipt\PaymentSubject::SERVICE + ); + + // Можно добавить распределение денег по магазинам + $builder->setTransfers(array( + array( + 'account_id' => 123456, + 'amount' => array( + array( + 'value' => 1000, + 'currency' => \YooKassa\Model\CurrencyCode::RUB + ) + ), + ), + array( + 'account_id' => 654321, + 'amount' => array( + array( + 'value' => 2000, + 'currency' => \YooKassa\Model\CurrencyCode::RUB + ) + ), + ) + )); + + // Создаем объект запроса + $request = $builder->build(); + + // Можно изменить данные, если нужно + $request->setDescription($request->getDescription() . ' - merchant comment'); + + $idempotenceKey = uniqid('', true); + $response = $client->createPayment($request, $idempotenceKey); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_PAYMENT_TOKEN](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#constant_MAX_LENGTH_PAYMENT_TOKEN) | | | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | +| public | [$amount](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_amount) | | Сумма создаваемого платежа | +| public | [$capture](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_capture) | | Автоматически принять поступившую оплату | +| public | [$client_ip](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_client_ip) | | IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. | +| public | [$clientIp](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_clientIp) | | IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. | +| public | [$confirmation](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$description](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_description) | | Описание транзакции | +| public | [$metadata](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_metadata) | | Метаданные привязанные к платежу | +| public | [$payment_method_data](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_payment_method_data) | | Данные используемые для создания метода оплаты | +| public | [$payment_method_id](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_payment_method_id) | | Идентификатор записи о сохраненных платежных данных покупателя | +| public | [$payment_token](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_payment_token) | | Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | +| public | [$paymentMethodData](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_paymentMethodData) | | Данные используемые для создания метода оплаты | +| public | [$paymentMethodId](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_paymentMethodId) | | Идентификатор записи о сохраненных платежных данных покупателя | +| public | [$paymentToken](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_paymentToken) | | Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | +| public | [$receipt](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$recipient](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_recipient) | | Получатель платежа, если задан | +| public | [$save_payment_method](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_save_payment_method) | | Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method. | +| public | [$savePaymentMethod](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#property_savePaymentMethod) | | Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method. | +| public | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_builder) | | Возвращает билдер объектов запросов создания платежа | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getAirline) | | Возвращает данные авиабилетов | +| public | [getAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getCapture) | | Возвращает флаг автоматического принятия поступившей оплаты | +| public | [getClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getClientIp) | | Возвращает IPv4 или IPv6-адрес покупателя | +| public | [getConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | +| public | [getPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getPaymentMethodData) | | Возвращает данные для создания метода оплаты | +| public | [getPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getPaymentMethodId) | | Устанавливает идентификатор закиси платёжных данных покупателя | +| public | [getPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getPaymentToken) | | Возвращает одноразовый токен для проведения оплаты | +| public | [getReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getReceipt) | | Возвращает чек, если он есть | +| public | [getRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getRecipient) | | Возвращает объект получателя платежа | +| public | [getSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_getSavePaymentMethod) | | Возвращает флаг сохранения платёжных данных | +| public | [getTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. | +| public | [hasAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasAirline) | | Проверяет были ли установлены данные авиабилетов | +| public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasCapture) | | Проверяет был ли установлен флаг автоматического приняти поступившей оплаты | +| public | [hasClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasClientIp) | | Проверяет был ли установлен IPv4 или IPv6-адрес покупателя | +| public | [hasConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasConfirmation) | | Проверяет был ли установлен способ подтверждения платежа | +| public | [hasDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемом платеже | +| public | [hasMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasMetadata) | | Проверяет были ли установлены метаданные заказа | +| public | [hasPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasPaymentMethodData) | | Проверяет установлен ли объект с методом оплаты | +| public | [hasPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasPaymentMethodId) | | Проверяет наличие идентификатора записи о платёжных данных покупателя | +| public | [hasPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasPaymentToken) | | Проверяет наличие одноразового токена для проведения оплаты | +| public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | +| public | [hasRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasRecipient) | | Проверяет наличие получателя платежа в запросе | +| public | [hasSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_hasSavePaymentMethod) | | Проверяет был ли установлен флаг сохранения платёжных данных | +| public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | +| public | [setAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setAirline) | | Устанавливает данные авиабилетов | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setCapture) | | Устанавливает флаг автоматического принятия поступившей оплаты | +| public | [setClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setClientIp) | | Устанавливает IP адрес покупателя | +| public | [setConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | +| public | [setPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setPaymentMethodData) | | Устанавливает объект с информацией для создания метода оплаты | +| public | [setPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setPaymentMethodId) | | Устанавливает идентификатор записи о сохранённых данных покупателя | +| public | [setPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setPaymentToken) | | Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек | +| public | [setRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setRecipient) | | Устанавливает объект с информацией о получателе платежа | +| public | [setSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_setSavePaymentMethod) | | Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md#method_validate) | | Проверяет на валидность текущий объект | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Payments/CreatePaymentRequest.php](../../lib/Request/Payments/CreatePaymentRequest.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + * \YooKassa\Request\Payments\CreatePaymentRequest +* Implements: + * [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +--- +## Constants + +###### MAX_LENGTH_PAYMENT_TOKEN +```php +MAX_LENGTH_PAYMENT_TOKEN = 10240 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма создаваемого платежа + +**Type:** AmountInterface + +**Details:** + + + +#### public $capture : bool +--- +***Description*** + +Автоматически принять поступившую оплату + +**Type:** bool + +**Details:** + + + +#### public $client_ip : string +--- +***Description*** + +IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. + +**Type:** string + +**Details:** + + + +#### public $clientIp : string +--- +***Description*** + +IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. + +**Type:** string + +**Details:** + + + +#### public $confirmation : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmationAttributes + +**Details:** + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные привязанные к платежу + +**Type:** Metadata + +**Details:** + + + +#### public $payment_method_data : \YooKassa\Model\PaymentData\AbstractPaymentData +--- +***Description*** + +Данные используемые для создания метода оплаты + +**Type:** AbstractPaymentData + +**Details:** + + + +#### public $payment_method_id : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных покупателя + +**Type:** string + +**Details:** + + + +#### public $payment_token : string +--- +***Description*** + +Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + +**Type:** string + +**Details:** + + + +#### public $paymentMethodData : \YooKassa\Model\PaymentData\AbstractPaymentData +--- +***Description*** + +Данные используемые для создания метода оплаты + +**Type:** AbstractPaymentData + +**Details:** + + + +#### public $paymentMethodId : string +--- +***Description*** + +Идентификатор записи о сохраненных платежных данных покупателя + +**Type:** string + +**Details:** + + + +#### public $paymentToken : string +--- +***Description*** + +Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + +**Type:** string + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа, если задан + +**Type:** RecipientInterface + +**Details:** + + + +#### public $save_payment_method : bool +--- +***Description*** + +Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method. + +**Type:** bool + +**Details:** + + + +#### public $savePaymentMethod : bool +--- +***Description*** + +Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method. + +**Type:** bool + +**Details:** + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Возвращает билдер объектов запросов создания платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс билдера объектов запрсов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAirline() : \YooKassa\Model\AirlineInterface + +```php +public getAirline() : \YooKassa\Model\AirlineInterface +``` + +**Summary** + +Возвращает данные авиабилетов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Model\AirlineInterface - Данные авиабилетов + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + + + +#### public getCapture() : bool + +```php +public getCapture() : bool +``` + +**Summary** + +Возвращает флаг автоматического принятия поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если требуется автоматически принять поступившую оплату, false если нет + + + +#### public getClientIp() : string + +```php +public getClientIp() : string +``` + +**Summary** + +Возвращает IPv4 или IPv6-адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** string - IPv4 или IPv6-адрес покупателя + + + +#### public getConfirmation() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes + +```php +public getConfirmation() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes - Способ подтверждения платежа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** string - + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает данные оплаты установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные, привязанные к платежу + + + +#### public getPaymentMethodData() : \YooKassa\Model\PaymentData\AbstractPaymentData + +```php +public getPaymentMethodData() : \YooKassa\Model\PaymentData\AbstractPaymentData +``` + +**Summary** + +Возвращает данные для создания метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Model\PaymentData\AbstractPaymentData - Данные используемые для создания метода оплаты + + + +#### public getPaymentMethodId() : string + +```php +public getPaymentMethodId() : string +``` + +**Summary** + +Устанавливает идентификатор закиси платёжных данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных покупателя + + + +#### public getPaymentToken() : string + +```php +public getPaymentToken() : string +``` + +**Summary** + +Возвращает одноразовый токен для проведения оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** string - Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает чек, если он есть + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null если чека нет + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает объект получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Объект с информацией о получателе платежа или null если получатель не задан + + + +#### public getSavePaymentMethod() : bool + +```php +public getSavePaymentMethod() : bool +``` + +**Summary** + +Возвращает флаг сохранения платёжных данных + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - Флаг сохранения платёжных данных + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + +**Description** + +Присутствует, если вы используете решение ЮKassa для платформ. +(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег + + + +#### public hasAirline() : bool + +```php +public hasAirline() : bool +``` + +**Summary** + +Проверяет были ли установлены данные авиабилетов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public hasCapture() : bool + +```php +public hasCapture() : bool +``` + +**Summary** + +Проверяет был ли установлен флаг автоматического приняти поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если флаг автоматического принятия оплаты был установлен, false если нет + + + +#### public hasClientIp() : bool + +```php +public hasClientIp() : bool +``` + +**Summary** + +Проверяет был ли установлен IPv4 или IPv6-адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если IP адрес покупателя был установлен, false если нет + + + +#### public hasConfirmation() : bool + +```php +public hasConfirmation() : bool +``` + +**Summary** + +Проверяет был ли установлен способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если способ подтверждения платежа был установлен, false если нет + + + +#### public hasDescription() : bool + +```php +public hasDescription() : bool +``` + +**Summary** + +Проверяет наличие описания транзакции в создаваемом платеже + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если описание транзакции есть, false если нет + + + +#### public hasMetadata() : bool + +```php +public hasMetadata() : bool +``` + +**Summary** + +Проверяет были ли установлены метаданные заказа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если метаданные были установлены, false если нет + + + +#### public hasPaymentMethodData() : bool + +```php +public hasPaymentMethodData() : bool +``` + +**Summary** + +Проверяет установлен ли объект с методом оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если объект метода оплаты установлен, false если нет + + + +#### public hasPaymentMethodId() : bool + +```php +public hasPaymentMethodId() : bool +``` + +**Summary** + +Проверяет наличие идентификатора записи о платёжных данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если идентификатор задан, false если нет + + + +#### public hasPaymentToken() : bool + +```php +public hasPaymentToken() : bool +``` + +**Summary** + +Проверяет наличие одноразового токена для проведения оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если токен установлен, false если нет + + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет наличие чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если чек есть, false если нет + + + +#### public hasRecipient() : bool + +```php +public hasRecipient() : bool +``` + +**Summary** + +Проверяет наличие получателя платежа в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если получатель платежа задан, false если нет + + + +#### public hasSavePaymentMethod() : bool + +```php +public hasSavePaymentMethod() : bool +``` + +**Summary** + +Проверяет был ли установлен флаг сохранения платёжных данных + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если флыг был установлен, false если нет + + + +#### public hasTransfers() : bool + +```php +public hasTransfers() : bool +``` + +**Summary** + +Проверяет наличие данных о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public removeReceipt() : mixed + +```php +public removeReceipt() : mixed +``` + +**Summary** + +Удаляет чек из запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** mixed - + + + +#### public setAirline() : mixed + +```php +public setAirline(\YooKassa\Model\AirlineInterface value) : mixed +``` + +**Summary** + +Устанавливает данные авиабилетов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AirlineInterface | value | Данные авиабилетов | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public setCapture() : mixed + +```php +public setCapture(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг автоматического принятия поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Автоматически принять поступившую оплату | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если переданный аргумент не кастится в bool | + +**Returns:** mixed - + + + +#### public setClientIp() : mixed + +```php +public setClientIp(string value) : mixed +``` + +**Summary** + +Устанавливает IP адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | IPv4 или IPv6-адрес покупателя | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes|null value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes OR null | value | Способ подтверждения платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является объектом типа AbstractConfirmationAttributes или null | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null value) : mixed +``` + +**Summary** + +Устанавливает метаданные, привязанные к платежу + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные платежа, устанавливаемые мерчантом | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа | + +**Returns:** mixed - + + + +#### public setPaymentMethodData() : mixed + +```php +public setPaymentMethodData(\YooKassa\Model\PaymentData\AbstractPaymentData|null value) : mixed +``` + +**Summary** + +Устанавливает объект с информацией для создания метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentData\AbstractPaymentData OR null | value | Объект с создания метода оплаты или null | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если был передан объект невалидного типа | + +**Returns:** mixed - + + + +#### public setPaymentMethodId() : mixed + +```php +public setPaymentMethodId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор записи о сохранённых данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных покупателя | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если переданные значение не является строкой или null | + +**Returns:** mixed - + + + +#### public setPaymentToken() : mixed + +```php +public setPaymentToken(string value) : mixed +``` + +**Summary** + +Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Одноразовый токен для проведения оплаты | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setReceipt() : mixed + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|null value) : mixed +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface|null value) : mixed +``` + +**Summary** + +Устанавливает объект с информацией о получателе платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface OR null | value | Инстанс объекта информации о получателе платежа или null | + +**Returns:** mixed - + + + +#### public setSavePaymentMethod() : mixed + +```php +public setSavePaymentMethod(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Сохранить платежные данные для последующего использования | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если переданный аргумент не кастится в bool | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : mixed +``` + +**Summary** + +Устанавливает transfers (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет на валидность текущий объект + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) + +**Returns:** bool - True если объект запроса валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md new file mode 100644 index 00000000..05da0c27 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md @@ -0,0 +1,904 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\CreatePaymentRequestBuilder +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс билдера объектов запрсов к API на создание платежа + +--- +### Examples +Пример использования билдера + +```php +try { + $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); + $builder->setAmount(100) + ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) + ->setCapture(true) + ->setDescription('Оплата заказа 112233') + ->setMetadata(array( + 'cms_name' => 'yoo_api_test', + 'order_id' => '112233', + 'language' => 'ru', + 'transaction_id' => '123-456-789', + )); + + // Устанавливаем страницу для редиректа после оплаты + $builder->setConfirmation(array( + 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, + 'returnUrl' => 'https://merchant-site.ru/payment-return-page', + )); + + // Можем установить конкретный способ оплаты + $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); + + // Составляем чек + $builder->setReceiptEmail('john.doe@merchant.com'); + $builder->setReceiptPhone('71111111111'); + // Добавим товар + $builder->addReceiptItem( + 'Платок Gucci', + 3000, + 1.0, + 2, + 'full_payment', + 'commodity' + ); + // Добавим доставку + $builder->addReceiptShipping( + 'Delivery/Shipping/Доставка', + 100, + 1, + \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, + \YooKassa\Model\Receipt\PaymentSubject::SERVICE + ); + + // Можно добавить распределение денег по магазинам + $builder->setTransfers(array( + array( + 'account_id' => 123456, + 'amount' => array( + array( + 'value' => 1000, + 'currency' => \YooKassa\Model\CurrencyCode::RUB + ) + ), + ), + array( + 'account_id' => 654321, + 'amount' => array( + array( + 'value' => 2000, + 'currency' => \YooKassa\Model\CurrencyCode::RUB + ) + ), + ) + )); + + // Создаем объект запроса + $request = $builder->build(); + + // Можно изменить данные, если нужно + $request->setDescription($request->getDescription() . ' - merchant comment'); + + $idempotenceKey = uniqid('', true); + $response = $client->createPayment($request, $idempotenceKey); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$amount](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_amount) | | Сумма | +| protected | [$currentObject](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#property_currentObject) | | Собираемый объект запроса | +| protected | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_receipt) | | Объект с информацией о чеке | +| protected | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_transfers) | | Массив платежей в пользу разных мерчантов | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [addReceiptItem()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptItem) | | Добавляет в чек товар | +| public | [addReceiptShipping()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptShipping) | | Добавляет в чек доставку товара | +| public | [build()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_build) | | Строит и возвращает объект запроса для отправки в API ЮKassa | +| public | [setAccountId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setAccountId) | | Устанавливает идентификатор магазина получателя платежа | +| public | [setAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setAirline) | | Устанавливает информацию об авиабилетах | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setAmount) | | Устанавливает сумму | +| public | [setCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setCapture) | | Устанавливает флаг автоматического принятия поступившей оплаты | +| public | [setClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setClientIp) | | Устанавливает IP адрес покупателя | +| public | [setConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCurrency()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа | +| public | [setDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setGatewayId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setGatewayId) | | Устанавливает идентификатор шлюза | +| public | [setMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setPaymentMethodData) | | Устанавливает объект с информацией для создания метода оплаты | +| public | [setPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setPaymentMethodId) | | Устанавливает идентификатор записи о сохранённых данных покупателя | +| public | [setPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setPaymentToken) | | Устанавливает одноразовый токен для проведения оплаты | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceipt) | | Устанавливает чек | +| public | [setReceiptEmail()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptEmail) | | Устанавливает адрес электронной почты получателя чека | +| public | [setReceiptItems()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptItems) | | Устанавлвиает список товаров для создания чека | +| public | [setReceiptPhone()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptPhone) | | Устанавливает телефон получателя чека | +| public | [setRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setRecipient) | | Устанавливает получателя платежа из объекта или ассоциативного массива | +| public | [setSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_setSavePaymentMethod) | | Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. | +| public | [setTaxSystemCode()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения. | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTransfers) | | Устанавливает трансферы | +| protected | [getConfirmationFactory()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_getConfirmationFactory) | | Возвращает фабрику для создания методов подтверждения платежей | +| protected | [getPaymentDataFactory()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_getPaymentDataFactory) | | Возвращает фабрику методов проведения платежей | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md#method_initCurrentObject) | | Инициализирует объект запроса, который в дальнейшем будет собираться билдером | +--- +### Details +* File: [lib/Request/Payments/CreatePaymentRequestBuilder.php](../../lib/Request/Payments/CreatePaymentRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + * \YooKassa\Request\Payments\CreatePaymentRequestBuilder +--- +## Properties + +#### protected $amount : \YooKassa\Model\MonetaryAmount +--- +**Summary** + +Сумма + +**Type:** MonetaryAmount + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +#### protected $currentObject : \YooKassa\Request\Payments\CreatePaymentRequest +--- +**Summary** + +Собираемый объект запроса + +**Type:** CreatePaymentRequest + +**Details:** + + + +#### protected $receipt : \YooKassa\Model\Receipt +--- +**Summary** + +Объект с информацией о чеке + +**Type:** Receipt + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +#### protected $transfers : \YooKassa\Model\TransferInterface[] +--- +**Summary** + +Массив платежей в пользу разных мерчантов + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public addReceiptItem() : self + +```php +public addReceiptItem(string title, string price, float quantity, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек товар + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название или описание товара | +| string | price | Цена товара в валюте, заданной в заказе | +| float | quantity | Количество товара | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public addReceiptShipping() : self + +```php +public addReceiptShipping(string title, string price, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек доставку товара + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название доставки в чеке | +| string | price | Стоимость доставки | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public build() : \YooKassa\Request\Payments\CreatePaymentRequestInterface|\YooKassa\Common\AbstractPaymentRequest|\YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Request\Payments\CreatePaymentRequestInterface|\YooKassa\Common\AbstractPaymentRequest|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит и возвращает объект запроса для отправки в API ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив параметров для установки в объект запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если собрать объект запроса не удалось | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestInterface|\YooKassa\Common\AbstractPaymentRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса + + + +#### public setAccountId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setAccountId(string value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор магазина получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не строковое значение | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setAirline() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setAirline(\YooKassa\Model\AirlineInterface|array value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает информацию об авиабилетах + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AirlineInterface OR array | value | объект данных длинной записи или ассоциативный массив с данными | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - + + + +#### public setAmount() : self + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|string value) : self +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR string | value | Сумма оплаты | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setCapture() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setCapture(bool value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает флаг автоматического принятия поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Автоматически принять поступившую оплату | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если переданный аргумент не кастится в bool | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setClientIp() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setClientIp(string value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает IP адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | IPv4 или IPv6-адрес покупателя | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не является строкой | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setConfirmation() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setConfirmation(\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes|string|array|null value, array|null options = null) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes OR string OR array OR null | value | Способ подтверждения платежа | +| array OR null | options | Настройки способа подтверждения платежа в виде массива | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является объектом типа AbstractConfirmationAttributes или null | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setCurrency() : self + +```php +public setCurrency(string value) : self +``` + +**Summary** + +Устанавливает валюту в которой будет происходить подтверждение оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Валюта в которой подтверждается оплата | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setDescription() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setDescription(string value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Описание транзакции | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setGatewayId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setGatewayId(string value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор шлюза + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор шлюза | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если было передано не строковое значение | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setMetadata() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает метаданные, привязанные к платежу + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные платежа, устанавливаемые мерчантом | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданные данные не удалось интерпретировать как метаданные платежа | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setPaymentMethodData() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setPaymentMethodData(\YooKassa\Model\PaymentData\AbstractPaymentData|string|array|null value, array options = null) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает объект с информацией для создания метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentData\AbstractPaymentData OR string OR array OR null | value | Объект с создания метода оплаты или null | +| array | options | Настройки способа оплаты в виде ассоциативного массива | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если был передан объект невалидного типа | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setPaymentMethodId() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setPaymentMethodId(string value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор записи о сохранённых данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных покупателя | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если переданные значение не является строкой или null | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setPaymentToken() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setPaymentToken(string value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает одноразовый токен для проведения оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Одноразовый токен для проведения оплаты | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setReceipt() : self + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|array value) : self +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR array | value | Инстанс чека или ассоциативный массив с данными чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | + +**Returns:** self - + + + +#### public setReceiptEmail() : self + +```php +public setReceiptEmail(string value) : self +``` + +**Summary** + +Устанавливает адрес электронной почты получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Email получателя чека | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptItems() : self + +```php +public setReceiptItems(array value) : self +``` + +**Summary** + +Устанавлвиает список товаров для создания чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | value | Массив товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если хотя бы один из товаров имеет неверную структуру | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptPhone() : self + +```php +public setReceiptPhone(string value) : self +``` + +**Summary** + +Устанавливает телефон получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Телефон получателя чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setRecipient() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setRecipient(\YooKassa\Model\RecipientInterface|array value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает получателя платежа из объекта или ассоциативного массива + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface OR array | value | Получатель платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан аргумент не валидного типа | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - + + + +#### public setSavePaymentMethod() : \YooKassa\Request\Payments\CreatePaymentRequestBuilder + +```php +public setSavePaymentMethod(bool value) : \YooKassa\Request\Payments\CreatePaymentRequestBuilder +``` + +**Summary** + +Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Сохранить платежные данные для последующего использования | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если переданный аргумент не кастится в bool | + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequestBuilder - Инстанс текущего билдера + + + +#### public setTaxSystemCode() : self + +```php +public setTaxSystemCode(int value) : self +``` + +**Summary** + +Устанавливает код системы налогообложения. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6. | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTransfers() : self + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : self +``` + +**Summary** + +Устанавливает трансферы + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | Массив трансферов | + +**Returns:** self - Инстанс билдера запросов + + + +#### protected getConfirmationFactory() : \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory + +```php +protected getConfirmationFactory() : \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory +``` + +**Summary** + +Возвращает фабрику для создания методов подтверждения платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) + +**Returns:** \YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory - Фабрика объектов методов подтверждения платежей + + + +#### protected getPaymentDataFactory() : \YooKassa\Model\PaymentData\PaymentDataFactory + +```php +protected getPaymentDataFactory() : \YooKassa\Model\PaymentData\PaymentDataFactory +``` + +**Summary** + +Возвращает фабрику методов проведения платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) + +**Returns:** \YooKassa\Model\PaymentData\PaymentDataFactory - Фабрика методов проведения платежей + + + +#### protected initCurrentObject() : \YooKassa\Request\Payments\CreatePaymentRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Payments\CreatePaymentRequest +``` + +**Summary** + +Инициализирует объект запроса, который в дальнейшем будет собираться билдером + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) + +**Returns:** \YooKassa\Request\Payments\CreatePaymentRequest - Инстанс собираемого объекта запроса к API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md new file mode 100644 index 00000000..b1ee5161 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md @@ -0,0 +1,824 @@ +# [YooKassa API SDK](../home.md) + +# Interface: CreatePaymentRequestInterface +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Interface CreatePaymentRequestInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getAirline) | | Возвращает данные длинной записи | +| public | [getAmount()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getAmount) | | Возвращает сумму заказа | +| public | [getCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getCapture) | | Возвращает флаг автоматического принятия поступившей оплаты | +| public | [getClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getClientIp) | | Возвращает IPv4 или IPv6-адрес покупателя | +| public | [getConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getMetadata) | | Возвращает данные оплаты установленные мерчантом | +| public | [getPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getPaymentMethodData) | | Возвращает данные для создания метода оплаты | +| public | [getPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getPaymentMethodId) | | Устанавливает идентификатор закиси платёжных данных покупателя | +| public | [getPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getPaymentToken) | | Возвращает одноразовый токен для проведения оплаты | +| public | [getReceipt()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getReceipt) | | Возвращает чек, если он есть | +| public | [getRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getRecipient) | | Возвращает объект получателя платежа | +| public | [getSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getSavePaymentMethod) | | Возвращает флаг сохранения платёжных данных | +| public | [getTransfers()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. | +| public | [hasAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasAirline) | | Проверяет были ли установлены данные длинной записи | +| public | [hasCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasCapture) | | Проверяет был ли установлен флаг автоматического приняти поступившей оплаты | +| public | [hasClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasClientIp) | | Проверяет был ли установлен IPv4 или IPv6-адрес покупателя | +| public | [hasConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasConfirmation) | | Проверяет был ли установлен способ подтверждения платежа | +| public | [hasDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasDescription) | | Проверяет наличие описания транзакции в создаваемом платеже | +| public | [hasMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasMetadata) | | Проверяет были ли установлены метаданные заказа | +| public | [hasPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasPaymentMethodData) | | Проверяет установлен ли объект с методом оплаты | +| public | [hasPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasPaymentMethodId) | | Проверяет наличие идентификатора записи о платёжных данных покупателя | +| public | [hasPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasPaymentToken) | | Проверяет наличие одноразового токена для проведения оплаты | +| public | [hasReceipt()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasReceipt) | | Проверяет наличие чека в создаваемом платеже | +| public | [hasRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasRecipient) | | Проверяет наличие получателя платежа в запросе | +| public | [hasSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasSavePaymentMethod) | | Проверяет был ли установлен флаг сохранения платёжных данных | +| public | [hasTransfers()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | +| public | [setAirline()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setAirline) | | Устанавливает данные авиабилетов | +| public | [setCapture()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setCapture) | | Устанавливает флаг автоматического принятия поступившей оплаты | +| public | [setClientIp()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setClientIp) | | Устанавливает IP адрес покупателя | +| public | [setConfirmation()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setDescription()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setMetadata()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setMetadata) | | Устанавливает метаданные, привязанные к платежу | +| public | [setPaymentMethodData()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setPaymentMethodData) | | Устанавливает объект с информацией для создания метода оплаты | +| public | [setPaymentMethodId()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setPaymentMethodId) | | Устанавливает идентификатор записи о сохранённых данных покупателя | +| public | [setPaymentToken()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setPaymentToken) | | Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | +| public | [setRecipient()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setRecipient) | | Устанавливает объект с информацией о получателе платежа | +| public | [setSavePaymentMethod()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setSavePaymentMethod) | | Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. | +| public | [setTransfers()](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md#method_setTransfers) | | Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести. | + +--- +### Details +* File: [lib/Request/Payments/CreatePaymentRequestInterface.php](../../lib/Request/Payments/CreatePaymentRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Получатель платежа, если задан | +| property-read | | Сумма создаваемого платежа | +| property-read | | Данные фискального чека 54-ФЗ | +| property-read | | Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | +| property-read | | Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget | +| property-read | | Идентификатор записи о сохраненных платежных данных покупателя | +| property-read | | Идентификатор записи о сохраненных платежных данных покупателя | +| property-read | | Данные используемые для создания метода оплаты | +| property-read | | Данные используемые для создания метода оплаты | +| property-read | | Способ подтверждения платежа | +| property-read | | Сохранить платежные данные для последующего использования | +| property-read | | Сохранить платежные данные для последующего использования | +| property-read | | Автоматически принять поступившую оплату | +| property-read | | IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. | +| property-read | | IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. | +| property-read | | Метаданные привязанные к платежу | +| property-read | | Метаданные привязанные к платежу | +--- +## Methods + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает объект получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Объект с информацией о получателе платежа или null если получатель не задан + + + +#### public hasRecipient() : bool + +```php +public hasRecipient() : bool +``` + +**Summary** + +Проверяет наличие получателя платежа в запросе + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если получатель платежа задан, false если нет + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface|null value) : mixed +``` + +**Summary** + +Устанавливает объект с информацией о получателе платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface OR null | value | Инстанс объекта информации о получателе платежа или null | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму заказа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** string - Описание транзакции + + + +#### public hasDescription() : bool + +```php +public hasDescription() : bool +``` + +**Summary** + +Проверяет наличие описания транзакции в создаваемом платеже + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если описание транзакции установлено, false если нет + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Описание транзакции | + +**Returns:** mixed - + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает чек, если он есть + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null если чека нет + + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет наличие чека в создаваемом платеже + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если чек есть, false если нет + + + +#### public getPaymentToken() : string + +```php +public getPaymentToken() : string +``` + +**Summary** + +Возвращает одноразовый токен для проведения оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** string - Одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + + + +#### public hasPaymentToken() : bool + +```php +public hasPaymentToken() : bool +``` + +**Summary** + +Проверяет наличие одноразового токена для проведения оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если токен установлен, false если нет + + + +#### public setPaymentToken() : mixed + +```php +public setPaymentToken(string value) : mixed +``` + +**Summary** + +Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Одноразовый токен для проведения оплаты | + +**Returns:** mixed - + + + +#### public getPaymentMethodId() : string + +```php +public getPaymentMethodId() : string +``` + +**Summary** + +Устанавливает идентификатор закиси платёжных данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** string - Идентификатор записи о сохраненных платежных данных покупателя + + + +#### public hasPaymentMethodId() : bool + +```php +public hasPaymentMethodId() : bool +``` + +**Summary** + +Проверяет наличие идентификатора записи о платёжных данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если идентификатор задан, false если нет + + + +#### public setPaymentMethodId() : mixed + +```php +public setPaymentMethodId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор записи о сохранённых данных покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор записи о сохраненных платежных данных покупателя | + +**Returns:** mixed - + + + +#### public getPaymentMethodData() : \YooKassa\Model\PaymentData\AbstractPaymentData + +```php +public getPaymentMethodData() : \YooKassa\Model\PaymentData\AbstractPaymentData +``` + +**Summary** + +Возвращает данные для создания метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\PaymentData\AbstractPaymentData - Данные используемые для создания метода оплаты + + + +#### public hasPaymentMethodData() : bool + +```php +public hasPaymentMethodData() : bool +``` + +**Summary** + +Проверяет установлен ли объект с методом оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если объект метода оплаты установлен, false если нет + + + +#### public setPaymentMethodData() : mixed + +```php +public setPaymentMethodData(\YooKassa\Model\PaymentData\AbstractPaymentData|null value) : mixed +``` + +**Summary** + +Устанавливает объект с информацией для создания метода оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentData\AbstractPaymentData OR null | value | Объект с создания метода оплаты или null | + +**Returns:** mixed - + + + +#### public getConfirmation() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes + +```php +public getConfirmation() : \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes - Способ подтверждения платежа + + + +#### public hasConfirmation() : bool + +```php +public hasConfirmation() : bool +``` + +**Summary** + +Проверяет был ли установлен способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если способ подтверждения платежа был установлен, false если нет + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes|null value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes OR null | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public getSavePaymentMethod() : bool + +```php +public getSavePaymentMethod() : bool +``` + +**Summary** + +Возвращает флаг сохранения платёжных данных + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - Флаг сохранения платёжных данных + + + +#### public hasSavePaymentMethod() : bool + +```php +public hasSavePaymentMethod() : bool +``` + +**Summary** + +Проверяет был ли установлен флаг сохранения платёжных данных + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если флыг был установлен, false если нет + + + +#### public setSavePaymentMethod() : mixed + +```php +public setSavePaymentMethod(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Сохранить платежные данные для последующего использования | + +**Returns:** mixed - + + + +#### public getCapture() : bool + +```php +public getCapture() : bool +``` + +**Summary** + +Возвращает флаг автоматического принятия поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если требуется автоматически принять поступившую оплату, false если нет + + + +#### public hasCapture() : bool + +```php +public hasCapture() : bool +``` + +**Summary** + +Проверяет был ли установлен флаг автоматического приняти поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если флаг автоматического принятия оплаты был установлен, false если нет + + + +#### public setCapture() : mixed + +```php +public setCapture(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг автоматического принятия поступившей оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Автоматически принять поступившую оплату | + +**Returns:** mixed - + + + +#### public getClientIp() : string + +```php +public getClientIp() : string +``` + +**Summary** + +Возвращает IPv4 или IPv6-адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** string - IPv4 или IPv6-адрес покупателя + + + +#### public hasClientIp() : bool + +```php +public hasClientIp() : bool +``` + +**Summary** + +Проверяет был ли установлен IPv4 или IPv6-адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если IP адрес покупателя был установлен, false если нет + + + +#### public setClientIp() : mixed + +```php +public setClientIp(string value) : mixed +``` + +**Summary** + +Устанавливает IP адрес покупателя + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | IPv4 или IPv6-адрес покупателя | + +**Returns:** mixed - + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает данные оплаты установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные привязанные к платежу + + + +#### public hasMetadata() : bool + +```php +public hasMetadata() : bool +``` + +**Summary** + +Проверяет были ли установлены метаданные заказа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - True если метаданные были установлены, false если нет + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata|array|null value) : mixed +``` + +**Summary** + +Устанавливает метаданные, привязанные к платежу + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata OR array OR null | value | Метаданные платежа, устанавливаемые мерчантом | + +**Returns:** mixed - + + + +#### public getAirline() : \YooKassa\Model\Airline + +```php +public getAirline() : \YooKassa\Model\Airline +``` + +**Summary** + +Возвращает данные длинной записи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\Airline - + + + +#### public hasAirline() : bool + +```php +public hasAirline() : bool +``` + +**Summary** + +Проверяет были ли установлены данные длинной записи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - + + + +#### public setAirline() : mixed + +```php +public setAirline(\YooKassa\Model\AirlineInterface value) : mixed +``` + +**Summary** + +Устанавливает данные авиабилетов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AirlineInterface | value | Данные авиабилетов | + +**Returns:** mixed - + + + +#### public hasTransfers() : bool + +```php +public hasTransfers() : bool +``` + +**Summary** + +Проверяет наличие данных о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** bool - + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + +**Description** + +Присутствует, если вы используете решение ЮKassa для платформ. +(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег + + + +#### public setTransfers() : mixed + +```php +public setTransfers(mixed value) : mixed +``` + +**Summary** + +Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести. + +**Description** + +Присутствует, если вы используете решение ЮKassa для платформ. +(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | value | | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md new file mode 100644 index 00000000..2d9f2e5d --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\CreatePaymentRequestSerializer +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс сериалайзера объекта запроса к API на проведение платежа + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md#method_serialize) | | Формирует ассоциативный массив данных из объекта запроса | +--- +### Details +* File: [lib/Request/Payments/CreatePaymentRequestSerializer.php](../../lib/Request/Payments/CreatePaymentRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Payments\CreatePaymentRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Payments\CreatePaymentRequestInterface request) : array +``` + +**Summary** + +Формирует ассоциативный массив данных из объекта запроса + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\CreatePaymentRequestSerializer](../classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payments\CreatePaymentRequestInterface | request | Объект запроса | + +**Returns:** array - Массив данных для дальнейшего кодирования в JSON + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md b/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md new file mode 100644 index 00000000..499e40dc --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-CreatePaymentResponse.md @@ -0,0 +1,1667 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\CreatePaymentResponse +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс объекта ответа возвращаемого API при запросе на создание платежа + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Payment.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payment.md#property_amount) | | Сумма заказа | +| public | [$authorization_details](../classes/YooKassa-Model-Payment.md#property_authorization_details) | | Данные об авторизации платежа | +| public | [$authorizationDetails](../classes/YooKassa-Model-Payment.md#property_authorizationDetails) | | Данные об авторизации платежа | +| public | [$cancellation_details](../classes/YooKassa-Model-Payment.md#property_cancellation_details) | | Комментарий к отмене платежа | +| public | [$cancellationDetails](../classes/YooKassa-Model-Payment.md#property_cancellationDetails) | | Комментарий к отмене платежа | +| public | [$captured_at](../classes/YooKassa-Model-Payment.md#property_captured_at) | | Время подтверждения платежа магазином | +| public | [$capturedAt](../classes/YooKassa-Model-Payment.md#property_capturedAt) | | Время подтверждения платежа магазином | +| public | [$confirmation](../classes/YooKassa-Model-Payment.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$created_at](../classes/YooKassa-Model-Payment.md#property_created_at) | | Время создания заказа | +| public | [$createdAt](../classes/YooKassa-Model-Payment.md#property_createdAt) | | Время создания заказа | +| public | [$description](../classes/YooKassa-Model-Payment.md#property_description) | | Описание транзакции | +| public | [$expires_at](../classes/YooKassa-Model-Payment.md#property_expires_at) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$expiresAt](../classes/YooKassa-Model-Payment.md#property_expiresAt) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$id](../classes/YooKassa-Model-Payment.md#property_id) | | Идентификатор платежа | +| public | [$income_amount](../classes/YooKassa-Model-Payment.md#property_income_amount) | | Сумма платежа, которую получит магазин | +| public | [$incomeAmount](../classes/YooKassa-Model-Payment.md#property_incomeAmount) | | Сумма платежа, которую получит магазин | +| public | [$metadata](../classes/YooKassa-Model-Payment.md#property_metadata) | | Метаданные платежа указанные мерчантом | +| public | [$paid](../classes/YooKassa-Model-Payment.md#property_paid) | | Признак оплаты заказа | +| public | [$payment_method](../classes/YooKassa-Model-Payment.md#property_payment_method) | | Способ проведения платежа | +| public | [$paymentMethod](../classes/YooKassa-Model-Payment.md#property_paymentMethod) | | Способ проведения платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Payment.md#property_receipt_registration) | | Состояние регистрации фискального чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Payment.md#property_receiptRegistration) | | Состояние регистрации фискального чека | +| public | [$recipient](../classes/YooKassa-Model-Payment.md#property_recipient) | | Получатель платежа | +| public | [$refundable](../classes/YooKassa-Model-Payment.md#property_refundable) | | Возможность провести возврат по API | +| public | [$refunded_amount](../classes/YooKassa-Model-Payment.md#property_refunded_amount) | | Сумма возвращенных средств платежа | +| public | [$refundedAmount](../classes/YooKassa-Model-Payment.md#property_refundedAmount) | | Сумма возвращенных средств платежа | +| public | [$requestor](../classes/YooKassa-Model-Payment.md#property_requestor) | | Инициатор платежа | +| public | [$status](../classes/YooKassa-Model-Payment.md#property_status) | | Текущее состояние платежа | +| public | [$test](../classes/YooKassa-Model-Payment.md#property_test) | | Признак тестовой операции | +| public | [$transfers](../classes/YooKassa-Model-Payment.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Payment.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-Payment.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-Payment.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-Payment.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getDescription()](../classes/YooKassa-Model-Payment.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getExpiresAt()](../classes/YooKassa-Model-Payment.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-Payment.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_getIncomeAmount) | | Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [getMetadata()](../classes/YooKassa-Model-Payment.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-Payment.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-Payment.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-Payment.md#method_getRefundable) | | Проверяет возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-Payment.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | +| public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | +| public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [setCapturedAt()](../classes/YooKassa-Model-Payment.md#method_setCapturedAt) | | Устанавливает время подтверждения платежа магазином | +| public | [setConfirmation()](../classes/YooKassa-Model-Payment.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCreatedAt()](../classes/YooKassa-Model-Payment.md#method_setCreatedAt) | | Устанавливает время создания заказа | +| public | [setDescription()](../classes/YooKassa-Model-Payment.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setExpiresAt()](../classes/YooKassa-Model-Payment.md#method_setExpiresAt) | | Устанавливает время до которого можно бесплатно отменить или подтвердить платеж | +| public | [setId()](../classes/YooKassa-Model-Payment.md#method_setId) | | Устанавливает идентификатор платежа | +| public | [setIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_setIncomeAmount) | | Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [setMetadata()](../classes/YooKassa-Model-Payment.md#method_setMetadata) | | Устанавливает метаданные платежа | +| public | [setPaid()](../classes/YooKassa-Model-Payment.md#method_setPaid) | | Устанавливает флаг оплаты заказа | +| public | [setPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_setPaymentMethod) | | Устанавливает используемый способ проведения платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_setReceiptRegistration) | | Устанавливает состояние регистрации фискального чека | +| public | [setRecipient()](../classes/YooKassa-Model-Payment.md#method_setRecipient) | | Устанавливает получателя платежа | +| public | [setRefundable()](../classes/YooKassa-Model-Payment.md#method_setRefundable) | | Устанавливает возможность провести возврат по API | +| public | [setRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_setRefundedAmount) | | Устанавливает сумму возвращенных средств | +| public | [setRequestor()](../classes/YooKassa-Model-Payment.md#method_setRequestor) | | Устанавливает инициатора платежа | +| public | [setStatus()](../classes/YooKassa-Model-Payment.md#method_setStatus) | | Устанавливает статус платежа | +| public | [setTest()](../classes/YooKassa-Model-Payment.md#method_setTest) | | Устанавливает признак тестовой операции | +| public | [setTransfers()](../classes/YooKassa-Model-Payment.md#method_setTransfers) | | Устанавливает массив распределения денег между магазинами | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Payments/CreatePaymentResponse.php](../../lib/Request/Payments/CreatePaymentResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + * [\YooKassa\Request\Payments\AbstractPaymentResponse](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md) + * \YooKassa\Request\Payments\CreatePaymentResponse +--- +## Constants + +###### MAX_LENGTH_DESCRIPTION +Inherited from [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +Максимальная длина строки описания платежа + +```php +MAX_LENGTH_DESCRIPTION = 128 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма заказа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorizationDetails : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $captured_at : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $capturedAt : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $confirmation : \YooKassa\Model\Confirmation\AbstractConfirmation +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmation + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expires_at : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expiresAt : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $income_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $incomeAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные платежа указанные мерчантом + +**Type:** Metadata + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paid : bool +--- +***Description*** + +Признак оплаты заказа + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $payment_method : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paymentMethod : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа + +**Type:** RecipientInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundable : bool +--- +***Description*** + +Возможность провести возврат по API + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refunded_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundedAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $requestor : \YooKassa\Model\Requestor +--- +***Description*** + +Инициатор платежа + +**Type:** Requestor + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $status : string +--- +***Description*** + +Текущее состояние платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount +``` + +**Summary** + +Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Проверяет возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Возможность провести возврат по API, true если есть, false если нет + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setAuthorizationDetails() : mixed + +```php +public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AuthorizationDetailsInterface | value | Данные об авторизации платежа | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : mixed + +```php +public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\CancellationDetailsInterface | value | Комментарий к статусу canceled | + +**Returns:** mixed - + + + +#### public setCapturedAt() : mixed + +```php +public setCapturedAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время подтверждения платежа магазином + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения платежа магазином | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасвается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Confirmation\AbstractConfirmation | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime|string|int value) : mixed +``` + +**Summary** + +Устанавливает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | value | Время создания заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setExpiresAt() : mixed + +```php +public setExpiresAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время до которого можно бесплатно отменить или подтвердить платеж + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время, до которого можно бесплатно отменить или подтвердить платеж | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setIncomeAmount() : mixed + +```php +public setIncomeAmount(\YooKassa\Model\MonetaryAmount amount) : mixed +``` + +**Summary** + +Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\MonetaryAmount | amount | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata value) : mixed +``` + +**Summary** + +Устанавливает метаданные платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata | value | Метаданные платежа указанные мерчантом | + +**Returns:** mixed - + + + +#### public setPaid() : mixed + +```php +public setPaid(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак оплаты заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod value) : mixed +``` + +**Summary** + +Устанавливает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\AbstractPaymentMethod | value | Способ проведения платежа | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface value) : mixed +``` + +**Summary** + +Устанавливает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface | value | Объект с информацией о получателе платежа | + +**Returns:** mixed - + + + +#### public setRefundable() : mixed + +```php +public setRefundable(bool value) : mixed +``` + +**Summary** + +Устанавливает возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность провести возврат по API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setRefundedAmount() : mixed + +```php +public setRefundedAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возвращенных средств платежа | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setTest() : mixed + +```php +public setTest(bool test) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md b/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md new file mode 100644 index 00000000..dfd82ab0 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-Payment-CancelResponse.md @@ -0,0 +1,1667 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\Payment\CancelResponse +### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +--- +**Summary:** + +Класс объекта ответа от API на запрос отмены платежа + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Payment.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payment.md#property_amount) | | Сумма заказа | +| public | [$authorization_details](../classes/YooKassa-Model-Payment.md#property_authorization_details) | | Данные об авторизации платежа | +| public | [$authorizationDetails](../classes/YooKassa-Model-Payment.md#property_authorizationDetails) | | Данные об авторизации платежа | +| public | [$cancellation_details](../classes/YooKassa-Model-Payment.md#property_cancellation_details) | | Комментарий к отмене платежа | +| public | [$cancellationDetails](../classes/YooKassa-Model-Payment.md#property_cancellationDetails) | | Комментарий к отмене платежа | +| public | [$captured_at](../classes/YooKassa-Model-Payment.md#property_captured_at) | | Время подтверждения платежа магазином | +| public | [$capturedAt](../classes/YooKassa-Model-Payment.md#property_capturedAt) | | Время подтверждения платежа магазином | +| public | [$confirmation](../classes/YooKassa-Model-Payment.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$created_at](../classes/YooKassa-Model-Payment.md#property_created_at) | | Время создания заказа | +| public | [$createdAt](../classes/YooKassa-Model-Payment.md#property_createdAt) | | Время создания заказа | +| public | [$description](../classes/YooKassa-Model-Payment.md#property_description) | | Описание транзакции | +| public | [$expires_at](../classes/YooKassa-Model-Payment.md#property_expires_at) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$expiresAt](../classes/YooKassa-Model-Payment.md#property_expiresAt) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$id](../classes/YooKassa-Model-Payment.md#property_id) | | Идентификатор платежа | +| public | [$income_amount](../classes/YooKassa-Model-Payment.md#property_income_amount) | | Сумма платежа, которую получит магазин | +| public | [$incomeAmount](../classes/YooKassa-Model-Payment.md#property_incomeAmount) | | Сумма платежа, которую получит магазин | +| public | [$metadata](../classes/YooKassa-Model-Payment.md#property_metadata) | | Метаданные платежа указанные мерчантом | +| public | [$paid](../classes/YooKassa-Model-Payment.md#property_paid) | | Признак оплаты заказа | +| public | [$payment_method](../classes/YooKassa-Model-Payment.md#property_payment_method) | | Способ проведения платежа | +| public | [$paymentMethod](../classes/YooKassa-Model-Payment.md#property_paymentMethod) | | Способ проведения платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Payment.md#property_receipt_registration) | | Состояние регистрации фискального чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Payment.md#property_receiptRegistration) | | Состояние регистрации фискального чека | +| public | [$recipient](../classes/YooKassa-Model-Payment.md#property_recipient) | | Получатель платежа | +| public | [$refundable](../classes/YooKassa-Model-Payment.md#property_refundable) | | Возможность провести возврат по API | +| public | [$refunded_amount](../classes/YooKassa-Model-Payment.md#property_refunded_amount) | | Сумма возвращенных средств платежа | +| public | [$refundedAmount](../classes/YooKassa-Model-Payment.md#property_refundedAmount) | | Сумма возвращенных средств платежа | +| public | [$requestor](../classes/YooKassa-Model-Payment.md#property_requestor) | | Инициатор платежа | +| public | [$status](../classes/YooKassa-Model-Payment.md#property_status) | | Текущее состояние платежа | +| public | [$test](../classes/YooKassa-Model-Payment.md#property_test) | | Признак тестовой операции | +| public | [$transfers](../classes/YooKassa-Model-Payment.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Payment.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-Payment.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-Payment.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-Payment.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getDescription()](../classes/YooKassa-Model-Payment.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getExpiresAt()](../classes/YooKassa-Model-Payment.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-Payment.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_getIncomeAmount) | | Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [getMetadata()](../classes/YooKassa-Model-Payment.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-Payment.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-Payment.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-Payment.md#method_getRefundable) | | Проверяет возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-Payment.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | +| public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | +| public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [setCapturedAt()](../classes/YooKassa-Model-Payment.md#method_setCapturedAt) | | Устанавливает время подтверждения платежа магазином | +| public | [setConfirmation()](../classes/YooKassa-Model-Payment.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCreatedAt()](../classes/YooKassa-Model-Payment.md#method_setCreatedAt) | | Устанавливает время создания заказа | +| public | [setDescription()](../classes/YooKassa-Model-Payment.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setExpiresAt()](../classes/YooKassa-Model-Payment.md#method_setExpiresAt) | | Устанавливает время до которого можно бесплатно отменить или подтвердить платеж | +| public | [setId()](../classes/YooKassa-Model-Payment.md#method_setId) | | Устанавливает идентификатор платежа | +| public | [setIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_setIncomeAmount) | | Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [setMetadata()](../classes/YooKassa-Model-Payment.md#method_setMetadata) | | Устанавливает метаданные платежа | +| public | [setPaid()](../classes/YooKassa-Model-Payment.md#method_setPaid) | | Устанавливает флаг оплаты заказа | +| public | [setPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_setPaymentMethod) | | Устанавливает используемый способ проведения платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_setReceiptRegistration) | | Устанавливает состояние регистрации фискального чека | +| public | [setRecipient()](../classes/YooKassa-Model-Payment.md#method_setRecipient) | | Устанавливает получателя платежа | +| public | [setRefundable()](../classes/YooKassa-Model-Payment.md#method_setRefundable) | | Устанавливает возможность провести возврат по API | +| public | [setRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_setRefundedAmount) | | Устанавливает сумму возвращенных средств | +| public | [setRequestor()](../classes/YooKassa-Model-Payment.md#method_setRequestor) | | Устанавливает инициатора платежа | +| public | [setStatus()](../classes/YooKassa-Model-Payment.md#method_setStatus) | | Устанавливает статус платежа | +| public | [setTest()](../classes/YooKassa-Model-Payment.md#method_setTest) | | Устанавливает признак тестовой операции | +| public | [setTransfers()](../classes/YooKassa-Model-Payment.md#method_setTransfers) | | Устанавливает массив распределения денег между магазинами | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Payments/Payment/CancelResponse.php](../../lib/Request/Payments/Payment/CancelResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + * [\YooKassa\Request\Payments\AbstractPaymentResponse](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md) + * \YooKassa\Request\Payments\Payment\CancelResponse +--- +## Constants + +###### MAX_LENGTH_DESCRIPTION +Inherited from [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +Максимальная длина строки описания платежа + +```php +MAX_LENGTH_DESCRIPTION = 128 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма заказа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorizationDetails : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $captured_at : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $capturedAt : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $confirmation : \YooKassa\Model\Confirmation\AbstractConfirmation +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmation + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expires_at : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expiresAt : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $income_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $incomeAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные платежа указанные мерчантом + +**Type:** Metadata + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paid : bool +--- +***Description*** + +Признак оплаты заказа + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $payment_method : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paymentMethod : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа + +**Type:** RecipientInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundable : bool +--- +***Description*** + +Возможность провести возврат по API + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refunded_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundedAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $requestor : \YooKassa\Model\Requestor +--- +***Description*** + +Инициатор платежа + +**Type:** Requestor + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $status : string +--- +***Description*** + +Текущее состояние платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount +``` + +**Summary** + +Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Проверяет возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Возможность провести возврат по API, true если есть, false если нет + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setAuthorizationDetails() : mixed + +```php +public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AuthorizationDetailsInterface | value | Данные об авторизации платежа | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : mixed + +```php +public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\CancellationDetailsInterface | value | Комментарий к статусу canceled | + +**Returns:** mixed - + + + +#### public setCapturedAt() : mixed + +```php +public setCapturedAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время подтверждения платежа магазином + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения платежа магазином | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасвается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Confirmation\AbstractConfirmation | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime|string|int value) : mixed +``` + +**Summary** + +Устанавливает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | value | Время создания заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setExpiresAt() : mixed + +```php +public setExpiresAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время до которого можно бесплатно отменить или подтвердить платеж + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время, до которого можно бесплатно отменить или подтвердить платеж | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setIncomeAmount() : mixed + +```php +public setIncomeAmount(\YooKassa\Model\MonetaryAmount amount) : mixed +``` + +**Summary** + +Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\MonetaryAmount | amount | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata value) : mixed +``` + +**Summary** + +Устанавливает метаданные платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata | value | Метаданные платежа указанные мерчантом | + +**Returns:** mixed - + + + +#### public setPaid() : mixed + +```php +public setPaid(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак оплаты заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod value) : mixed +``` + +**Summary** + +Устанавливает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\AbstractPaymentMethod | value | Способ проведения платежа | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface value) : mixed +``` + +**Summary** + +Устанавливает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface | value | Объект с информацией о получателе платежа | + +**Returns:** mixed - + + + +#### public setRefundable() : mixed + +```php +public setRefundable(bool value) : mixed +``` + +**Summary** + +Устанавливает возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность провести возврат по API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setRefundedAmount() : mixed + +```php +public setRefundedAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возвращенных средств платежа | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setTest() : mixed + +```php +public setTest(bool test) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md new file mode 100644 index 00000000..89ca9d77 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md @@ -0,0 +1,695 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\Payment\CreateCaptureRequest +### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +--- +**Summary:** + +Класс объекта запроса к API на подтверждение оплаты + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#property_amount) | | Подтверждаемая сумма оплаты | +| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | +| public | [$receipt](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_builder) | | Возвращает билдер объектов запросов на подтверждение оплаты | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getReceipt) | | Возвращает чек, если он есть | +| public | [getTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. | +| public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | +| public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md#method_validate) | | Валидирует объект запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Payments/Payment/CreateCaptureRequest.php](../../lib/Request/Payments/Payment/CreateCaptureRequest.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + * \YooKassa\Request\Payments\Payment\CreateCaptureRequest +* Implements: + * [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Подтверждаемая сумма оплаты + +**Type:** AmountInterface + +**Details:** + + + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder +``` + +**Summary** + +Возвращает билдер объектов запросов на подтверждение оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) + +**Returns:** \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder - Инстанс билдера + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает чек, если он есть + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null если чека нет + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + +**Description** + +Присутствует, если вы используете решение ЮKassa для платформ. +(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет наличие чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если чек есть, false если нет + + + +#### public hasTransfers() : bool + +```php +public hasTransfers() : bool +``` + +**Summary** + +Проверяет наличие данных о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public removeReceipt() : mixed + +```php +public removeReceipt() : mixed +``` + +**Summary** + +Удаляет чек из запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public setReceipt() : mixed + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|null value) : mixed +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : mixed +``` + +**Summary** + +Устанавливает transfers (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Валидирует объект запроса + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) + +**Returns:** bool - True если запрос валиден и его можно отправить в API, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md new file mode 100644 index 00000000..033c557d --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md @@ -0,0 +1,444 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder +### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +--- +**Summary:** + +Базовый класс объекта платежного запроса, передаваемого в методы клиента API + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$amount](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_amount) | | Сумма | +| protected | [$currentObject](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md#property_currentObject) | | Собираемый объект запроса | +| protected | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_receipt) | | Объект с информацией о чеке | +| protected | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_transfers) | | Массив платежей в пользу разных мерчантов | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [addReceiptItem()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptItem) | | Добавляет в чек товар | +| public | [addReceiptShipping()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptShipping) | | Добавляет в чек доставку товара | +| public | [build()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md#method_build) | | Осуществляет сборку объекта запроса к API | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setAmount) | | Устанавливает сумму | +| public | [setCurrency()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceipt) | | Устанавливает чек | +| public | [setReceiptEmail()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptEmail) | | Устанавливает адрес электронной почты получателя чека | +| public | [setReceiptItems()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptItems) | | Устанавлвиает список товаров для создания чека | +| public | [setReceiptPhone()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptPhone) | | Устанавливает телефон получателя чека | +| public | [setTaxSystemCode()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения. | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTransfers) | | Устанавливает трансферы | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md#method_initCurrentObject) | | Инициализирует пустой запрос | +--- +### Details +* File: [lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php](../../lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + * \YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder +--- +## Properties + +#### protected $amount : \YooKassa\Model\MonetaryAmount +--- +**Summary** + +Сумма + +**Type:** MonetaryAmount + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +#### protected $currentObject : \YooKassa\Request\Payments\Payment\CreateCaptureRequest +--- +**Summary** + +Собираемый объект запроса + +**Type:** CreateCaptureRequest + +**Details:** + + + +#### protected $receipt : \YooKassa\Model\Receipt +--- +**Summary** + +Объект с информацией о чеке + +**Type:** Receipt + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +#### protected $transfers : \YooKassa\Model\TransferInterface[] +--- +**Summary** + +Массив платежей в пользу разных мерчантов + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public addReceiptItem() : self + +```php +public addReceiptItem(string title, string price, float quantity, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек товар + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название или описание товара | +| string | price | Цена товара в валюте, заданной в заказе | +| float | quantity | Количество товара | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public addReceiptShipping() : self + +```php +public addReceiptShipping(string title, string price, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек доставку товара + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название доставки в чеке | +| string | price | Стоимость доставки | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public build() : \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface|\YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Осуществляет сборку объекта запроса к API + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив дополнительных настроек объекта | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если при валидации запроса произошла ошибка | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданных в массиве настроек | + +**Returns:** \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface|\YooKassa\Common\AbstractRequest - Иснатс объекта запроса к API + + + +#### public setAmount() : self + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|string value) : self +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR string | value | Сумма оплаты | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setCurrency() : self + +```php +public setCurrency(string value) : self +``` + +**Summary** + +Устанавливает валюту в которой будет происходить подтверждение оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Валюта в которой подтверждается оплата | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setReceipt() : self + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|array value) : self +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR array | value | Инстанс чека или ассоциативный массив с данными чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | + +**Returns:** self - + + + +#### public setReceiptEmail() : self + +```php +public setReceiptEmail(string value) : self +``` + +**Summary** + +Устанавливает адрес электронной почты получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Email получателя чека | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptItems() : self + +```php +public setReceiptItems(array value) : self +``` + +**Summary** + +Устанавлвиает список товаров для создания чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | value | Массив товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если хотя бы один из товаров имеет неверную структуру | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptPhone() : self + +```php +public setReceiptPhone(string value) : self +``` + +**Summary** + +Устанавливает телефон получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Телефон получателя чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTaxSystemCode() : self + +```php +public setTaxSystemCode(int value) : self +``` + +**Summary** + +Устанавливает код системы налогообложения. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6. | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTransfers() : self + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : self +``` + +**Summary** + +Устанавливает трансферы + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | Массив трансферов | + +**Returns:** self - Инстанс билдера запросов + + + +#### protected initCurrentObject() : \YooKassa\Request\Payments\Payment\CreateCaptureRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Payments\Payment\CreateCaptureRequest +``` + +**Summary** + +Инициализирует пустой запрос + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md) + +**Returns:** \YooKassa\Request\Payments\Payment\CreateCaptureRequest - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md new file mode 100644 index 00000000..7a6c321b --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md @@ -0,0 +1,235 @@ +# [YooKassa API SDK](../home.md) + +# Interface: CreateCaptureRequestInterface +### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +--- +**Summary:** + +Interface CreateCaptureRequestInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_getAmount) | | Возвращает подтверждаемую сумму оплаты | +| public | [getReceipt()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_getReceipt) | | Возвращает чек, если он есть | +| public | [getTransfers()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_getTransfers) | | Возвращает данные о распределении денег | +| public | [hasAmount()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasReceipt()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_hasReceipt) | | Проверяет наличие чека в создаваемом платеже | +| public | [hasTransfers()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | +| public | [setAmount()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setReceipt()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_setReceipt) | | Устанавливает чек | +| public | [setTransfers()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) | + +--- +### Details +* File: [lib/Request/Payments/Payment/CreateCaptureRequestInterface.php](../../lib/Request/Payments/Payment/CreateCaptureRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Подтверждаемая сумма оплаты | +| property-read | | Данные фискального чека 54-ФЗ | +--- +## Methods + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает подтверждаемую сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Подтверждаемая сумма оплаты + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает чек, если он есть + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null если чека нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет наличие чека в создаваемом платеже + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) + +**Returns:** bool - True если чек есть, false если нет + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setReceipt() : mixed + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|null value) : mixed +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null | + +**Returns:** mixed - + + + +#### public hasTransfers() : bool + +```php +public hasTransfers() : bool +``` + +**Summary** + +Проверяет наличие данных о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) + +**Returns:** bool - + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : mixed +``` + +**Summary** + +Устанавливает transfers (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | | + +**Returns:** mixed - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md new file mode 100644 index 00000000..1535345b --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\Payment\CreateCaptureRequestSerializer +### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +--- +**Summary:** + +Класс объекта осуществляющего сериализацию запроса к API на подтверждение заказа + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md#method_serialize) | | Сериализует объект запроса к API на подтверждение заказа в ассоциативный массив | +--- +### Details +* File: [lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php](../../lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Payments\Payment\CreateCaptureRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface request) : array +``` + +**Summary** + +Сериализует объект запроса к API на подтверждение заказа в ассоциативный массив + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\Payment\CreateCaptureRequestSerializer](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface | request | Сериализуемый объект запроса | + +**Returns:** array - Ассоциативный массив содержащий информацию для отправки в API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md new file mode 100644 index 00000000..38902791 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md @@ -0,0 +1,1667 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\Payment\CreateCaptureResponse +### Namespace: [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +--- +**Summary:** + +Класс объекта ответа от API на запрос подтверждения платежа + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Payment.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payment.md#property_amount) | | Сумма заказа | +| public | [$authorization_details](../classes/YooKassa-Model-Payment.md#property_authorization_details) | | Данные об авторизации платежа | +| public | [$authorizationDetails](../classes/YooKassa-Model-Payment.md#property_authorizationDetails) | | Данные об авторизации платежа | +| public | [$cancellation_details](../classes/YooKassa-Model-Payment.md#property_cancellation_details) | | Комментарий к отмене платежа | +| public | [$cancellationDetails](../classes/YooKassa-Model-Payment.md#property_cancellationDetails) | | Комментарий к отмене платежа | +| public | [$captured_at](../classes/YooKassa-Model-Payment.md#property_captured_at) | | Время подтверждения платежа магазином | +| public | [$capturedAt](../classes/YooKassa-Model-Payment.md#property_capturedAt) | | Время подтверждения платежа магазином | +| public | [$confirmation](../classes/YooKassa-Model-Payment.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$created_at](../classes/YooKassa-Model-Payment.md#property_created_at) | | Время создания заказа | +| public | [$createdAt](../classes/YooKassa-Model-Payment.md#property_createdAt) | | Время создания заказа | +| public | [$description](../classes/YooKassa-Model-Payment.md#property_description) | | Описание транзакции | +| public | [$expires_at](../classes/YooKassa-Model-Payment.md#property_expires_at) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$expiresAt](../classes/YooKassa-Model-Payment.md#property_expiresAt) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$id](../classes/YooKassa-Model-Payment.md#property_id) | | Идентификатор платежа | +| public | [$income_amount](../classes/YooKassa-Model-Payment.md#property_income_amount) | | Сумма платежа, которую получит магазин | +| public | [$incomeAmount](../classes/YooKassa-Model-Payment.md#property_incomeAmount) | | Сумма платежа, которую получит магазин | +| public | [$metadata](../classes/YooKassa-Model-Payment.md#property_metadata) | | Метаданные платежа указанные мерчантом | +| public | [$paid](../classes/YooKassa-Model-Payment.md#property_paid) | | Признак оплаты заказа | +| public | [$payment_method](../classes/YooKassa-Model-Payment.md#property_payment_method) | | Способ проведения платежа | +| public | [$paymentMethod](../classes/YooKassa-Model-Payment.md#property_paymentMethod) | | Способ проведения платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Payment.md#property_receipt_registration) | | Состояние регистрации фискального чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Payment.md#property_receiptRegistration) | | Состояние регистрации фискального чека | +| public | [$recipient](../classes/YooKassa-Model-Payment.md#property_recipient) | | Получатель платежа | +| public | [$refundable](../classes/YooKassa-Model-Payment.md#property_refundable) | | Возможность провести возврат по API | +| public | [$refunded_amount](../classes/YooKassa-Model-Payment.md#property_refunded_amount) | | Сумма возвращенных средств платежа | +| public | [$refundedAmount](../classes/YooKassa-Model-Payment.md#property_refundedAmount) | | Сумма возвращенных средств платежа | +| public | [$requestor](../classes/YooKassa-Model-Payment.md#property_requestor) | | Инициатор платежа | +| public | [$status](../classes/YooKassa-Model-Payment.md#property_status) | | Текущее состояние платежа | +| public | [$test](../classes/YooKassa-Model-Payment.md#property_test) | | Признак тестовой операции | +| public | [$transfers](../classes/YooKassa-Model-Payment.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Payment.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-Payment.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-Payment.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-Payment.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getDescription()](../classes/YooKassa-Model-Payment.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getExpiresAt()](../classes/YooKassa-Model-Payment.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-Payment.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_getIncomeAmount) | | Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [getMetadata()](../classes/YooKassa-Model-Payment.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-Payment.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-Payment.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-Payment.md#method_getRefundable) | | Проверяет возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-Payment.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | +| public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | +| public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [setCapturedAt()](../classes/YooKassa-Model-Payment.md#method_setCapturedAt) | | Устанавливает время подтверждения платежа магазином | +| public | [setConfirmation()](../classes/YooKassa-Model-Payment.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCreatedAt()](../classes/YooKassa-Model-Payment.md#method_setCreatedAt) | | Устанавливает время создания заказа | +| public | [setDescription()](../classes/YooKassa-Model-Payment.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setExpiresAt()](../classes/YooKassa-Model-Payment.md#method_setExpiresAt) | | Устанавливает время до которого можно бесплатно отменить или подтвердить платеж | +| public | [setId()](../classes/YooKassa-Model-Payment.md#method_setId) | | Устанавливает идентификатор платежа | +| public | [setIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_setIncomeAmount) | | Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [setMetadata()](../classes/YooKassa-Model-Payment.md#method_setMetadata) | | Устанавливает метаданные платежа | +| public | [setPaid()](../classes/YooKassa-Model-Payment.md#method_setPaid) | | Устанавливает флаг оплаты заказа | +| public | [setPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_setPaymentMethod) | | Устанавливает используемый способ проведения платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_setReceiptRegistration) | | Устанавливает состояние регистрации фискального чека | +| public | [setRecipient()](../classes/YooKassa-Model-Payment.md#method_setRecipient) | | Устанавливает получателя платежа | +| public | [setRefundable()](../classes/YooKassa-Model-Payment.md#method_setRefundable) | | Устанавливает возможность провести возврат по API | +| public | [setRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_setRefundedAmount) | | Устанавливает сумму возвращенных средств | +| public | [setRequestor()](../classes/YooKassa-Model-Payment.md#method_setRequestor) | | Устанавливает инициатора платежа | +| public | [setStatus()](../classes/YooKassa-Model-Payment.md#method_setStatus) | | Устанавливает статус платежа | +| public | [setTest()](../classes/YooKassa-Model-Payment.md#method_setTest) | | Устанавливает признак тестовой операции | +| public | [setTransfers()](../classes/YooKassa-Model-Payment.md#method_setTransfers) | | Устанавливает массив распределения денег между магазинами | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Payments/Payment/CreateCaptureResponse.php](../../lib/Request/Payments/Payment/CreateCaptureResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + * [\YooKassa\Request\Payments\AbstractPaymentResponse](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md) + * \YooKassa\Request\Payments\Payment\CreateCaptureResponse +--- +## Constants + +###### MAX_LENGTH_DESCRIPTION +Inherited from [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +Максимальная длина строки описания платежа + +```php +MAX_LENGTH_DESCRIPTION = 128 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма заказа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorizationDetails : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $captured_at : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $capturedAt : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $confirmation : \YooKassa\Model\Confirmation\AbstractConfirmation +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmation + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expires_at : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expiresAt : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $income_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $incomeAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные платежа указанные мерчантом + +**Type:** Metadata + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paid : bool +--- +***Description*** + +Признак оплаты заказа + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $payment_method : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paymentMethod : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа + +**Type:** RecipientInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundable : bool +--- +***Description*** + +Возможность провести возврат по API + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refunded_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundedAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $requestor : \YooKassa\Model\Requestor +--- +***Description*** + +Инициатор платежа + +**Type:** Requestor + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $status : string +--- +***Description*** + +Текущее состояние платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount +``` + +**Summary** + +Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Проверяет возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Возможность провести возврат по API, true если есть, false если нет + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setAuthorizationDetails() : mixed + +```php +public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AuthorizationDetailsInterface | value | Данные об авторизации платежа | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : mixed + +```php +public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\CancellationDetailsInterface | value | Комментарий к статусу canceled | + +**Returns:** mixed - + + + +#### public setCapturedAt() : mixed + +```php +public setCapturedAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время подтверждения платежа магазином + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения платежа магазином | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасвается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Confirmation\AbstractConfirmation | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime|string|int value) : mixed +``` + +**Summary** + +Устанавливает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | value | Время создания заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setExpiresAt() : mixed + +```php +public setExpiresAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время до которого можно бесплатно отменить или подтвердить платеж + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время, до которого можно бесплатно отменить или подтвердить платеж | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setIncomeAmount() : mixed + +```php +public setIncomeAmount(\YooKassa\Model\MonetaryAmount amount) : mixed +``` + +**Summary** + +Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\MonetaryAmount | amount | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata value) : mixed +``` + +**Summary** + +Устанавливает метаданные платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata | value | Метаданные платежа указанные мерчантом | + +**Returns:** mixed - + + + +#### public setPaid() : mixed + +```php +public setPaid(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак оплаты заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod value) : mixed +``` + +**Summary** + +Устанавливает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\AbstractPaymentMethod | value | Способ проведения платежа | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface value) : mixed +``` + +**Summary** + +Устанавливает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface | value | Объект с информацией о получателе платежа | + +**Returns:** mixed - + + + +#### public setRefundable() : mixed + +```php +public setRefundable(bool value) : mixed +``` + +**Summary** + +Устанавливает возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность провести возврат по API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setRefundedAmount() : mixed + +```php +public setRefundedAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возвращенных средств платежа | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setTest() : mixed + +```php +public setTest(bool test) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentResponse.md b/docs/classes/YooKassa-Request-Payments-PaymentResponse.md new file mode 100644 index 00000000..f19030fe --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-PaymentResponse.md @@ -0,0 +1,1667 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\PaymentResponse +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс объекта ответа, возвращаемого API при запросе конкретного платежа + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LENGTH_DESCRIPTION](../classes/YooKassa-Model-Payment.md#constant_MAX_LENGTH_DESCRIPTION) | | Максимальная длина строки описания платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Payment.md#property_amount) | | Сумма заказа | +| public | [$authorization_details](../classes/YooKassa-Model-Payment.md#property_authorization_details) | | Данные об авторизации платежа | +| public | [$authorizationDetails](../classes/YooKassa-Model-Payment.md#property_authorizationDetails) | | Данные об авторизации платежа | +| public | [$cancellation_details](../classes/YooKassa-Model-Payment.md#property_cancellation_details) | | Комментарий к отмене платежа | +| public | [$cancellationDetails](../classes/YooKassa-Model-Payment.md#property_cancellationDetails) | | Комментарий к отмене платежа | +| public | [$captured_at](../classes/YooKassa-Model-Payment.md#property_captured_at) | | Время подтверждения платежа магазином | +| public | [$capturedAt](../classes/YooKassa-Model-Payment.md#property_capturedAt) | | Время подтверждения платежа магазином | +| public | [$confirmation](../classes/YooKassa-Model-Payment.md#property_confirmation) | | Способ подтверждения платежа | +| public | [$created_at](../classes/YooKassa-Model-Payment.md#property_created_at) | | Время создания заказа | +| public | [$createdAt](../classes/YooKassa-Model-Payment.md#property_createdAt) | | Время создания заказа | +| public | [$description](../classes/YooKassa-Model-Payment.md#property_description) | | Описание транзакции | +| public | [$expires_at](../classes/YooKassa-Model-Payment.md#property_expires_at) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$expiresAt](../classes/YooKassa-Model-Payment.md#property_expiresAt) | | Время, до которого можно бесплатно отменить или подтвердить платеж | +| public | [$id](../classes/YooKassa-Model-Payment.md#property_id) | | Идентификатор платежа | +| public | [$income_amount](../classes/YooKassa-Model-Payment.md#property_income_amount) | | Сумма платежа, которую получит магазин | +| public | [$incomeAmount](../classes/YooKassa-Model-Payment.md#property_incomeAmount) | | Сумма платежа, которую получит магазин | +| public | [$metadata](../classes/YooKassa-Model-Payment.md#property_metadata) | | Метаданные платежа указанные мерчантом | +| public | [$paid](../classes/YooKassa-Model-Payment.md#property_paid) | | Признак оплаты заказа | +| public | [$payment_method](../classes/YooKassa-Model-Payment.md#property_payment_method) | | Способ проведения платежа | +| public | [$paymentMethod](../classes/YooKassa-Model-Payment.md#property_paymentMethod) | | Способ проведения платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Payment.md#property_receipt_registration) | | Состояние регистрации фискального чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Payment.md#property_receiptRegistration) | | Состояние регистрации фискального чека | +| public | [$recipient](../classes/YooKassa-Model-Payment.md#property_recipient) | | Получатель платежа | +| public | [$refundable](../classes/YooKassa-Model-Payment.md#property_refundable) | | Возможность провести возврат по API | +| public | [$refunded_amount](../classes/YooKassa-Model-Payment.md#property_refunded_amount) | | Сумма возвращенных средств платежа | +| public | [$refundedAmount](../classes/YooKassa-Model-Payment.md#property_refundedAmount) | | Сумма возвращенных средств платежа | +| public | [$requestor](../classes/YooKassa-Model-Payment.md#property_requestor) | | Инициатор платежа | +| public | [$status](../classes/YooKassa-Model-Payment.md#property_status) | | Текущее состояние платежа | +| public | [$test](../classes/YooKassa-Model-Payment.md#property_test) | | Признак тестовой операции | +| public | [$transfers](../classes/YooKassa-Model-Payment.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Payment.md#method_getAmount) | | Возвращает сумму | +| public | [getAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_getAuthorizationDetails) | | Возвращает данные об авторизации платежа | +| public | [getCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_getCancellationDetails) | | Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [getCapturedAt()](../classes/YooKassa-Model-Payment.md#method_getCapturedAt) | | Возвращает время подтверждения платежа магазином или null если если время не задано | +| public | [getConfirmation()](../classes/YooKassa-Model-Payment.md#method_getConfirmation) | | Возвращает способ подтверждения платежа | +| public | [getCreatedAt()](../classes/YooKassa-Model-Payment.md#method_getCreatedAt) | | Возвращает время создания заказа | +| public | [getDescription()](../classes/YooKassa-Model-Payment.md#method_getDescription) | | Возвращает описание транзакции | +| public | [getExpiresAt()](../classes/YooKassa-Model-Payment.md#method_getExpiresAt) | | Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано | +| public | [getId()](../classes/YooKassa-Model-Payment.md#method_getId) | | Возвращает идентификатор платежа | +| public | [getIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_getIncomeAmount) | | Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [getMetadata()](../classes/YooKassa-Model-Payment.md#method_getMetadata) | | Возвращает метаданные платежа установленные мерчантом | +| public | [getPaid()](../classes/YooKassa-Model-Payment.md#method_getPaid) | | Проверяет был ли уже оплачен заказ | +| public | [getPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_getPaymentMethod) | | Возвращает используемый способ проведения платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_getReceiptRegistration) | | Возвращает состояние регистрации фискального чека | +| public | [getRecipient()](../classes/YooKassa-Model-Payment.md#method_getRecipient) | | Возвращает получателя платежа | +| public | [getRefundable()](../classes/YooKassa-Model-Payment.md#method_getRefundable) | | Проверяет возможность провести возврат по API | +| public | [getRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_getRefundedAmount) | | Возвращает сумму возвращенных средств | +| public | [getRequestor()](../classes/YooKassa-Model-Payment.md#method_getRequestor) | | Возвращает инициатора платежа | +| public | [getStatus()](../classes/YooKassa-Model-Payment.md#method_getStatus) | | Возвращает состояние платежа | +| public | [getTest()](../classes/YooKassa-Model-Payment.md#method_getTest) | | Возвращает признак тестовой операции | +| public | [getTransfers()](../classes/YooKassa-Model-Payment.md#method_getTransfers) | | Возвращает массив распределения денег между магазинами | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Payment.md#method_setAmount) | | Устанавливает сумму платежа | +| public | [setAuthorizationDetails()](../classes/YooKassa-Model-Payment.md#method_setAuthorizationDetails) | | Устанавливает данные об авторизации платежа | +| public | [setCancellationDetails()](../classes/YooKassa-Model-Payment.md#method_setCancellationDetails) | | Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине | +| public | [setCapturedAt()](../classes/YooKassa-Model-Payment.md#method_setCapturedAt) | | Устанавливает время подтверждения платежа магазином | +| public | [setConfirmation()](../classes/YooKassa-Model-Payment.md#method_setConfirmation) | | Устанавливает способ подтверждения платежа | +| public | [setCreatedAt()](../classes/YooKassa-Model-Payment.md#method_setCreatedAt) | | Устанавливает время создания заказа | +| public | [setDescription()](../classes/YooKassa-Model-Payment.md#method_setDescription) | | Устанавливает описание транзакции | +| public | [setExpiresAt()](../classes/YooKassa-Model-Payment.md#method_setExpiresAt) | | Устанавливает время до которого можно бесплатно отменить или подтвердить платеж | +| public | [setId()](../classes/YooKassa-Model-Payment.md#method_setId) | | Устанавливает идентификатор платежа | +| public | [setIncomeAmount()](../classes/YooKassa-Model-Payment.md#method_setIncomeAmount) | | Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa | +| public | [setMetadata()](../classes/YooKassa-Model-Payment.md#method_setMetadata) | | Устанавливает метаданные платежа | +| public | [setPaid()](../classes/YooKassa-Model-Payment.md#method_setPaid) | | Устанавливает флаг оплаты заказа | +| public | [setPaymentMethod()](../classes/YooKassa-Model-Payment.md#method_setPaymentMethod) | | Устанавливает используемый способ проведения платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Payment.md#method_setReceiptRegistration) | | Устанавливает состояние регистрации фискального чека | +| public | [setRecipient()](../classes/YooKassa-Model-Payment.md#method_setRecipient) | | Устанавливает получателя платежа | +| public | [setRefundable()](../classes/YooKassa-Model-Payment.md#method_setRefundable) | | Устанавливает возможность провести возврат по API | +| public | [setRefundedAmount()](../classes/YooKassa-Model-Payment.md#method_setRefundedAmount) | | Устанавливает сумму возвращенных средств | +| public | [setRequestor()](../classes/YooKassa-Model-Payment.md#method_setRequestor) | | Устанавливает инициатора платежа | +| public | [setStatus()](../classes/YooKassa-Model-Payment.md#method_setStatus) | | Устанавливает статус платежа | +| public | [setTest()](../classes/YooKassa-Model-Payment.md#method_setTest) | | Устанавливает признак тестовой операции | +| public | [setTransfers()](../classes/YooKassa-Model-Payment.md#method_setTransfers) | | Устанавливает массив распределения денег между магазинами | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Payments/PaymentResponse.php](../../lib/Request/Payments/PaymentResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + * [\YooKassa\Request\Payments\AbstractPaymentResponse](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md) + * \YooKassa\Request\Payments\PaymentResponse +--- +## Constants + +###### MAX_LENGTH_DESCRIPTION +Inherited from [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +Максимальная длина строки описания платежа + +```php +MAX_LENGTH_DESCRIPTION = 128 +``` + + +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма заказа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorization_details : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $authorizationDetails : \YooKassa\Model\AuthorizationDetailsInterface +--- +***Description*** + +Данные об авторизации платежа + +**Type:** AuthorizationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellation_details : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $cancellationDetails : \YooKassa\Model\CancellationDetailsInterface +--- +***Description*** + +Комментарий к отмене платежа + +**Type:** CancellationDetailsInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $captured_at : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $capturedAt : \DateTime +--- +***Description*** + +Время подтверждения платежа магазином + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $confirmation : \YooKassa\Model\Confirmation\AbstractConfirmation +--- +***Description*** + +Способ подтверждения платежа + +**Type:** AbstractConfirmation + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания заказа + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $description : string +--- +***Description*** + +Описание транзакции + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expires_at : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $expiresAt : \DateTime +--- +***Description*** + +Время, до которого можно бесплатно отменить или подтвердить платеж + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $income_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $incomeAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма платежа, которую получит магазин + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $metadata : \YooKassa\Model\Metadata +--- +***Description*** + +Метаданные платежа указанные мерчантом + +**Type:** Metadata + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paid : bool +--- +***Description*** + +Признак оплаты заказа + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $payment_method : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $paymentMethod : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +--- +***Description*** + +Способ проведения платежа + +**Type:** AbstractPaymentMethod + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Состояние регистрации фискального чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $recipient : \YooKassa\Model\RecipientInterface +--- +***Description*** + +Получатель платежа + +**Type:** RecipientInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundable : bool +--- +***Description*** + +Возможность провести возврат по API + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refunded_amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $refundedAmount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возвращенных средств платежа + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $requestor : \YooKassa\Model\Requestor +--- +***Description*** + +Инициатор платежа + +**Type:** Requestor + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $status : string +--- +***Description*** + +Текущее состояние платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $test : bool +--- +***Description*** + +Признак тестовой операции + +**Type:** bool + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма платежа + + + +#### public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null + +```php +public getAuthorizationDetails() : \YooKassa\Model\AuthorizationDetailsInterface|null +``` + +**Summary** + +Возвращает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AuthorizationDetailsInterface|null - Данные об авторизации платежа + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.18 | | + + +#### public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null + +```php +public getCancellationDetails() : \YooKassa\Model\CancellationDetailsInterface|null +``` + +**Summary** + +Возвращает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\CancellationDetailsInterface|null - Комментарий к статусу canceled + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.13 | | + + +#### public getCapturedAt() : \DateTime|null + +```php +public getCapturedAt() : \DateTime|null +``` + +**Summary** + +Возвращает время подтверждения платежа магазином или null если если время не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время подтверждения платежа магазином + + + +#### public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation + +```php +public getConfirmation() : \YooKassa\Model\Confirmation\AbstractConfirmation +``` + +**Summary** + +Возвращает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Confirmation\AbstractConfirmation - Способ подтверждения платежа + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime - Время создания заказа + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - + + + +#### public getExpiresAt() : \DateTime|null + +```php +public getExpiresAt() : \DateTime|null +``` + +**Summary** + +Возвращает время до которого можно бесплатно отменить или подтвердить платеж или null если оно не задано + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \DateTime|null - Время, до которого можно бесплатно отменить или подтвердить платеж + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getIncomeAmount() : \YooKassa\Model\MonetaryAmount + +```php +public getIncomeAmount() : \YooKassa\Model\MonetaryAmount +``` + +**Summary** + +Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\MonetaryAmount - Сумма платежа, которую получит магазин + + + +#### public getMetadata() : \YooKassa\Model\Metadata + +```php +public getMetadata() : \YooKassa\Model\Metadata +``` + +**Summary** + +Возвращает метаданные платежа установленные мерчантом + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\Metadata - Метаданные платежа указанные мерчантом + + + +#### public getPaid() : bool + +```php +public getPaid() : bool +``` + +**Summary** + +Проверяет был ли уже оплачен заказ + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак оплаты заказа, true если заказ оплачен, false если нет + + + +#### public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod + +```php +public getPaymentMethod() : \YooKassa\Model\PaymentMethod\AbstractPaymentMethod +``` + +**Summary** + +Возвращает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\PaymentMethod\AbstractPaymentMethod - Способ проведения платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Состояние регистрации фискального чека + + + +#### public getRecipient() : \YooKassa\Model\RecipientInterface|null + +```php +public getRecipient() : \YooKassa\Model\RecipientInterface|null +``` + +**Summary** + +Возвращает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RecipientInterface|null - Получатель платежа или null если получатель не задан + + + +#### public getRefundable() : bool + +```php +public getRefundable() : bool +``` + +**Summary** + +Проверяет возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Возможность провести возврат по API, true если есть, false если нет + + + +#### public getRefundedAmount() : \YooKassa\Model\AmountInterface + +```php +public getRefundedAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возвращенных средств платежа + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\RequestorInterface - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает состояние платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** string - Текущее состояние платежа + + + +#### public getTest() : bool + +```php +public getTest() : bool +``` + +**Summary** + +Возвращает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** bool - Признак тестовой операции + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма платежа | + +**Returns:** mixed - + + + +#### public setAuthorizationDetails() : mixed + +```php +public setAuthorizationDetails(\YooKassa\Model\AuthorizationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает данные об авторизации платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AuthorizationDetailsInterface | value | Данные об авторизации платежа | + +**Returns:** mixed - + + + +#### public setCancellationDetails() : mixed + +```php +public setCancellationDetails(\YooKassa\Model\CancellationDetailsInterface value) : mixed +``` + +**Summary** + +Устанавливает комментарий к статусу canceled: кто отменил платеж и по какой причине + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\CancellationDetailsInterface | value | Комментарий к статусу canceled | + +**Returns:** mixed - + + + +#### public setCapturedAt() : mixed + +```php +public setCapturedAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время подтверждения платежа магазином + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения платежа магазином | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасвается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setConfirmation() : mixed + +```php +public setConfirmation(\YooKassa\Model\Confirmation\AbstractConfirmation value) : mixed +``` + +**Summary** + +Устанавливает способ подтверждения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Confirmation\AbstractConfirmation | value | Способ подтверждения платежа | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime|string|int value) : mixed +``` + +**Summary** + +Устанавливает время создания заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int | value | Время создания заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если в метод была передана пустая дата | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает описание транзакции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение превышает допустимую длину | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданное значение не является строкой | + +**Returns:** mixed - + + + +#### public setExpiresAt() : mixed + +```php +public setExpiresAt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает время до которого можно бесплатно отменить или подтвердить платеж + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время, до которого можно бесплатно отменить или подтвердить платеж | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если передали строку, которую не удалось привести к дате | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если был передан аргумент, который невозможно интерпретировать как дату или время | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| since | 1.0.2 | | + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setIncomeAmount() : mixed + +```php +public setIncomeAmount(\YooKassa\Model\MonetaryAmount amount) : mixed +``` + +**Summary** + +Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\MonetaryAmount | amount | | + +**Returns:** mixed - + + + +#### public setMetadata() : mixed + +```php +public setMetadata(\YooKassa\Model\Metadata value) : mixed +``` + +**Summary** + +Устанавливает метаданные платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\Metadata | value | Метаданные платежа указанные мерчантом | + +**Returns:** mixed - + + + +#### public setPaid() : mixed + +```php +public setPaid(bool value) : mixed +``` + +**Summary** + +Устанавливает флаг оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак оплаты заказа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(\YooKassa\Model\PaymentMethod\AbstractPaymentMethod value) : mixed +``` + +**Summary** + +Устанавливает используемый способ проведения платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\PaymentMethod\AbstractPaymentMethod | value | Способ проведения платежа | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setRecipient() : mixed + +```php +public setRecipient(\YooKassa\Model\RecipientInterface value) : mixed +``` + +**Summary** + +Устанавливает получателя платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RecipientInterface | value | Объект с информацией о получателе платежа | + +**Returns:** mixed - + + + +#### public setRefundable() : mixed + +```php +public setRefundable(bool value) : mixed +``` + +**Summary** + +Устанавливает возможность провести возврат по API + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Возможность провести возврат по API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если переданный аргумент пуст | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не кастится в булево значение | + +**Returns:** mixed - + + + +#### public setRefundedAmount() : mixed + +```php +public setRefundedAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возвращенных средств + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возвращенных средств платежа | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setTest() : mixed + +```php +public setTest(bool test) : mixed +``` + +**Summary** + +Устанавливает признак тестовой операции + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | test | Признак тестовой операции | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив распределения денег между магазинами + +**Details:** +* Inherited From: [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md new file mode 100644 index 00000000..478c9aab --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequest.md @@ -0,0 +1,1348 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\PaymentsRequest +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс объекта запроса к API для получения списка платежей магазина + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LIMIT_VALUE](../classes/YooKassa-Request-Payments-PaymentsRequest.md#constant_MAX_LIMIT_VALUE) | | Максимальное количество объектов платежа в выборке | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$capturedAtGt](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_capturedAtGt) | | Время подтверждения, от (не включая) | +| public | [$capturedAtGte](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_capturedAtGte) | | Время подтверждения, от (включительно) | +| public | [$capturedAtLt](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_capturedAtLt) | | Время подтверждения, до (не включая) | +| public | [$capturedAtLte](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_capturedAtLte) | | Время подтверждения, до (включительно) | +| public | [$createdAtGt](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_createdAtGt) | | Время создания, от (не включая) | +| public | [$createdAtGte](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_createdAtGte) | | Время создания, от (включительно) | +| public | [$createdAtLt](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_createdAtLt) | | Время создания, до (не включая) | +| public | [$createdAtLte](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_createdAtLte) | | Время создания, до (включительно) | +| public | [$cursor](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_cursor) | | Страница выдачи результатов, которую необходимо отобразить | +| public | [$limit](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_limit) | | Ограничение количества объектов платежа, отображаемых на одной странице выдачи | +| public | [$paymentMethod](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_paymentMethod) | | Платежный метод | +| public | [$status](../classes/YooKassa-Request-Payments-PaymentsRequest.md#property_status) | | Статус платежа | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_builder) | | Возвращает инстанс билдера объектов запросов списка платежей магазина | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCapturedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCapturedAtGt) | | Возвращает дату подтверждения от которой будут возвращены платежи или null если дата не была установлена | +| public | [getCapturedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCapturedAtGte) | | Возвращает дату подтверждения от которой будут возвращены платежи или null если дата не была установлена | +| public | [getCapturedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCapturedAtLt) | | Возвращает дату подтверждения до которой будут возвращены платежи или null если дата не была установлена | +| public | [getCapturedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCapturedAtLte) | | Возвращает дату подтверждения до которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCreatedAtGt) | | Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCreatedAtGte) | | Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCreatedAtLt) | | Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCreatedAtLte) | | Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена | +| public | [getCursor()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getCursor) | | Страница выдачи результатов, которую необходимо отобразить | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getLimit()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getLimit) | | Ограничение количества объектов платежа | +| public | [getPaymentMethod()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getPaymentMethod) | | Возвращает платежный метод выбираемых платежей или null если он до этого не был установлен | +| public | [getStatus()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_getStatus) | | Возвращает статус выбираемых платежей или null если он до этого не был установлен | +| public | [hasCapturedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCapturedAtGt) | | Проверяет была ли установлена дата подтверждения от которой выбираются платежи | +| public | [hasCapturedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCapturedAtGte) | | Проверяет была ли установлена дата подтверждения от которой выбираются платежи | +| public | [hasCapturedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCapturedAtLt) | | Проверяет была ли установлена дата подтверждения до которой выбираются платежи | +| public | [hasCapturedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCapturedAtLte) | | Проверяет была ли установлена дата подтверждения до которой выбираются платежи | +| public | [hasCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCreatedAtGt) | | Проверяет была ли установлена дата создания от которой выбираются платежи | +| public | [hasCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCreatedAtGte) | | Проверяет была ли установлена дата создания от которой выбираются платежи | +| public | [hasCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCreatedAtLt) | | Проверяет была ли установлена дата создания до которой выбираются платежи | +| public | [hasCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCreatedAtLte) | | Проверяет была ли установлена дата создания до которой выбираются платежи | +| public | [hasCursor()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasCursor) | | Проверяет был ли установлена страница выдачи результатов, которую необходимо отобразить | +| public | [hasLimit()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasLimit) | | Проверяет был ли установлено ограничение количества объектов платежа | +| public | [hasPaymentMethod()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasPaymentMethod) | | Проверяет был ли установлен платежный метод выбираемых платежей | +| public | [hasStatus()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_hasStatus) | | Проверяет был ли установлен статус выбираемых платежей | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCapturedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtGt) | | Устанавливает дату подтверждения от которой выбираются платежи | +| public | [setCapturedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtGte) | | Устанавливает дату подтверждения от которой выбираются платежи | +| public | [setCapturedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtLt) | | Устанавливает дату подтверждения до которой выбираются платежи | +| public | [setCapturedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCapturedAtLte) | | Устанавливает дату подтверждения до которой выбираются платежи | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются платежи | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются платежи | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются платежи | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются платежи | +| public | [setCursor()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setCursor) | | Устанавливает cтраницw выдачи результатов, которую необходимо отобразить | +| public | [setLimit()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setLimit) | | Устанавливает ограничение количества объектов платежа | +| public | [setPaymentMethod()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setPaymentMethod) | | Устанавливает платежный метод выбираемых платежей | +| public | [setStatus()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_setStatus) | | Устанавливает статус выбираемых платежей | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Payments-PaymentsRequest.md#method_validate) | | Проверяет валидность текущего объекта запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Payments/PaymentsRequest.php](../../lib/Request/Payments/PaymentsRequest.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Request\Payments\PaymentsRequest +* Implements: + * [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +--- +## Constants + +###### MAX_LIMIT_VALUE +Максимальное количество объектов платежа в выборке + +```php +MAX_LIMIT_VALUE = 100 +``` + + +--- +## Properties + +#### public $capturedAtGt : \DateTime|null +--- +***Description*** + +Время подтверждения, от (не включая) + +**Type:** DateTime|null + +**Details:** + + + +#### public $capturedAtGte : \DateTime|null +--- +***Description*** + +Время подтверждения, от (включительно) + +**Type:** DateTime|null + +**Details:** + + + +#### public $capturedAtLt : \DateTime|null +--- +***Description*** + +Время подтверждения, до (не включая) + +**Type:** DateTime|null + +**Details:** + + + +#### public $capturedAtLte : \DateTime|null +--- +***Description*** + +Время подтверждения, до (включительно) + +**Type:** DateTime|null + +**Details:** + + + +#### public $createdAtGt : \DateTime|null +--- +***Description*** + +Время создания, от (не включая) + +**Type:** DateTime|null + +**Details:** + + + +#### public $createdAtGte : \DateTime|null +--- +***Description*** + +Время создания, от (включительно) + +**Type:** DateTime|null + +**Details:** + + + +#### public $createdAtLt : \DateTime|null +--- +***Description*** + +Время создания, до (не включая) + +**Type:** DateTime|null + +**Details:** + + + +#### public $createdAtLte : \DateTime|null +--- +***Description*** + +Время создания, до (включительно) + +**Type:** DateTime|null + +**Details:** + + + +#### public $cursor : string|null +--- +***Description*** + +Страница выдачи результатов, которую необходимо отобразить + +**Type:** string|null + +**Details:** + + + +#### public $limit : int|null +--- +***Description*** + +Ограничение количества объектов платежа, отображаемых на одной странице выдачи + +**Type:** int|null + +**Details:** + + + +#### public $paymentMethod : string|null +--- +***Description*** + +Платежный метод + +**Type:** string|null + +**Details:** + + + +#### public $status : string|null +--- +***Description*** + +Статус платежа + +**Type:** string|null + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Возвращает инстанс билдера объектов запросов списка платежей магазина + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Билдер объектов запросов списка платежей + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCapturedAtGt() : \DateTime|null + +```php +public getCapturedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату подтверждения от которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время подтверждения, от (не включая) + + + +#### public getCapturedAtGte() : \DateTime|null + +```php +public getCapturedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату подтверждения от которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время подтверждения, от (включительно) + + + +#### public getCapturedAtLt() : \DateTime|null + +```php +public getCapturedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату подтверждения до которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время подтверждения, до (не включая) + + + +#### public getCapturedAtLte() : \DateTime|null + +```php +public getCapturedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату подтверждения до которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время подтверждения, до (включительно) + + + +#### public getCreatedAtGt() : \DateTime|null + +```php +public getCreatedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время создания, от (не включая) + + + +#### public getCreatedAtGte() : \DateTime|null + +```php +public getCreatedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время создания, от (включительно) + + + +#### public getCreatedAtLt() : \DateTime|null + +```php +public getCreatedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время создания, до (не включая) + + + +#### public getCreatedAtLte() : \DateTime|null + +```php +public getCreatedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** \DateTime|null - Время создания, до (включительно) + + + +#### public getCursor() : string|null + +```php +public getCursor() : string|null +``` + +**Summary** + +Страница выдачи результатов, которую необходимо отобразить + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** string|null - + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getLimit() : int|null + +```php +public getLimit() : int|null +``` + +**Summary** + +Ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** int|null - Ограничение количества объектов платежа + + + +#### public getPaymentMethod() : string|null + +```php +public getPaymentMethod() : string|null +``` + +**Summary** + +Возвращает платежный метод выбираемых платежей или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** string|null - Платежный метод выбираемых платежей + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус выбираемых платежей или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** string|null - Статус выбираемых платежей + + + +#### public hasCapturedAtGt() : bool + +```php +public hasCapturedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата подтверждения от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCapturedAtGte() : bool + +```php +public hasCapturedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата подтверждения от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCapturedAtLt() : bool + +```php +public hasCapturedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата подтверждения до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCapturedAtLte() : bool + +```php +public hasCapturedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата подтверждения до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtGt() : bool + +```php +public hasCreatedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtGte() : bool + +```php +public hasCreatedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtLt() : bool + +```php +public hasCreatedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtLte() : bool + +```php +public hasCreatedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCursor() : bool + +```php +public hasCursor() : bool +``` + +**Summary** + +Проверяет был ли установлена страница выдачи результатов, которую необходимо отобразить + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если была установлена, false если нет + + + +#### public hasLimit() : bool + +```php +public hasLimit() : bool +``` + +**Summary** + +Проверяет был ли установлено ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если было установлено, false если нет + + + +#### public hasPaymentMethod() : bool + +```php +public hasPaymentMethod() : bool +``` + +**Summary** + +Проверяет был ли установлен платежный метод выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если платежный метод был установлен, false если нет + + + +#### public hasStatus() : bool + +```php +public hasStatus() : bool +``` + +**Summary** + +Проверяет был ли установлен статус выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если статус был установлен, false если нет + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCapturedAtGt() : mixed + +```php +public setCapturedAtGt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату подтверждения от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCapturedAtGte() : mixed + +```php +public setCapturedAtGte(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату подтверждения от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCapturedAtLt() : mixed + +```php +public setCapturedAtLt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату подтверждения до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCapturedAtLte() : mixed + +```php +public setCapturedAtLte(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату подтверждения до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtGt() : void + +```php +public setCreatedAtGt(\DateTime|string|int|null value) : void +``` + +**Summary** + +Устанавливает дату создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** void - + + + +#### public setCreatedAtGte() : void + +```php +public setCreatedAtGte(\DateTime|string|int|null value) : void +``` + +**Summary** + +Устанавливает дату создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** void - + + + +#### public setCreatedAtLt() : void + +```php +public setCreatedAtLt(\DateTime|string|int|null value) : void +``` + +**Summary** + +Устанавливает дату создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** void - + + + +#### public setCreatedAtLte() : void + +```php +public setCreatedAtLte(\DateTime|string|int|null value) : void +``` + +**Summary** + +Устанавливает дату создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** void - + + + +#### public setCursor() : void + +```php +public setCursor(string value) : void +``` + +**Summary** + +Устанавливает cтраницw выдачи результатов, которую необходимо отобразить + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Страница выдачи результатов или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** void - + + + +#### public setLimit() : void + +```php +public setLimit(int|null value) : void +``` + +**Summary** + +Устанавливает ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int OR null | value | Ограничение количества объектов платежа или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передано не целое число | + +**Returns:** void - + + + +#### public setPaymentMethod() : mixed + +```php +public setPaymentMethod(string value) : mixed +``` + +**Summary** + +Устанавливает платежный метод выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Платежный метод выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setStatus() : void + +```php +public setStatus(string value) : void +``` + +**Summary** + +Устанавливает статус выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** void - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет валидность текущего объекта запроса + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) + +**Returns:** bool - True если объект валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md new file mode 100644 index 00000000..db597ddd --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md @@ -0,0 +1,471 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\PaymentsRequestBuilder +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс билдера запросов к API для получения списка платежей магазина + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$currentObject](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [build()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_build) | | Собирает и возвращает объект запроса списка платежей магазина | +| public | [setCapturedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCapturedAtGt) | | Устанавливает дату подтверждения от которой выбираются платежи | +| public | [setCapturedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCapturedAtGte) | | Устанавливает дату подтверждения от которой выбираются платежи | +| public | [setCapturedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCapturedAtLt) | | Устанавливает дату подтверждения до которой выбираются платежи | +| public | [setCapturedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCapturedAtLte) | | Устанавливает дату подтверждения до которой выбираются платежи | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются платежи | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются платежи | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются платежи | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются платежи | +| public | [setCursor()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setCursor) | | Устанавливает страница выдачи результатов | +| public | [setLimit()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setLimit) | | Устанавливает ограничение количества объектов платежа | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPaymentMethod()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setPaymentMethod) | | Устанавливает платежный метод выбираемых платежей | +| public | [setStatus()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_setStatus) | | Устанавливает статус выбираемых платежей | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md#method_initCurrentObject) | | Возвращает новый объект запроса для получения списка платежей, который в дальнейшем будет собираться в билдере | +--- +### Details +* File: [lib/Request/Payments/PaymentsRequestBuilder.php](../../lib/Request/Payments/PaymentsRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Request\Payments\PaymentsRequestBuilder +--- +## Properties + +#### protected $currentObject : \YooKassa\Request\Payments\PaymentsRequest +--- +**Summary** + +Инстанс собираемого запроса + +**Type:** PaymentsRequest +Собираемый объект запроса списка платежей магазина +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public build() : \YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Common\AbstractRequest +``` + +**Summary** + +Собирает и возвращает объект запроса списка платежей магазина + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив с настройками запроса | + +**Returns:** \YooKassa\Common\AbstractRequest - Инстанс объекта запроса к API для получения списка платежей магазина + + + +#### public setCapturedAtGt() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCapturedAtGt(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату подтверждения от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCapturedAtGte() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCapturedAtGte(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату подтверждения от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCapturedAtLt() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCapturedAtLt(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату подтверждения до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCapturedAtLte() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCapturedAtLte(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату подтверждения до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время подтверждения, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCreatedAtGt() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCreatedAtGt(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCreatedAtGte() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCreatedAtGte(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCreatedAtLt() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCreatedAtLt(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCreatedAtLte() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCreatedAtLte(\DateTime|string|int|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setCursor() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setCursor(string|null value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает страница выдачи результатов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Страница выдачи результатов или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setLimit() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setLimit(string value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ограничение количества объектов платежа или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод было передана не целое число | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setPaymentMethod() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setPaymentMethod(string value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает платежный метод выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Платежный метод выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### public setStatus() : \YooKassa\Request\Payments\PaymentsRequestBuilder + +```php +public setStatus(string value) : \YooKassa\Request\Payments\PaymentsRequestBuilder +``` + +**Summary** + +Устанавливает статус выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Payments\PaymentsRequestBuilder - Инстанс текущего билдера + + + +#### protected initCurrentObject() : \YooKassa\Request\Payments\PaymentsRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Payments\PaymentsRequest +``` + +**Summary** + +Возвращает новый объект запроса для получения списка платежей, который в дальнейшем будет собираться в билдере + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) + +**Returns:** \YooKassa\Request\Payments\PaymentsRequest - Объект запроса списка платежей магазина + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md new file mode 100644 index 00000000..e112311a --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequestInterface.md @@ -0,0 +1,465 @@ +# [YooKassa API SDK](../home.md) + +# Interface: PaymentsRequestInterface +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Interface PaymentsRequestInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getCreatedAtGt) | | Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getCreatedAtGte) | | Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getCreatedAtLt) | | Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена | +| public | [getCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getCreatedAtLte) | | Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена | +| public | [getCursor()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getCursor) | | Возвращает страницу выдачи результатов или null если она до этого не была установлена | +| public | [getLimit()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getLimit) | | Возвращает ограничение количества объектов платежа или null если оно до этого не было установлено | +| public | [getStatus()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_getStatus) | | Возвращает статус выбираемых платежей или null если он до этого не был установлен | +| public | [hasCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasCreatedAtGt) | | Проверяет была ли установлена дата создания от которой выбираются платежи | +| public | [hasCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasCreatedAtGte) | | Проверяет была ли установлена дата создания от которой выбираются платежи | +| public | [hasCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasCreatedAtLt) | | Проверяет была ли установлена дата создания до которой выбираются платежи | +| public | [hasCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasCreatedAtLte) | | Проверяет была ли установлена дата создания до которой выбираются платежи | +| public | [hasCursor()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasCursor) | | Проверяет была ли установлена страница выдачи результатов | +| public | [hasLimit()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasLimit) | | Проверяет было ли установлено ограничение количества объектов платежа | +| public | [hasStatus()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_hasStatus) | | Проверяет был ли установлен статус выбираемых платежей | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются платежи | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются платежи | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются платежи | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются платежи | +| public | [setCursor()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setCursor) | | Устанавливает страницу выдачи результатов | +| public | [setLimit()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setLimit) | | Устанавливает ограничение количества объектов платежа | +| public | [setStatus()](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md#method_setStatus) | | Устанавливает статус выбираемых платежей | + +--- +### Details +* File: [lib/Request/Payments/PaymentsRequestInterface.php](../../lib/Request/Payments/PaymentsRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Страница выдачи результатов, которую необходимо отобразить | +| property-read | | Время создания, от (включительно) | +| property-read | | Время создания, от (не включая) | +| property-read | | Время создания, до (включительно) | +| property-read | | Время создания, до (не включая) | +| property-read | | Время подтверждения, от (включительно) | +| property-read | | Время подтверждения, от (не включая) | +| property-read | | Время подтверждения, до (включительно) | +| property-read | | Время подтверждения, до (не включая) | +| property-read | | Ограничение количества объектов платежа, отображаемых на одной странице выдачи | +| property-read | | Идентификатор шлюза. | +| property-read | | Статус платежа | +--- +## Methods + +#### public getCursor() : string|null + +```php +public getCursor() : string|null +``` + +**Summary** + +Возвращает страницу выдачи результатов или null если она до этого не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** string|null - Страница выдачи результатов + + + +#### public hasCursor() : bool + +```php +public hasCursor() : bool +``` + +**Summary** + +Проверяет была ли установлена страница выдачи результатов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если страница выдачи результатов была установлена, false если нет + + + +#### public setCursor() : void + +```php +public setCursor(string value) : void +``` + +**Summary** + +Устанавливает страницу выдачи результатов + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Страница | + +**Returns:** void - + + + +#### public getCreatedAtGte() : \DateTime|null + +```php +public getCreatedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, от (включительно) + + + +#### public hasCreatedAtGte() : bool + +```php +public hasCreatedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public setCreatedAtGte() : void + +```php +public setCreatedAtGte(\DateTime value) : void +``` + +**Summary** + +Устанавливает дату создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Дата | + +**Returns:** void - + + + +#### public getCreatedAtGt() : \DateTime|null + +```php +public getCreatedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, от (не включая) + + + +#### public hasCreatedAtGt() : bool + +```php +public hasCreatedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public setCreatedAtGt() : void + +```php +public setCreatedAtGt(\DateTime value) : void +``` + +**Summary** + +Устанавливает дату создания от которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Дата | + +**Returns:** void - + + + +#### public getCreatedAtLte() : \DateTime|null + +```php +public getCreatedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, до (включительно) + + + +#### public hasCreatedAtLte() : bool + +```php +public hasCreatedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public setCreatedAtLte() : void + +```php +public setCreatedAtLte(\DateTime value) : void +``` + +**Summary** + +Устанавливает дату создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Дата | + +**Returns:** void - + + + +#### public getCreatedAtLt() : \DateTime|null + +```php +public getCreatedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены платежи или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, до (не включая) + + + +#### public hasCreatedAtLt() : bool + +```php +public hasCreatedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public setCreatedAtLt() : void + +```php +public setCreatedAtLt(\DateTime value) : void +``` + +**Summary** + +Устанавливает дату создания до которой выбираются платежи + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Дата | + +**Returns:** void - + + + +#### public getLimit() : string|null + +```php +public getLimit() : string|null +``` + +**Summary** + +Возвращает ограничение количества объектов платежа или null если оно до этого не было установлено + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** string|null - Ограничение количества объектов платежа + + + +#### public hasLimit() : bool + +```php +public hasLimit() : bool +``` + +**Summary** + +Проверяет было ли установлено ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если ограничение количества объектов платежа было установлено, false если нет + + + +#### public setLimit() : void + +```php +public setLimit(int value) : void +``` + +**Summary** + +Устанавливает ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Количества объектов платежа на странице | + +**Returns:** void - + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус выбираемых платежей или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** string|null - Статус выбираемых платежей + + + +#### public hasStatus() : bool + +```php +public hasStatus() : bool +``` + +**Summary** + +Проверяет был ли установлен статус выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) + +**Returns:** bool - True если статус был установлен, false если нет + + + +#### public setStatus() : void + +```php +public setStatus(string value) : void +``` + +**Summary** + +Устанавливает статус выбираемых платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус платежей | + +**Returns:** void - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md b/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md new file mode 100644 index 00000000..de793aa2 --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\PaymentsRequestSerializer +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс сериализатора объектов запросов к API для получения списка платежей + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md#method_serialize) | | Сериализует объект запроса к API для дальнейшей его отправки | +--- +### Details +* File: [lib/Request/Payments/PaymentsRequestSerializer.php](../../lib/Request/Payments/PaymentsRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Payments\PaymentsRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Payments\PaymentsRequestInterface request) : array +``` + +**Summary** + +Сериализует объект запроса к API для дальнейшей его отправки + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsRequestSerializer](../classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Payments\PaymentsRequestInterface | request | Сериализуемый объект | + +**Returns:** array - Массив с инфомрацией, отпарвляемый в дальнейшем в API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md b/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md new file mode 100644 index 00000000..6598dc4c --- /dev/null +++ b/docs/classes/YooKassa-Request-Payments-PaymentsResponse.md @@ -0,0 +1,380 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Payments\PaymentsResponse +### Namespace: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +--- +**Summary:** + +Класс объекта ответа от API со списком платежей магазина + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_fromArray) | | Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива | +| public | [getItems()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_getItems) | | Возвращает список платежей | +| public | [getNextCursor()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_getNextCursor) | | Возвращает токен следующей страницы, если он задан, или null | +| public | [hasNextCursor()](../classes/YooKassa-Request-Payments-PaymentsResponse.md#method_hasNextCursor) | | Проверяет имееотся ли в ответе токен следующей страницы | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Payments/PaymentsResponse.php](../../lib/Request/Payments/PaymentsResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Payments\PaymentsResponse + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array sourceArray) : mixed +``` + +**Summary** + +Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsResponse](../classes/YooKassa-Request-Payments-PaymentsResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | sourceArray | Массив настроек, пришедший от API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public getItems() : \YooKassa\Model\PaymentInterface[] + +```php +public getItems() : \YooKassa\Model\PaymentInterface[] +``` + +**Summary** + +Возвращает список платежей + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsResponse](../classes/YooKassa-Request-Payments-PaymentsResponse.md) + +**Returns:** \YooKassa\Model\PaymentInterface[] - Список платежей + + + +#### public getNextCursor() : string|null + +```php +public getNextCursor() : string|null +``` + +**Summary** + +Возвращает токен следующей страницы, если он задан, или null + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsResponse](../classes/YooKassa-Request-Payments-PaymentsResponse.md) + +**Returns:** string|null - Токен следующей страницы + + + +#### public hasNextCursor() : bool + +```php +public hasNextCursor() : bool +``` + +**Summary** + +Проверяет имееотся ли в ответе токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Payments\PaymentsResponse](../classes/YooKassa-Request-Payments-PaymentsResponse.md) + +**Returns:** bool - True если токен следующей страницы есть, false если нет + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md new file mode 100644 index 00000000..2d67a6e3 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md @@ -0,0 +1,1283 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Request\Receipts\AbstractReceiptResponse +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Class AbstractReceipt + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [LENGTH_RECEIPT_ID](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#constant_LENGTH_RECEIPT_ID) | | Длина идентификатора чека | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$fiscal_attribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_attribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscal_document_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_document_number) | | Номер фискального документа. | +| public | [$fiscal_provider_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_provider_id) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscal_storage_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_storage_number) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$fiscalAttribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalAttribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscalDocumentNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalDocumentNumber) | | Номер фискального документа. | +| public | [$fiscalProviderId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalProviderId) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscalStorageNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalStorageNumber) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_id) | | Идентификатор чека в ЮKassa. | +| public | [$items](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_items) | | Список товаров в заказе | +| public | [$object_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_object_id) | | Идентификатор объекта чека. | +| public | [$objectId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_objectId) | | Идентификатор объекта чека. | +| public | [$on_behalf_of](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_on_behalf_of) | | Идентификатор магазина | +| public | [$onBehalfOf](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_onBehalfOf) | | Идентификатор магазина | +| public | [$registered_at](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registered_at) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$registeredAt](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registeredAt) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$settlements](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_settlements) | | Перечень совершенных расчетов. | +| public | [$status](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_status) | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| public | [$tax_system_code](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_tax_system_code) | | Код системы налогообложения. Число 1-6. | +| public | [$taxSystemCode](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_taxSystemCode) | | Код системы налогообложения. Число 1-6. | +| public | [$type](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_type) | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method___construct) | | AbstractReceiptResponse constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addItem()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addItem) | | Добавляет товар в чек | +| public | [addSettlement()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addSettlement) | | Добавляет оплату в массив | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalAttribute) | | Возвращает фискальный признак чека | +| public | [getFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalDocumentNumber) | | Возвращает номер фискального документа | +| public | [getFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalProviderId) | | Возвращает идентификатор чека в онлайн-кассе | +| public | [getFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalStorageNumber) | | Возвращает номер фискального накопителя в кассовом аппарате | +| public | [getId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getId) | | Возвращает идентификатор чека в ЮKassa | +| public | [getItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getItems) | | Возвращает список товаров в заказ | +| public | [getObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getObjectId) | | Возвращает идентификатор платежа или возврата, для которого был сформирован чек. | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getOnBehalfOf) | | Возвращает идентификатор магазин | +| public | [getRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getRegisteredAt) | | Возвращает дату и время формирования чека в фискальном накопителе | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getSettlements) | | Возвращает Массив оплат, обеспечивающих выдачу товара | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | +| public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | +| public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | +| public | [setFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalStorageNumber) | | Устанавливает номер фискального накопителя в кассовом аппарате | +| public | [setId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setId) | | Устанавливает идентификатор чека | +| public | [setItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setItems) | | Устанавливает список позиций в чеке | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setObjectId) | | Устанавливает идентификатор платежа или возврата, для которого был сформирован чек | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек | +| public | [setRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setRegisteredAt) | | Устанавливает дату и время формирования чека в фискальном накопителе | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара | +| public | [setSpecificProperties()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setSpecificProperties) | | Установка свойств, присущих конкретному объекту | +| public | [setStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setStatus) | | Устанавливает состояние регистрации фискального чека | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setType) | | Устанавливает типа чека | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Receipts/AbstractReceiptResponse.php](../../lib/Request/Receipts/AbstractReceiptResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Receipts\AbstractReceiptResponse +* Implements: + * [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) +--- +## Constants + +###### LENGTH_RECEIPT_ID +Длина идентификатора чека + +```php +LENGTH_RECEIPT_ID = 39 +``` + + +--- +## Properties + +#### public $fiscal_attribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** + + + +#### public $fiscal_document_number : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** + + + +#### public $fiscal_provider_id : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** + + + +#### public $fiscal_storage_number : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** + + + +#### public $fiscalAttribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** + + + +#### public $fiscalDocumentNumber : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** + + + +#### public $fiscalProviderId : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** + + + +#### public $fiscalStorageNumber : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** + + + +#### public $id : string +--- +***Description*** + +Идентификатор чека в ЮKassa. + +**Type:** string + +**Details:** + + + +#### public $items : \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +--- +***Description*** + +Список товаров в заказе + +**Type:** ReceiptResponseItemInterface[] + +**Details:** + + + +#### public $object_id : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** + + + +#### public $objectId : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** + + + +#### public $on_behalf_of : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** + + + +#### public $onBehalfOf : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** + + + +#### public $registered_at : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** + + + +#### public $registeredAt : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** + + + +#### public $settlements : \YooKassa\Model\SettlementInterface[] +--- +***Description*** + +Перечень совершенных расчетов. + +**Type:** SettlementInterface[] + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). + +**Type:** string + +**Details:** + + + +#### public $tax_system_code : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** + + + +#### public $taxSystemCode : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** + + + +#### public $type : string +--- +***Description*** + +Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(mixed receiptData) : mixed +``` + +**Summary** + +AbstractReceiptResponse constructor. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | receiptData | | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addItem() : mixed + +```php +public addItem(\YooKassa\Request\Receipts\ReceiptResponseItemInterface value) : mixed +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface | value | Объект добавляемой в чек позиции | + +**Returns:** mixed - + + + +#### public addSettlement() : mixed + +```php +public addSettlement(\YooKassa\Model\SettlementInterface value) : mixed +``` + +**Summary** + +Добавляет оплату в массив + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface | value | | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getFiscalAttribute() : string + +```php +public getFiscalAttribute() : string +``` + +**Summary** + +Возвращает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Фискальный признак чека + + + +#### public getFiscalDocumentNumber() : string + +```php +public getFiscalDocumentNumber() : string +``` + +**Summary** + +Возвращает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального документа + + + +#### public getFiscalProviderId() : string + +```php +public getFiscalProviderId() : string +``` + +**Summary** + +Возвращает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Идентификатор чека в онлайн-кассе + + + +#### public getFiscalStorageNumber() : string + +```php +public getFiscalStorageNumber() : string +``` + +**Summary** + +Возвращает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального накопителя в кассовом аппарате + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор чека в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] + +```php +public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +``` + +**Summary** + +Возвращает список товаров в заказ + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает идентификатор платежа или возврата, для которого был сформирован чек. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + + + +#### public getOnBehalfOf() : string|null + +```php +public getOnBehalfOf() : string|null +``` + +**Summary** + +Возвращает идентификатор магазин + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getRegisteredAt() : \DateTime + +```php +public getRegisteredAt() : \DateTime +``` + +**Summary** + +Возвращает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \DateTime - Дата и время формирования чека в фискальном накопителе + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает Массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус доставки данных для чека в онлайн-кассу + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** int - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setFiscalAttribute() : mixed + +```php +public setFiscalAttribute(string fiscal_attribute) : mixed +``` + +**Summary** + +Устанавливает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_attribute | Фискальный признак чека | + +**Returns:** mixed - + + + +#### public setFiscalDocumentNumber() : mixed + +```php +public setFiscalDocumentNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер фискального документа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setFiscalProviderId() : mixed + +```php +public setFiscalProviderId(string fiscal_provider_id) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_provider_id | Идентификатор чека в онлайн-кассе | + +**Returns:** mixed - + + + +#### public setFiscalStorageNumber() : mixed + +```php +public setFiscalStorageNumber(string fiscal_storage_number) : mixed +``` + +**Summary** + +Устанавливает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_storage_number | Номер фискального накопителя в кассовом аппарате | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 40 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setItems() : mixed + +```php +public setItems(\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список позиций в чеке + +**Description** + +Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком +позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс +ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] | value | Список товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передали пустой массив значений | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения был передан не массив и не итератор, лабо если одно из переданных значений не реализует интерфейс ReceiptItemInterface | + +**Returns:** mixed - + + + +#### public setObjectId() : mixed + +```php +public setObjectId( value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа или возврата, для которого был сформирован чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public setOnBehalfOf() : mixed + +```php +public setOnBehalfOf(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор магазина, от имени которого нужно отправить чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина, от имени которого нужно отправить чек | + +**Returns:** mixed - + + + +#### public setRegisteredAt() : mixed + +```php +public setRegisteredAt(\DateTime registered_at) : mixed +``` + +**Summary** + +Устанавливает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | registered_at | Дата и время формирования чека в фискальном накопителе | + +**Returns:** mixed - + + + +#### public setSettlements() : mixed + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] | value | | + +**Returns:** mixed - + + + +#### public setSpecificProperties() : void + +```php +Abstract public setSpecificProperties(array receiptData) : void +``` + +**Summary** + +Установка свойств, присущих конкретному объекту + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | receiptData | | + +**Returns:** void - + + + +#### public setStatus() : \YooKassa\Request\Receipts\AbstractReceiptResponse + +```php +public setStatus(string value) : \YooKassa\Request\Receipts\AbstractReceiptResponse +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse - + + + +#### public setTaxSystemCode() : mixed + +```php +public setTaxSystemCode(int value) : mixed +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданный аргумент меньше одного или больше шести | + +**Returns:** mixed - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает типа чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным типом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md new file mode 100644 index 00000000..12383d34 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md @@ -0,0 +1,908 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\CreatePostReceiptRequest +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс объекта запроса к API на создание чека + +--- +### Examples +Пример использования билдера + +```php +try { + $receiptBuilder = \YooKassa\Request\Receipts\CreatePostReceiptRequest::builder(); + $receiptBuilder->setType(\YooKassa\Model\ReceiptType::PAYMENT) + ->setObjectId('24b94598-000f-5000-9000-1b68e7b15f3f') + ->setCustomer(array( + 'email' => 'john.doe@merchant.com', + 'phone' => '71111111111', + )) + ->setItems(array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ), + )) + ->setSettlements(array( + array( + 'type' => 'prepayment', + 'amount' => array( + 'value' => 100.00, + 'currency' => 'RUB', + ), + ), + )) + ->setSend(true); + + // Создаем объект запроса + $request = $receiptBuilder->build(); + + // Можно изменить данные, если нужно + $request->setOnBehalfOf('159753'); + $request->addItem(new \YooKassa\Model\ReceiptItem(array( + 'description' => 'Платок Gucci Новый', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3500.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ))); + + $idempotenceKey = uniqid('', true); + $response = $client->createReceipt($request, $idempotenceKey); +} catch (Exception $e) { + $response = $e; +} + +var_dump($response); + +``` +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addItem()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_addItem) | | Добавляет товар в чек | +| public | [addSettlement()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_addSettlement) | | Добавляет оплату в перечень совершенных расчетов. | +| public | [builder()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_builder) | | Возвращает билдер объектов запросов создания платежа | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getCustomer) | | Возвращает информацию о плательщике | +| public | [getItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getItems) | | Возвращает список позиций в текущем чеке | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getObjectId) | | Возвращает Id объекта чека | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек. | +| public | [getSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getSend) | | Возвращает признак отложенной отправки чека. | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getSettlements) | | Возвращает массив оплат, обеспечивающих выдачу товара. | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [hasCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_hasCustomer) | | Проверяет наличие данных о плательщике | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция товаров и оплат | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setCustomer) | | Устанавливает информацию о плательщике | +| public | [setItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setItems) | | Устанавливает список позиций в чеке | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setObjectId) | | Устанавливает Id объекта чека | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setOnBehalfOf) | | Устанавливает идентификатор магазина, от имени которого нужно отправить чек. | +| public | [setSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setSend) | | Устанавливает признак отложенной отправки чека. | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара. | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_setType) | | Устанавливает тип чека в онлайн-кассе | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md#method_validate) | | Валидирует текущий запрос, проверяет все ли нужные свойства установлены | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Receipts/CreatePostReceiptRequest.php](../../lib/Request/Receipts/CreatePostReceiptRequest.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Request\Receipts\CreatePostReceiptRequest +* Implements: + * [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addItem() : \YooKassa\Request\Receipts\CreatePostReceiptRequest + +```php +public addItem(\YooKassa\Model\ReceiptItemInterface|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface OR array | value | Объект добавляемой в чек позиции | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - + + + +#### public addSettlement() : mixed + +```php +public addSettlement(\YooKassa\Model\SettlementInterface value) : mixed +``` + +**Summary** + +Добавляет оплату в перечень совершенных расчетов. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface | value | Информация о совершенных расчетах. | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Возвращает билдер объектов запросов создания платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - Инстанс билдера объектов запрсов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface + +```php +public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface +``` + +**Summary** + +Возвращает информацию о плательщике + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** \YooKassa\Model\ReceiptCustomerInterface - информация о плательщике + + + +#### public getItems() : \YooKassa\Model\ReceiptItemInterface[] + +```php +public getItems() : \YooKassa\Model\ReceiptItemInterface[] +``` + +**Summary** + +Возвращает список позиций в текущем чеке + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** \YooKassa\Model\ReceiptItemInterface[] - Список товаров в заказе + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает Id объекта чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** string - Id объекта чека + + + +#### public getOnBehalfOf() : string + +```php +public getOnBehalfOf() : string +``` + +**Summary** + +Возвращает идентификатор магазина, от имени которого нужно отправить чек. + +**Description** + +Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). +Необходимо передавать, если вы используете решение ЮKassa для платформ. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** string - + + + +#### public getSend() : bool + +```php +public getSend() : bool +``` + +**Summary** + +Возвращает признак отложенной отправки чека. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** bool - Признак отложенной отправки чека. + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает массив оплат, обеспечивающих выдачу товара. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - Массив оплат, обеспечивающих выдачу товара. + + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** int - Код системы налогообложения. Число 1-6. + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** string - Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + + + +#### public hasCustomer() : bool + +```php +public hasCustomer() : bool +``` + +**Summary** + +Проверяет наличие данных о плательщике + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** bool - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция товаров и оплат + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCustomer() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setCustomer(\YooKassa\Model\ReceiptCustomerInterface value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает информацию о плательщике + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptCustomerInterface | value | | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public setItems() : \YooKassa\Request\Receipts\CreatePostReceiptRequest + +```php +public setItems(\YooKassa\Model\ReceiptItemInterface[]|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequest +``` + +**Summary** + +Устанавливает список позиций в чеке + +**Description** + +Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком +позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс +ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface[] OR array | value | Список товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передали пустой массив значений | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения был передан не массив и не итератор, либо если одно из переданных значений не реализует интерфейс ReceiptItemInterface | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - + + + +#### public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setObjectId(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает Id объекта чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Id объекта чека | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public setOnBehalfOf() : mixed + +```php +public setOnBehalfOf(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор магазина, от имени которого нужно отправить чек. + +**Description** + +Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). +Необходимо передавать, если вы используете решение ЮKassa для платформ. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | | + +**Returns:** mixed - + + + +#### public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setSend(bool value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает признак отложенной отправки чека. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак отложенной отправки чека. | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[] value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] | value | Массив оплат, обеспечивающих выдачу товара. | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public setTaxSystemCode() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setTaxSystemCode(int value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданный аргумент меньше одного или больше шести | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setType(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Валидирует текущий запрос, проверяет все ли нужные свойства установлены + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) + +**Returns:** bool - True если запрос валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md new file mode 100644 index 00000000..35772b28 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md @@ -0,0 +1,489 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс билдера объектов запрсов к API на создание чека + +--- +### Examples +Пример использования билдера + +```php +try { + $receiptBuilder = \YooKassa\Request\Receipts\CreatePostReceiptRequest::builder(); + $receiptBuilder->setType(\YooKassa\Model\ReceiptType::PAYMENT) + ->setObjectId('24b94598-000f-5000-9000-1b68e7b15f3f') + ->setCustomer(array( + 'email' => 'john.doe@merchant.com', + 'phone' => '71111111111', + )) + ->setItems(array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ), + )) + ->setSettlements(array( + array( + 'type' => 'prepayment', + 'amount' => array( + 'value' => 100.00, + 'currency' => 'RUB', + ), + ), + )) + ->setSend(true); + + // Создаем объект запроса + $request = $receiptBuilder->build(); + + // Можно изменить данные, если нужно + $request->setOnBehalfOf('159753'); + $request->addItem(new \YooKassa\Model\ReceiptItem(array( + 'description' => 'Платок Gucci Новый', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3500.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ))); + + $idempotenceKey = uniqid('', true); + $response = $client->createReceipt($request, $idempotenceKey); +} catch (Exception $e) { + $response = $e; +} + +var_dump($response); + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$amount](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#property_amount) | | Сумма чека | +| protected | [$currentObject](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#property_currentObject) | | Собираемый объект запроса | +| protected | [$customer](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#property_customer) | | Информация о плательщике | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [addItem()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_addItem) | | Добавляет товар в чек | +| public | [build()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_build) | | Строит и возвращает объект запроса для отправки в API ЮKassa | +| public | [setAmount()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setAmount) | | Устанавливает сумму | +| public | [setCurrency()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа | +| public | [setCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setCustomer) | | Устанавливает информацию о пользователе | +| public | [setItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setItems) | | Устанавливает список товаров чека | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setObjectId) | | Устанавливает Id объекта чека | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setOnBehalfOf) | | Устанавливает идентификатор магазина, от имени которого нужно отправить чек. | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setSend) | | Устанавливает признак отложенной отправки чека. | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара. | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_setType) | | Устанавливает тип чека в онлайн-кассе | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md#method_initCurrentObject) | | Инициализирует объект запроса, который в дальнейшем будет собираться билдером | +--- +### Details +* File: [lib/Request/Receipts/CreatePostReceiptRequestBuilder.php](../../lib/Request/Receipts/CreatePostReceiptRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +--- +## Properties + +#### protected $amount : \YooKassa\Model\AmountInterface +--- +**Summary** + +Сумма чека + +**Type:** AmountInterface + +**Details:** + + + +#### protected $currentObject : \YooKassa\Request\Receipts\CreatePostReceiptRequest +--- +**Summary** + +Собираемый объект запроса + +**Type:** CreatePostReceiptRequest + +**Details:** + + + +#### protected $customer : \YooKassa\Model\ReceiptCustomer +--- +**Summary** + +Информация о плательщике + +**Type:** ReceiptCustomer + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public addItem() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public addItem(\YooKassa\Model\ReceiptItemInterface|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface OR array | value | Информация о товаре | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public build() : \YooKassa\Request\Receipts\CreatePostReceiptRequest|\YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Request\Receipts\CreatePostReceiptRequest|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит и возвращает объект запроса для отправки в API ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив параметров для установки в объект запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidRequestException | Выбрасывается если собрать объект запроса не удалось | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса + + + +#### public setAmount() : self + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|string value) : self +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR string | value | Сумма оплаты | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setCurrency() : self + +```php +public setCurrency(string value) : self +``` + +**Summary** + +Устанавливает валюту в которой будет происходить подтверждение оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Валюта в которой подтверждается оплата | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setCustomer() : self + +```php +public setCustomer(\YooKassa\Model\ReceiptCustomerInterface|array value) : self +``` + +**Summary** + +Устанавливает информацию о пользователе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptCustomerInterface OR array | value | информация о плательщике | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setItems() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setItems(\YooKassa\Model\ReceiptItemInterface[]|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает список товаров чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface[] OR array | value | список товаров чека | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setObjectId(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает Id объекта чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Id объекта чека | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public setOnBehalfOf() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setOnBehalfOf(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор магазина, от имени которого нужно отправить чек. + +**Description** + +Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). +Необходимо передавать, если вы используете решение ЮKassa для платформ. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина, от имени которого нужно отправить чек | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setSend(bool value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает признак отложенной отправки чека. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак отложенной отправки чека. | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[]|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] OR array | value | Массив оплат, обеспечивающих выдачу товара | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public setTaxSystemCode() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setTaxSystemCode(int value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6. | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder + +```php +public setType(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder +``` + +**Summary** + +Устанавливает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder - + + + +#### protected initCurrentObject() : \YooKassa\Request\Receipts\CreatePostReceiptRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Receipts\CreatePostReceiptRequest +``` + +**Summary** + +Инициализирует объект запроса, который в дальнейшем будет собираться билдером + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequest - Инстанс собираемого объекта запроса к API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md new file mode 100644 index 00000000..9bcce238 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md @@ -0,0 +1,438 @@ +# [YooKassa API SDK](../home.md) + +# Interface: CreatePostReceiptRequestInterface +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Interface CreateReceiptRequestInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [addItem()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_addItem) | | Добавляет товар в чек | +| public | [getCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getCustomer) | | Возвращает информацию о плательщике. | +| public | [getItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getItems) | | Возвращает список товаров в заказе | +| public | [getObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getObjectId) | | Возвращает идентификатор объекта, для которого формируется чек | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек | +| public | [getSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getSend) | | Возвращает признак отложенной отправки чека | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getSettlements) | | Возвращает Массив оплат, обеспечивающих выдачу товара | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | +| public | [setCustomer()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setCustomer) | | Устанавливает информацию о пользователе | +| public | [setItems()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setItems) | | Устанавливает список товаров чека | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setObjectId) | | Устанавливает идентификатор объекта, для которого формируется чек | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setOnBehalfOf) | | Устанавливает идентификатор магазина, от имени которого нужно отправить чек. | +| public | [setSend()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setSend) | | Устанавливает признак отложенной отправки чека | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md#method_setType) | | Устанавливает тип чека в онлайн-кассе | + +--- +### Details +* File: [lib/Request/Receipts/CreatePostReceiptRequestInterface.php](../../lib/Request/Receipts/CreatePostReceiptRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property | | Идентификатор объекта ("payment" или "refund), для которого формируется чек | +| property | | Идентификатор объекта ("payment" или "refund), для которого формируется чек | +| property | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund" | +| property | | Признак отложенной отправки чека | +| property | | Информация о плательщике | +| property | | Код системы налогообложения. Число 1-6 | +| property | | Код системы налогообложения. Число 1-6 | +| property | | Список товаров в заказе | +| property | | Информация о поставщике товара или услуги | +| property | | Массив оплат, обеспечивающих выдачу товара | +--- +## Methods + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает идентификатор объекта, для которого формируется чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** string - Идентификатор объекта + + + +#### public setObjectId() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setObjectId(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает идентификатор объекта, для которого формируется чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор объекта | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** string - Тип чека в онлайн-кассе: приход "payment" или возврат "refund" + + + +#### public setType() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setType(string value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека в онлайн-кассе: приход "payment" или возврат "refund" | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getSend() : mixed + +```php +public getSend() : mixed +``` + +**Summary** + +Возвращает признак отложенной отправки чека + +**Description** + + @return bool Признак отложенной отправки чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** mixed - + + + +#### public setSend() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setSend(bool value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает признак отложенной отправки чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| bool | value | Признак отложенной отправки чека | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getTaxSystemCode() : mixed + +```php +public getTaxSystemCode() : mixed +``` + +**Summary** + +Возвращает код системы налогообложения + +**Description** + + @return int Код системы налогообложения. Число 1-6 + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** mixed - + + + +#### public setTaxSystemCode() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setTaxSystemCode(int value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface + +```php +public getCustomer() : \YooKassa\Model\ReceiptCustomerInterface +``` + +**Summary** + +Возвращает информацию о плательщике. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** \YooKassa\Model\ReceiptCustomerInterface - Информация о плательщике + + + +#### public setCustomer() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setCustomer(\YooKassa\Model\ReceiptCustomerInterface value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает информацию о пользователе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptCustomerInterface | value | информация о плательщике | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getItems() : mixed + +```php +public getItems() : mixed +``` + +**Summary** + +Возвращает список товаров в заказе + +**Description** + + @return ReceiptItemInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** mixed - + + + +#### public setItems() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setItems(\YooKassa\Model\ReceiptItemInterface[]|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает список товаров чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface[] OR array | value | список товаров чека | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public addItem() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public addItem(\YooKassa\Model\ReceiptItemInterface|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptItemInterface OR array | value | Информация о товаре | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getSettlements() : mixed + +```php +public getSettlements() : mixed +``` + +**Summary** + +Возвращает Массив оплат, обеспечивающих выдачу товара + +**Description** + + @return SettlementInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** mixed - + + + +#### public setSettlements() : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[]|array value) : \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] OR array | value | Массив оплат, обеспечивающих выдачу товара | + +**Returns:** \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface - + + + +#### public getOnBehalfOf() : string|null + +```php +public getOnBehalfOf() : string|null +``` + +**Summary** + +Возвращает идентификатор магазина, от имени которого нужно отправить чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** string|null - Идентификатор магазина, от имени которого нужно отправить чек + + + +#### public setOnBehalfOf() : mixed + +```php +public setOnBehalfOf(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор магазина, от имени которого нужно отправить чек. + +**Description** + +Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). +Необходимо передавать, если вы используете решение ЮKassa для платформ. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина, от имени которого нужно отправить чек | + +**Returns:** mixed - + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md new file mode 100644 index 00000000..5fe22350 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\CreatePostReceiptRequestSerializer +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс сериалайзера объекта запроса к API создание чека + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md#method_serialize) | | Сериализует объект запроса к API для дальнейшей его отправки | +--- +### Details +* File: [lib/Request/Receipts/CreatePostReceiptRequestSerializer.php](../../lib/Request/Receipts/CreatePostReceiptRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Receipts\CreatePostReceiptRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface request) : array +``` + +**Summary** + +Сериализует объект запроса к API для дальнейшей его отправки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\CreatePostReceiptRequestSerializer](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\CreatePostReceiptRequestInterface | request | Сериализуемый объект | + +**Returns:** array - Массив с информацией, отправляемый в дальнейшем в API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md new file mode 100644 index 00000000..860e232f --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md @@ -0,0 +1,1382 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\PaymentReceiptResponse +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс описывающий чек, привязанный к платежу + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [LENGTH_RECEIPT_ID](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#constant_LENGTH_RECEIPT_ID) | | Длина идентификатора чека | +| public | [LENGTH_PAYMENT_ID](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md#constant_LENGTH_PAYMENT_ID) | | Длина идентификатора платежа | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$fiscal_attribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_attribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscal_document_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_document_number) | | Номер фискального документа. | +| public | [$fiscal_provider_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_provider_id) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscal_storage_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_storage_number) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$fiscalAttribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalAttribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscalDocumentNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalDocumentNumber) | | Номер фискального документа. | +| public | [$fiscalProviderId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalProviderId) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscalStorageNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalStorageNumber) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_id) | | Идентификатор чека в ЮKassa. | +| public | [$items](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_items) | | Список товаров в заказе | +| public | [$object_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_object_id) | | Идентификатор объекта чека. | +| public | [$objectId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_objectId) | | Идентификатор объекта чека. | +| public | [$on_behalf_of](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_on_behalf_of) | | Идентификатор магазина | +| public | [$onBehalfOf](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_onBehalfOf) | | Идентификатор магазина | +| public | [$payment_id](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md#property_payment_id) | | Идентификатор платежа в ЮKassa | +| public | [$paymentId](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md#property_paymentId) | | Идентификатор платежа в ЮKassa | +| public | [$registered_at](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registered_at) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$registeredAt](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registeredAt) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$settlements](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_settlements) | | Перечень совершенных расчетов. | +| public | [$status](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_status) | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| public | [$tax_system_code](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_tax_system_code) | | Код системы налогообложения. Число 1-6. | +| public | [$taxSystemCode](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_taxSystemCode) | | Код системы налогообложения. Число 1-6. | +| public | [$type](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_type) | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addItem()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addItem) | | Добавляет товар в чек | +| public | [addSettlement()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addSettlement) | | Добавляет оплату в массив | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalAttribute) | | Возвращает фискальный признак чека | +| public | [getFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalDocumentNumber) | | Возвращает номер фискального документа | +| public | [getFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalProviderId) | | Возвращает идентификатор чека в онлайн-кассе | +| public | [getFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalStorageNumber) | | Возвращает номер фискального накопителя в кассовом аппарате | +| public | [getId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getId) | | Возвращает идентификатор чека в ЮKassa | +| public | [getItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getItems) | | Возвращает список товаров в заказ | +| public | [getObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getObjectId) | | Возвращает идентификатор платежа или возврата, для которого был сформирован чек. | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getOnBehalfOf) | | Возвращает идентификатор магазин | +| public | [getPaymentId()](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md#method_getPaymentId) | | Возвращает идентификатор платежа | +| public | [getRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getRegisteredAt) | | Возвращает дату и время формирования чека в фискальном накопителе | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getSettlements) | | Возвращает Массив оплат, обеспечивающих выдачу товара | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | +| public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | +| public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | +| public | [setFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalStorageNumber) | | Устанавливает номер фискального накопителя в кассовом аппарате | +| public | [setId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setId) | | Устанавливает идентификатор чека | +| public | [setItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setItems) | | Устанавливает список позиций в чеке | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setObjectId) | | Устанавливает идентификатор платежа или возврата, для которого был сформирован чек | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек | +| public | [setPaymentId()](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md#method_setPaymentId) | | Устанавливает идентификатор платежа в ЮKassa | +| public | [setRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setRegisteredAt) | | Устанавливает дату и время формирования чека в фискальном накопителе | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара | +| public | [setSpecificProperties()](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md#method_setSpecificProperties) | | Установка свойств, присущих конкретному объекту | +| public | [setStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setStatus) | | Устанавливает состояние регистрации фискального чека | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setType) | | Устанавливает типа чека | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Receipts/PaymentReceiptResponse.php](../../lib/Request/Receipts/PaymentReceiptResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + * \YooKassa\Request\Receipts\PaymentReceiptResponse +--- +## Constants + +###### LENGTH_RECEIPT_ID +Inherited from [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +Длина идентификатора чека + +```php +LENGTH_RECEIPT_ID = 39 +``` + + + +###### LENGTH_PAYMENT_ID +Длина идентификатора платежа + +```php +LENGTH_PAYMENT_ID = 36 +``` + + +--- +## Properties + +#### public $fiscal_attribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_document_number : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_provider_id : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_storage_number : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalAttribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalDocumentNumber : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalProviderId : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalStorageNumber : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор чека в ЮKassa. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $items : \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +--- +***Description*** + +Список товаров в заказе + +**Type:** ReceiptResponseItemInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $object_id : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $objectId : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $on_behalf_of : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $onBehalfOf : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $payment_id : string +--- +***Description*** + +Идентификатор платежа в ЮKassa + +**Type:** string + +**Details:** + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа в ЮKassa + +**Type:** string + +**Details:** + + + +#### public $registered_at : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $registeredAt : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $settlements : \YooKassa\Model\SettlementInterface[] +--- +***Description*** + +Перечень совершенных расчетов. + +**Type:** SettlementInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $status : string +--- +***Description*** + +Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $tax_system_code : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $taxSystemCode : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $type : string +--- +***Description*** + +Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addItem() : mixed + +```php +public addItem(\YooKassa\Request\Receipts\ReceiptResponseItemInterface value) : mixed +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface | value | Объект добавляемой в чек позиции | + +**Returns:** mixed - + + + +#### public addSettlement() : mixed + +```php +public addSettlement(\YooKassa\Model\SettlementInterface value) : mixed +``` + +**Summary** + +Добавляет оплату в массив + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface | value | | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getFiscalAttribute() : string + +```php +public getFiscalAttribute() : string +``` + +**Summary** + +Возвращает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Фискальный признак чека + + + +#### public getFiscalDocumentNumber() : string + +```php +public getFiscalDocumentNumber() : string +``` + +**Summary** + +Возвращает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального документа + + + +#### public getFiscalProviderId() : string + +```php +public getFiscalProviderId() : string +``` + +**Summary** + +Возвращает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Идентификатор чека в онлайн-кассе + + + +#### public getFiscalStorageNumber() : string + +```php +public getFiscalStorageNumber() : string +``` + +**Summary** + +Возвращает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального накопителя в кассовом аппарате + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор чека в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] + +```php +public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +``` + +**Summary** + +Возвращает список товаров в заказ + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает идентификатор платежа или возврата, для которого был сформирован чек. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + + + +#### public getOnBehalfOf() : string|null + +```php +public getOnBehalfOf() : string|null +``` + +**Summary** + +Возвращает идентификатор магазин + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\PaymentReceiptResponse](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getRegisteredAt() : \DateTime + +```php +public getRegisteredAt() : \DateTime +``` + +**Summary** + +Возвращает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \DateTime - Дата и время формирования чека в фискальном накопителе + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает Массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус доставки данных для чека в онлайн-кассу + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** int - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setFiscalAttribute() : mixed + +```php +public setFiscalAttribute(string fiscal_attribute) : mixed +``` + +**Summary** + +Устанавливает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_attribute | Фискальный признак чека | + +**Returns:** mixed - + + + +#### public setFiscalDocumentNumber() : mixed + +```php +public setFiscalDocumentNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер фискального документа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setFiscalProviderId() : mixed + +```php +public setFiscalProviderId(string fiscal_provider_id) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_provider_id | Идентификатор чека в онлайн-кассе | + +**Returns:** mixed - + + + +#### public setFiscalStorageNumber() : mixed + +```php +public setFiscalStorageNumber(string fiscal_storage_number) : mixed +``` + +**Summary** + +Устанавливает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_storage_number | Номер фискального накопителя в кассовом аппарате | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 40 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setItems() : mixed + +```php +public setItems(\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список позиций в чеке + +**Description** + +Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком +позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс +ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] | value | Список товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передали пустой массив значений | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения был передан не массив и не итератор, лабо если одно из переданных значений не реализует интерфейс ReceiptItemInterface | + +**Returns:** mixed - + + + +#### public setObjectId() : mixed + +```php +public setObjectId( value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа или возврата, для которого был сформирован чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public setOnBehalfOf() : mixed + +```php +public setOnBehalfOf(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор магазина, от имени которого нужно отправить чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина, от имени которого нужно отправить чек | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\PaymentReceiptResponse](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа в ЮKassa | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | + +**Returns:** mixed - + + + +#### public setRegisteredAt() : mixed + +```php +public setRegisteredAt(\DateTime registered_at) : mixed +``` + +**Summary** + +Устанавливает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | registered_at | Дата и время формирования чека в фискальном накопителе | + +**Returns:** mixed - + + + +#### public setSettlements() : mixed + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] | value | | + +**Returns:** mixed - + + + +#### public setSpecificProperties() : void + +```php +public setSpecificProperties(array receiptData) : void +``` + +**Summary** + +Установка свойств, присущих конкретному объекту + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\PaymentReceiptResponse](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | receiptData | | + +**Returns:** void - + + + +#### public setStatus() : \YooKassa\Request\Receipts\AbstractReceiptResponse + +```php +public setStatus(string value) : \YooKassa\Request\Receipts\AbstractReceiptResponse +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse - + + + +#### public setTaxSystemCode() : mixed + +```php +public setTaxSystemCode(int value) : mixed +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданный аргумент меньше одного или больше шести | + +**Returns:** mixed - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает типа чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным типом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md new file mode 100644 index 00000000..e66804d2 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\ReceiptResponseFactory +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Фабричный класс для работы с чеками + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [factory()](../classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md#method_factory) | | Фабричный метод для работы с чеками | +--- +### Details +* File: [lib/Request/Receipts/ReceiptResponseFactory.php](../../lib/Request/Receipts/ReceiptResponseFactory.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Receipts\ReceiptResponseFactory + +--- +## Methods + +#### public factory() : \YooKassa\Request\Receipts\AbstractReceiptResponse|\YooKassa\Request\Receipts\SimpleReceiptResponse|\YooKassa\Request\Receipts\PaymentReceiptResponse|\YooKassa\Request\Receipts\RefundReceiptResponse + +```php +public factory(array data) : \YooKassa\Request\Receipts\AbstractReceiptResponse|\YooKassa\Request\Receipts\SimpleReceiptResponse|\YooKassa\Request\Receipts\PaymentReceiptResponse|\YooKassa\Request\Receipts\RefundReceiptResponse +``` + +**Summary** + +Фабричный метод для работы с чеками + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseFactory](../classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | Массив с данными чека | + +**Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse|\YooKassa\Request\Receipts\SimpleReceiptResponse|\YooKassa\Request\Receipts\PaymentReceiptResponse|\YooKassa\Request\Receipts\RefundReceiptResponse - Объект чека определенного типа + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md new file mode 100644 index 00000000..80fb18f8 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md @@ -0,0 +1,216 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ReceiptResponseInterface +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Interface ReceiptInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getId()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getId) | | Возвращает идентификатор чека в ЮKassa | +| public | [getItems()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getItems) | | Возвращает список товаров в заказ | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getOnBehalfOf) | | Возвращает идентификатор магазин | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getSettlements) | | Возвращает список расчетов | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | + +--- +### Details +* File: [lib/Request/Receipts/ReceiptResponseInterface.php](../../lib/Request/Receipts/ReceiptResponseInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Идентификатор чека в ЮKassa. | +| property-read | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | +| property-read | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| property-read | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| property-read | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| property-read | | Код системы налогообложения. Число 1-6. | +| property-read | | Код системы налогообложения. Число 1-6. | +| property-read | | Список товаров в заказе | +| property-read | | Список товаров в заказе | +--- +## Methods + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор чека в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** string - Идентификатор чека в ЮKassa. + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** string - Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + + + +#### public getStatus() : mixed + +```php +public getStatus() : mixed +``` + +**Summary** + +Возвращает статус доставки данных для чека в онлайн-кассу + +**Description** + + @return string Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** mixed - + + + +#### public getTaxSystemCode() : mixed + +```php +public getTaxSystemCode() : mixed +``` + +**Summary** + +Возвращает код системы налогообложения + +**Description** + + @return int Код системы налогообложения. Число 1-6. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** mixed - + + + +#### public getItems() : mixed + +```php +public getItems() : mixed +``` + +**Summary** + +Возвращает список товаров в заказ + +**Description** + + @return ReceiptResponseItemInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** mixed - + + + +#### public getSettlements() : mixed + +```php +public getSettlements() : mixed +``` + +**Summary** + +Возвращает список расчетов + +**Description** + + @return SettlementInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** mixed - + + + +#### public getOnBehalfOf() : string|null + +```php +public getOnBehalfOf() : string|null +``` + +**Summary** + +Возвращает идентификатор магазин + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** string|null - + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md new file mode 100644 index 00000000..cca9f540 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItem.md @@ -0,0 +1,782 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\ReceiptResponseItem +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс, описывающий товар в чеке + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_amount) | | Суммарная стоимость товара в копейках/центах | +| public | [$description](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_description) | | Название товара (не более 128 символов). | +| public | [$payment_mode](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_payment_mode) | | Признак способа расчета | +| public | [$payment_subject](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_payment_subject) | | Признак предмета расчета | +| public | [$paymentMode](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_paymentMode) | | Признак способа расчета | +| public | [$paymentSubject](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_paymentSubject) | | Признак предмета расчета | +| public | [$price](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_price) | | Цена товара | +| public | [$quantity](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_quantity) | | Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы. | +| public | [$vat_code](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_vat_code) | | Ставка НДС, число 1-6 | +| public | [$vatCode](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#property_vatCode) | | Ставка НДС, число 1-6 | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method___construct) | | Конструктор, устанавливает настройки товара из ассоциативного массива | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getAmount) | | Возвращает общую стоимость покупаемого товара в копейках/центах | +| public | [getDescription()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getDescription) | | Возвращает наименование товара | +| public | [getPaymentMode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getPaymentMode) | | Возвращает признак способа расчета | +| public | [getPaymentSubject()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getPaymentSubject) | | Возвращает признак предмета расчета | +| public | [getPrice()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getPrice) | | Возвращает цену товара | +| public | [getQuantity()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getQuantity) | | Возвращает количество товара | +| public | [getSupplier()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getSupplier) | | Возвращает информацию о поставщике товара или услуги | +| public | [getVatCode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_getVatCode) | | Возвращает ставку НДС | +| public | [jsonSerialize()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setDescription()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setDescription) | | Устанавливает наименование товара | +| public | [setPaymentMode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setPaymentMode) | | Устанавливает признак способа расчета | +| public | [setPaymentSubject()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setPaymentSubject) | | Устанавливает признак предмета расчета | +| public | [setPrice()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setPrice) | | Устанавливает цену товара | +| public | [setQuantity()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setQuantity) | | Устанавливает количество покупаемого товара | +| public | [setSupplier()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setSupplier) | | Устанавливает информацию о поставщике товара или услуги. | +| public | [setVatCode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md#method_setVatCode) | | Устанавливает ставку НДС | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Receipts/ReceiptResponseItem.php](../../lib/Request/Receipts/ReceiptResponseItem.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * \YooKassa\Request\Receipts\ReceiptResponseItem +* Implements: + * [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) +--- +## Properties + +#### public $amount : float +--- +***Description*** + +Суммарная стоимость товара в копейках/центах + +**Type:** float + +**Details:** + + + +#### public $description : string +--- +***Description*** + +Название товара (не более 128 символов). + +**Type:** string + +**Details:** + + + +#### public $payment_mode : string +--- +***Description*** + +Признак способа расчета + +**Type:** string + +**Details:** + + + +#### public $payment_subject : string +--- +***Description*** + +Признак предмета расчета + +**Type:** string + +**Details:** + + + +#### public $paymentMode : string +--- +***Description*** + +Признак способа расчета + +**Type:** string + +**Details:** + + + +#### public $paymentSubject : string +--- +***Description*** + +Признак предмета расчета + +**Type:** string + +**Details:** + + + +#### public $price : \YooKassa\Model\AmountInterface +--- +***Description*** + +Цена товара + +**Type:** AmountInterface + +**Details:** + + + +#### public $quantity : float +--- +***Description*** + +Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы. + +**Type:** float + +**Details:** + + + +#### public $vat_code : int +--- +***Description*** + +Ставка НДС, число 1-6 + +**Type:** int + +**Details:** + + + +#### public $vatCode : int +--- +***Description*** + +Ставка НДС, число 1-6 + +**Type:** int + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array itemData) : mixed +``` + +**Summary** + +Конструктор, устанавливает настройки товара из ассоциативного массива + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | itemData | Массив с информацией о товаре, пришедший от API | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : int + +```php +public getAmount() : int +``` + +**Summary** + +Возвращает общую стоимость покупаемого товара в копейках/центах + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** int - Сумма стоимости покупаемого товара + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает наименование товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** string - Наименование товара + + + +#### public getPaymentMode() : string|null + +```php +public getPaymentMode() : string|null +``` + +**Summary** + +Возвращает признак способа расчета + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** string|null - Признак способа расчета + + + +#### public getPaymentSubject() : string|null + +```php +public getPaymentSubject() : string|null +``` + +**Summary** + +Возвращает признак предмета расчета + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** string|null - Признак предмета расчета + + + +#### public getPrice() : \YooKassa\Model\AmountInterface + +```php +public getPrice() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает цену товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** \YooKassa\Model\AmountInterface - Цена товара + + + +#### public getQuantity() : float + +```php +public getQuantity() : float +``` + +**Summary** + +Возвращает количество товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** float - Количество купленного товара + + + +#### public getSupplier() : \YooKassa\Model\SupplierInterface + +```php +public getSupplier() : \YooKassa\Model\SupplierInterface +``` + +**Summary** + +Возвращает информацию о поставщике товара или услуги + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** \YooKassa\Model\SupplierInterface - + + + +#### public getVatCode() : int|null + +```php +public getVatCode() : int|null +``` + +**Summary** + +Возвращает ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** int|null - Ставка НДС, число 1-6, или null если ставка не задана + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) + +**Returns:** array - + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает наименование товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Наименование товара | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setPaymentMode() : mixed + +```php +public setPaymentMode(string value) : mixed +``` + +**Summary** + +Устанавливает признак способа расчета + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Признак способа расчета | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setPaymentSubject() : mixed + +```php +public setPaymentSubject(string value) : mixed +``` + +**Summary** + +Устанавливает признак предмета расчета + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Признак предмета расчета | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента была передана не строка | + +**Returns:** mixed - + + + +#### public setPrice() : mixed + +```php +public setPrice(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает цену товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Цена товара | + +**Returns:** mixed - + + + +#### public setQuantity() : mixed + +```php +public setQuantity(int value) : mixed +``` + +**Summary** + +Устанавливает количество покупаемого товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Количество | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если было передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если в качестве аргумента был передан ноль или отрицательное число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента было передано не число | + +**Returns:** mixed - + + + +#### public setSupplier() : mixed + +```php +public setSupplier(\YooKassa\Model\SupplierInterface|array value) : mixed +``` + +**Summary** + +Устанавливает информацию о поставщике товара или услуги. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SupplierInterface OR array | value | | + +**Returns:** mixed - + + + +#### public setVatCode() : mixed + +```php +public setVatCode(int value) : mixed +``` + +**Summary** + +Устанавливает ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Ставка НДС, число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если в качестве аргумента было передано число меньше одного или больше шести | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве аргумента было передано не число | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md new file mode 100644 index 00000000..aa8cc95e --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md @@ -0,0 +1,161 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ReceiptResponseItemInterface +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Interface ReceiptItemInterface + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md#method_getAmount) | | Возвращает общую стоимость покупаемого товара в копейках/центах | +| public | [getDescription()](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md#method_getDescription) | | Возвращает название товара | +| public | [getPrice()](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md#method_getPrice) | | Возвращает цену товара | +| public | [getQuantity()](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md#method_getQuantity) | | Возвращает количество товара | +| public | [getSupplier()](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md#method_getSupplier) | | Возвращает информацию о поставщике товара или услуги | +| public | [getVatCode()](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md#method_getVatCode) | | Возвращает ставку НДС | + +--- +### Details +* File: [lib/Request/Receipts/ReceiptResponseItemInterface.php](../../lib/Request/Receipts/ReceiptResponseItemInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Название товара (не более 128 символов). | +| property-read | | Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы. | +| property-read | | Суммарная стоимость товара в копейках/центах | +| property-read | | Цена товара | +| property-read | | Ставка НДС, число 1-6 | +| property-read | | Ставка НДС, число 1-6 | +--- +## Methods + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает название товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) + +**Returns:** string - Название товара (не более 128 символов). + + + +#### public getQuantity() : float + +```php +public getQuantity() : float +``` + +**Summary** + +Возвращает количество товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) + +**Returns:** float - Количество купленного товара + + + +#### public getAmount() : float + +```php +public getAmount() : float +``` + +**Summary** + +Возвращает общую стоимость покупаемого товара в копейках/центах + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) + +**Returns:** float - Сумма стоимости покупаемого товара + + + +#### public getPrice() : \YooKassa\Model\AmountInterface + +```php +public getPrice() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает цену товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Цена товара + + + +#### public getVatCode() : int|null + +```php +public getVatCode() : int|null +``` + +**Summary** + +Возвращает ставку НДС + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) + +**Returns:** int|null - Ставка НДС, число 1-6, или null если ставка не задана + + + +#### public getSupplier() : \YooKassa\Model\SupplierInterface + +```php +public getSupplier() : \YooKassa\Model\SupplierInterface +``` + +**Summary** + +Возвращает информацию о поставщике товара или услуги + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) + +**Returns:** \YooKassa\Model\SupplierInterface - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md new file mode 100644 index 00000000..2e0ebdb2 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequest.md @@ -0,0 +1,1115 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\ReceiptsRequest +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс объекта запроса к API списка возвратов магазина + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LIMIT_VALUE](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#constant_MAX_LIMIT_VALUE) | | Максимальное количество объектов чеков в выборке | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$createdAtGt](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_createdAtGt) | | Время создания, от (не включая) | +| public | [$createdAtGte](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_createdAtGte) | | Время создания, от (включительно) | +| public | [$createdAtLt](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_createdAtLt) | | Время создания, до (не включая) | +| public | [$createdAtLte](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_createdAtLte) | | Время создания, до (включительно) | +| public | [$cursor](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_cursor) | | Токен для получения следующей страницы выборки | +| public | [$limit](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_limit) | | Ограничение количества объектов возврата, отображаемых на одной странице выдачи | +| public | [$paymentId](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_paymentId) | | Идентификатор платежа | +| public | [$refundId](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_refundId) | | Идентификатор возврата | +| public | [$status](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#property_status) | | Статус возврата | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_builder) | | Возвращает инстанс билдера объектов запросов списка возвратов магазина | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getCreatedAtGt) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getCreatedAtGte) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getCreatedAtLt) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getCreatedAtLte) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCursor()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getCursor) | | Возвращает токен для получения следующей страницы выборки | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getLimit()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getLimit) | | Ограничение количества объектов платежа | +| public | [getPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getPaymentId) | | Возвращает идентификатор платежа если он задан или null | +| public | [getRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getRefundId) | | Возвращает идентификатор возврата | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_getStatus) | | Возвращает статус выбираемых возвратов или null если он до этого не был установлен | +| public | [hasCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasCreatedAtGt) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasCreatedAtGte) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasCreatedAtLt) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCreatedAtLte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasCreatedAtLte) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCursor()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasCursor) | | Проверяет был ли установлен токен следующей страницы | +| public | [hasLimit()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasLimit) | | Проверяет был ли установлено ограничение количества объектов платежа | +| public | [hasPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasPaymentId) | | Проверяет, был ли задан идентификатор платежа | +| public | [hasRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasRefundId) | | Проверяет был ли установлен идентификатор возврата | +| public | [hasStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_hasStatus) | | Проверяет был ли установлен статус выбираемых возвратов | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются возвраты | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются возвраты | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются возвраты | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются возвраты | +| public | [setCursor()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setCursor) | | Устанавливает токен следующей страницы выборки | +| public | [setLimit()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setLimit) | | Устанавливает ограничение количества объектов платежа | +| public | [setPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа или null если требуется его удалить | +| public | [setRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setRefundId) | | Устанавливает идентификатор возврата | +| public | [setStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_setStatus) | | Устанавливает статус выбираемых возвратов | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md#method_validate) | | Проверяет валидность текущего объекта запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Receipts/ReceiptsRequest.php](../../lib/Request/Receipts/ReceiptsRequest.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Request\Receipts\ReceiptsRequest +* Implements: + * [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) +--- +## Constants + +###### MAX_LIMIT_VALUE +Максимальное количество объектов чеков в выборке + +```php +MAX_LIMIT_VALUE = 100 +``` + + +--- +## Properties + +#### public $createdAtGt : \DateTime +--- +***Description*** + +Время создания, от (не включая) + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAtGte : \DateTime +--- +***Description*** + +Время создания, от (включительно) + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAtLt : \DateTime +--- +***Description*** + +Время создания, до (не включая) + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAtLte : \DateTime +--- +***Description*** + +Время создания, до (включительно) + +**Type:** \DateTime + +**Details:** + + + +#### public $cursor : string +--- +***Description*** + +Токен для получения следующей страницы выборки + +**Type:** string + +**Details:** + + + +#### public $limit : int|null +--- +***Description*** + +Ограничение количества объектов возврата, отображаемых на одной странице выдачи + +**Type:** int|null + +**Details:** + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** + + + +#### public $refundId : string +--- +***Description*** + +Идентификатор возврата + +**Type:** string + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Статус возврата + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Возвращает инстанс билдера объектов запросов списка возвратов магазина + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Билдер объектов запросов списка возвратов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCreatedAtGt() : \DateTime|null + +```php +public getCreatedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** \DateTime|null - Время создания, от (не включая) + + + +#### public getCreatedAtGte() : \DateTime|null + +```php +public getCreatedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** \DateTime|null - Время создания, от (включительно) + + + +#### public getCreatedAtLt() : \DateTime|null + +```php +public getCreatedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** \DateTime|null - Время создания, до (не включая) + + + +#### public getCreatedAtLte() : \DateTime|null + +```php +public getCreatedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** \DateTime|null - Время создания, до (включительно) + + + +#### public getCursor() : string|null + +```php +public getCursor() : string|null +``` + +**Summary** + +Возвращает токен для получения следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** string|null - Токен для получения следующей страницы выборки + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getLimit() : int|null + +```php +public getLimit() : int|null +``` + +**Summary** + +Ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** int|null - Ограничение количества объектов платежа + + + +#### public getPaymentId() : string|null + +```php +public getPaymentId() : string|null +``` + +**Summary** + +Возвращает идентификатор платежа если он задан или null + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** string|null - Идентификатор платежа + + + +#### public getRefundId() : string + +```php +public getRefundId() : string +``` + +**Summary** + +Возвращает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус выбираемых возвратов или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** string|null - Статус выбираемых возвратов + + + +#### public hasCreatedAtGt() : bool + +```php +public hasCreatedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtGte() : bool + +```php +public hasCreatedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtLt() : bool + +```php +public hasCreatedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtLte() : bool + +```php +public hasCreatedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCursor() : bool + +```php +public hasCursor() : bool +``` + +**Summary** + +Проверяет был ли установлен токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если токен был установлен, false если нет + + + +#### public hasLimit() : bool + +```php +public hasLimit() : bool +``` + +**Summary** + +Проверяет был ли установлено ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если было установлено, false если нет + + + +#### public hasPaymentId() : bool + +```php +public hasPaymentId() : bool +``` + +**Summary** + +Проверяет, был ли задан идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если идентификатор был задан, false если нет + + + +#### public hasRefundId() : bool + +```php +public hasRefundId() : bool +``` + +**Summary** + +Проверяет был ли установлен идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если идентификатор возврата был установлен, false если не был + + + +#### public hasStatus() : bool + +```php +public hasStatus() : bool +``` + +**Summary** + +Проверяет был ли установлен статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если статус был установлен, false если нет + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCreatedAtGt() : mixed + +```php +public setCreatedAtGt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtGte() : mixed + +```php +public setCreatedAtGte(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtLt() : mixed + +```php +public setCreatedAtLt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtLte() : mixed + +```php +public setCreatedAtLte(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCursor() : mixed + +```php +public setCursor(string value) : mixed +``` + +**Summary** + +Устанавливает токен следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Токен следующей страницы выборки или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setLimit() : mixed + +```php +public setLimit(int|null value) : mixed +``` + +**Summary** + +Устанавливает ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int OR null | value | Ограничение количества объектов платежа или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передано не целое число | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string|null value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа или null если требуется его удалить + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 символам | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setRefundId() : mixed + +```php +public setRefundId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор возврата, который ищется в API | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет валидность текущего объекта запроса + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) + +**Returns:** bool - True если объект валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md new file mode 100644 index 00000000..2b57a821 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md @@ -0,0 +1,390 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\ReceiptsRequestBuilder +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс билдера объектов запросов к API списка чеков + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$currentObject](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [build()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_build) | | Собирает и возвращает объект запроса списка чеков магазина | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются чеки | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются чеки | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются чеки | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются чеки | +| public | [setCursor()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setCursor) | | Устанавливает токен следующей страницы выборки | +| public | [setLimit()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setLimit) | | Устанавливает ограничение количества объектов чеков | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setPaymentId) | | Устанавливает идентификатор платежа или null если требуется его удалить | +| public | [setRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setRefundId) | | Устанавливает идентификатор возврата | +| public | [setStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_setStatus) | | Устанавливает статус выбираемых чеков | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md#method_initCurrentObject) | | Инициализирует новый инстанс собираемого объекта | +--- +### Details +* File: [lib/Request/Receipts/ReceiptsRequestBuilder.php](../../lib/Request/Receipts/ReceiptsRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Request\Receipts\ReceiptsRequestBuilder +--- +## Properties + +#### protected $currentObject : \YooKassa\Request\Receipts\ReceiptsRequest +--- +**Summary** + +Инстанс собираемого запроса + +**Type:** ReceiptsRequest +Инстанс собираемого объекта запроса +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public build() : \YooKassa\Request\Receipts\ReceiptsRequestInterface|\YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Request\Receipts\ReceiptsRequestInterface|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Собирает и возвращает объект запроса списка чеков магазина + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив с настройками запроса | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestInterface|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса к API для получения списка чеков магазина + + + +#### public setCreatedAtGt() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setCreatedAtGt(\DateTime|string|int|null value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания от которой выбираются чеки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCreatedAtGte() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setCreatedAtGte(\DateTime|string|int|null value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания от которой выбираются чеки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCreatedAtLt() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setCreatedAtLt(\DateTime|string|int|null value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания до которой выбираются чеки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCreatedAtLte() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setCreatedAtLte(\DateTime|string|int|null value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания до которой выбираются чеки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCursor() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setCursor(string value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает токен следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Токен следующей страницы выборки или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setLimit() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setLimit(string value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает ограничение количества объектов чеков + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ограничение количества объектов чеков или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод было передана не целое число | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего билдера + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setPaymentId() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setPaymentId(string|null value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор платежа или null если требуется его удалить + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 символам | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setRefundId() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setRefundId(string value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор возврата, который ищется в API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданного значения не равна 36 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setStatus() : \YooKassa\Request\Receipts\ReceiptsRequestBuilder + +```php +public setStatus(string value) : \YooKassa\Request\Receipts\ReceiptsRequestBuilder +``` + +**Summary** + +Устанавливает статус выбираемых чеков + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequestBuilder - Инстанс текущего объекта билдера + + + +#### protected initCurrentObject() : \YooKassa\Request\Receipts\ReceiptsRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Receipts\ReceiptsRequest +``` + +**Summary** + +Инициализирует новый инстанс собираемого объекта + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptsRequest - Инстанс собираемого запроса + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md new file mode 100644 index 00000000..9694da1b --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md @@ -0,0 +1,380 @@ +# [YooKassa API SDK](../home.md) + +# Interface: ReceiptsRequestInterface +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Интерфейс объекта запроса списка возвратов + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getCreatedAtGt) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getCreatedAtGte) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getCreatedAtLt) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLte()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getCreatedAtLte) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCursor()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getCursor) | | Возвращает токен для получения следующей страницы выборки | +| public | [getLimit()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getLimit) | | Возвращает ограничение количества объектов или null если оно до этого не было установлено | +| public | [getPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getPaymentId) | | Возвращает идентификатор платежа если он задан или null | +| public | [getRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getRefundId) | | Возвращает идентификатор возврата | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_getStatus) | | Возвращает статус выбираемых возвратов или null если он до этого не был установлен | +| public | [hasCreatedAtGt()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasCreatedAtGt) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtGte()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasCreatedAtGte) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtLt()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasCreatedAtLt) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCreatedAtLte()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasCreatedAtLte) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCursor()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasCursor) | | Проверяет был ли установлен токен следующей страницы | +| public | [hasLimit()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasLimit) | | Проверяет было ли установлено ограничение количества объектов | +| public | [hasPaymentId()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasPaymentId) | | Проверяет, был ли задан идентификатор платежа | +| public | [hasRefundId()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasRefundId) | | Проверяет был ли установлен идентификатор возврата | +| public | [hasStatus()](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md#method_hasStatus) | | Проверяет был ли установлен статус выбираемых возвратов | + +--- +### Details +* File: [lib/Request/Receipts/ReceiptsRequestInterface.php](../../lib/Request/Receipts/ReceiptsRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Идентификатор платежа | +| property-read | | Идентификатор возврата | +| property-read | | Время создания, от (включительно) | +| property-read | | Время создания, от (не включая) | +| property-read | | Время создания, до (включительно) | +| property-read | | Время создания, до (не включая) | +| property-read | | Статус возврата | +| property-read | | Токен для получения следующей страницы выборки | +| property-read | | Ограничение количества объектов, отображаемых на одной странице выдачи | +--- +## Methods + +#### public getRefundId() : string + +```php +public getRefundId() : string +``` + +**Summary** + +Возвращает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** string - Идентификатор возврата + + + +#### public hasRefundId() : bool + +```php +public hasRefundId() : bool +``` + +**Summary** + +Проверяет был ли установлен идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если идентификатор возврата был установлен, false если не был + + + +#### public getPaymentId() : string|null + +```php +public getPaymentId() : string|null +``` + +**Summary** + +Возвращает идентификатор платежа если он задан или null + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** string|null - Идентификатор платежа + + + +#### public hasPaymentId() : bool + +```php +public hasPaymentId() : bool +``` + +**Summary** + +Проверяет, был ли задан идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если идентификатор был задан, false если нет + + + +#### public getCreatedAtGte() : \DateTime|null + +```php +public getCreatedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, от (включительно) + + + +#### public hasCreatedAtGte() : bool + +```php +public hasCreatedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getCreatedAtGt() : \DateTime|null + +```php +public getCreatedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, от (не включая) + + + +#### public hasCreatedAtGt() : bool + +```php +public hasCreatedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getCreatedAtLte() : \DateTime|null + +```php +public getCreatedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, до (включительно) + + + +#### public hasCreatedAtLte() : bool + +```php +public hasCreatedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getCreatedAtLt() : \DateTime|null + +```php +public getCreatedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, до (не включая) + + + +#### public hasCreatedAtLt() : bool + +```php +public hasCreatedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус выбираемых возвратов или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** string|null - Статус выбираемых возвратов + + + +#### public hasStatus() : bool + +```php +public hasStatus() : bool +``` + +**Summary** + +Проверяет был ли установлен статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если статус был установлен, false если нет + + + +#### public getCursor() : string|null + +```php +public getCursor() : string|null +``` + +**Summary** + +Возвращает токен для получения следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** string|null - Токен для получения следующей страницы выборки + + + +#### public hasCursor() : bool + +```php +public hasCursor() : bool +``` + +**Summary** + +Проверяет был ли установлен токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если токен был установлен, false если нет + + + +#### public getLimit() : string|null + +```php +public getLimit() : string|null +``` + +**Summary** + +Возвращает ограничение количества объектов или null если оно до этого не было установлено + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** string|null - Ограничение количества объектов + + + +#### public hasLimit() : bool + +```php +public hasLimit() : bool +``` + +**Summary** + +Проверяет было ли установлено ограничение количества объектов + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) + +**Returns:** bool - True если ограничение количества объектов было установлено, false если нет + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md new file mode 100644 index 00000000..7b8303de --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\ReceiptsRequestSerializer +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс сериализатора объектов запросов к API для получения списка возвратов + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md#method_serialize) | | Сериализует объект запроса к API для дальнейшей его отправки | +--- +### Details +* File: [lib/Request/Receipts/ReceiptsRequestSerializer.php](../../lib/Request/Receipts/ReceiptsRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Receipts\ReceiptsRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Receipts\ReceiptsRequestInterface request) : array +``` + +**Summary** + +Сериализует объект запроса к API для дальнейшей его отправки + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsRequestSerializer](../classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptsRequestInterface | request | Сериализуемый объект | + +**Returns:** array - Массив с информацией, отправляемый в дальнейшем в API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md b/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md new file mode 100644 index 00000000..ba2088a5 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-ReceiptsResponse.md @@ -0,0 +1,142 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\ReceiptsResponse +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс для работы со списком чеков + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md#method___construct) | | Конструктор, устанавливает список полученых от API чеков | +| public | [getItems()](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md#method_getItems) | | Возаращает список чеков | +| public | [getNextCursor()](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md#method_getNextCursor) | | Возвращает токен следующей страницы, если он задан, или null | +| public | [getType()](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md#method_getType) | | Возвращает формат выдачи результатов запроса. Возможное значение: `list` (список). | +| public | [hasNextCursor()](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md#method_hasNextCursor) | | Проверяет имееотся ли в ответе токен следующей страницы | +--- +### Details +* File: [lib/Request/Receipts/ReceiptsResponse.php](../../lib/Request/Receipts/ReceiptsResponse.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Receipts\ReceiptsResponse + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array response) : mixed +``` + +**Summary** + +Конструктор, устанавливает список полученых от API чеков + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsResponse](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | response | Разобранный ответ от API в виде чеков | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public getItems() : \YooKassa\Request\Receipts\ReceiptResponseInterface[] + +```php +public getItems() : \YooKassa\Request\Receipts\ReceiptResponseInterface[] +``` + +**Summary** + +Возаращает список чеков + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsResponse](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptResponseInterface[] - Список чеков + + + +#### public getNextCursor() : string|null + +```php +public getNextCursor() : string|null +``` + +**Summary** + +Возвращает токен следующей страницы, если он задан, или null + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsResponse](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md) + +**Returns:** string|null - Токен следующей страницы + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает формат выдачи результатов запроса. Возможное значение: `list` (список). + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsResponse](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md) + +**Returns:** string - Формат выдачи результатов запроса. + + + +#### public hasNextCursor() : bool + +```php +public hasNextCursor() : bool +``` + +**Summary** + +Проверяет имееотся ли в ответе токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\ReceiptsResponse](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md) + +**Returns:** bool - True если токен следующей страницы есть, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md new file mode 100644 index 00000000..2c4a0e87 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-RefundReceiptResponse.md @@ -0,0 +1,1382 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\RefundReceiptResponse +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс описывающий чек, привязанный к возврату + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [LENGTH_RECEIPT_ID](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#constant_LENGTH_RECEIPT_ID) | | Длина идентификатора чека | +| public | [LENGTH_REFUND_ID](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md#constant_LENGTH_REFUND_ID) | | Длина идентификатора возврата | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$fiscal_attribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_attribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscal_document_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_document_number) | | Номер фискального документа. | +| public | [$fiscal_provider_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_provider_id) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscal_storage_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_storage_number) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$fiscalAttribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalAttribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscalDocumentNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalDocumentNumber) | | Номер фискального документа. | +| public | [$fiscalProviderId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalProviderId) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscalStorageNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalStorageNumber) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_id) | | Идентификатор чека в ЮKassa. | +| public | [$items](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_items) | | Список товаров в заказе | +| public | [$object_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_object_id) | | Идентификатор объекта чека. | +| public | [$objectId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_objectId) | | Идентификатор объекта чека. | +| public | [$on_behalf_of](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_on_behalf_of) | | Идентификатор магазина | +| public | [$onBehalfOf](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_onBehalfOf) | | Идентификатор магазина | +| public | [$refund_id](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md#property_refund_id) | | Идентификатор возврата в ЮKassa. | +| public | [$refundId](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md#property_refundId) | | Идентификатор возврата в ЮKassa. | +| public | [$registered_at](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registered_at) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$registeredAt](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registeredAt) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$settlements](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_settlements) | | Перечень совершенных расчетов. | +| public | [$status](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_status) | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| public | [$tax_system_code](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_tax_system_code) | | Код системы налогообложения. Число 1-6. | +| public | [$taxSystemCode](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_taxSystemCode) | | Код системы налогообложения. Число 1-6. | +| public | [$type](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_type) | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addItem()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addItem) | | Добавляет товар в чек | +| public | [addSettlement()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addSettlement) | | Добавляет оплату в массив | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalAttribute) | | Возвращает фискальный признак чека | +| public | [getFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalDocumentNumber) | | Возвращает номер фискального документа | +| public | [getFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalProviderId) | | Возвращает идентификатор чека в онлайн-кассе | +| public | [getFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalStorageNumber) | | Возвращает номер фискального накопителя в кассовом аппарате | +| public | [getId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getId) | | Возвращает идентификатор чека в ЮKassa | +| public | [getItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getItems) | | Возвращает список товаров в заказ | +| public | [getObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getObjectId) | | Возвращает идентификатор платежа или возврата, для которого был сформирован чек. | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getOnBehalfOf) | | Возвращает идентификатор магазин | +| public | [getRefundId()](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md#method_getRefundId) | | Возвращает идентификатор возврата | +| public | [getRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getRegisteredAt) | | Возвращает дату и время формирования чека в фискальном накопителе | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getSettlements) | | Возвращает Массив оплат, обеспечивающих выдачу товара | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | +| public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | +| public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | +| public | [setFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalStorageNumber) | | Устанавливает номер фискального накопителя в кассовом аппарате | +| public | [setId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setId) | | Устанавливает идентификатор чека | +| public | [setItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setItems) | | Устанавливает список позиций в чеке | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setObjectId) | | Устанавливает идентификатор платежа или возврата, для которого был сформирован чек | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек | +| public | [setRefundId()](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md#method_setRefundId) | | Устанавливает идентификатор возврата в ЮKassa | +| public | [setRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setRegisteredAt) | | Устанавливает дату и время формирования чека в фискальном накопителе | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара | +| public | [setSpecificProperties()](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md#method_setSpecificProperties) | | Установка свойств, присущих конкретному объекту | +| public | [setStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setStatus) | | Устанавливает состояние регистрации фискального чека | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setType) | | Устанавливает типа чека | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Receipts/RefundReceiptResponse.php](../../lib/Request/Receipts/RefundReceiptResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + * \YooKassa\Request\Receipts\RefundReceiptResponse +--- +## Constants + +###### LENGTH_RECEIPT_ID +Inherited from [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +Длина идентификатора чека + +```php +LENGTH_RECEIPT_ID = 39 +``` + + + +###### LENGTH_REFUND_ID +Длина идентификатора возврата + +```php +LENGTH_REFUND_ID = 36 +``` + + +--- +## Properties + +#### public $fiscal_attribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_document_number : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_provider_id : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_storage_number : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalAttribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalDocumentNumber : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalProviderId : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalStorageNumber : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор чека в ЮKassa. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $items : \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +--- +***Description*** + +Список товаров в заказе + +**Type:** ReceiptResponseItemInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $object_id : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $objectId : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $on_behalf_of : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $onBehalfOf : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $refund_id : string +--- +***Description*** + +Идентификатор возврата в ЮKassa. + +**Type:** string + +**Details:** + + + +#### public $refundId : string +--- +***Description*** + +Идентификатор возврата в ЮKassa. + +**Type:** string + +**Details:** + + + +#### public $registered_at : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $registeredAt : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $settlements : \YooKassa\Model\SettlementInterface[] +--- +***Description*** + +Перечень совершенных расчетов. + +**Type:** SettlementInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $status : string +--- +***Description*** + +Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $tax_system_code : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $taxSystemCode : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $type : string +--- +***Description*** + +Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addItem() : mixed + +```php +public addItem(\YooKassa\Request\Receipts\ReceiptResponseItemInterface value) : mixed +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface | value | Объект добавляемой в чек позиции | + +**Returns:** mixed - + + + +#### public addSettlement() : mixed + +```php +public addSettlement(\YooKassa\Model\SettlementInterface value) : mixed +``` + +**Summary** + +Добавляет оплату в массив + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface | value | | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getFiscalAttribute() : string + +```php +public getFiscalAttribute() : string +``` + +**Summary** + +Возвращает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Фискальный признак чека + + + +#### public getFiscalDocumentNumber() : string + +```php +public getFiscalDocumentNumber() : string +``` + +**Summary** + +Возвращает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального документа + + + +#### public getFiscalProviderId() : string + +```php +public getFiscalProviderId() : string +``` + +**Summary** + +Возвращает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Идентификатор чека в онлайн-кассе + + + +#### public getFiscalStorageNumber() : string + +```php +public getFiscalStorageNumber() : string +``` + +**Summary** + +Возвращает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального накопителя в кассовом аппарате + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор чека в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] + +```php +public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +``` + +**Summary** + +Возвращает список товаров в заказ + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает идентификатор платежа или возврата, для которого был сформирован чек. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + + + +#### public getOnBehalfOf() : string|null + +```php +public getOnBehalfOf() : string|null +``` + +**Summary** + +Возвращает идентификатор магазин + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getRefundId() : string + +```php +public getRefundId() : string +``` + +**Summary** + +Возвращает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\RefundReceiptResponse](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getRegisteredAt() : \DateTime + +```php +public getRegisteredAt() : \DateTime +``` + +**Summary** + +Возвращает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \DateTime - Дата и время формирования чека в фискальном накопителе + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает Массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус доставки данных для чека в онлайн-кассу + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** int - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setFiscalAttribute() : mixed + +```php +public setFiscalAttribute(string fiscal_attribute) : mixed +``` + +**Summary** + +Устанавливает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_attribute | Фискальный признак чека | + +**Returns:** mixed - + + + +#### public setFiscalDocumentNumber() : mixed + +```php +public setFiscalDocumentNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер фискального документа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setFiscalProviderId() : mixed + +```php +public setFiscalProviderId(string fiscal_provider_id) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_provider_id | Идентификатор чека в онлайн-кассе | + +**Returns:** mixed - + + + +#### public setFiscalStorageNumber() : mixed + +```php +public setFiscalStorageNumber(string fiscal_storage_number) : mixed +``` + +**Summary** + +Устанавливает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_storage_number | Номер фискального накопителя в кассовом аппарате | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 40 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setItems() : mixed + +```php +public setItems(\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список позиций в чеке + +**Description** + +Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком +позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс +ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] | value | Список товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передали пустой массив значений | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения был передан не массив и не итератор, лабо если одно из переданных значений не реализует интерфейс ReceiptItemInterface | + +**Returns:** mixed - + + + +#### public setObjectId() : mixed + +```php +public setObjectId( value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа или возврата, для которого был сформирован чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public setOnBehalfOf() : mixed + +```php +public setOnBehalfOf(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор магазина, от имени которого нужно отправить чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина, от имени которого нужно отправить чек | + +**Returns:** mixed - + + + +#### public setRefundId() : mixed + +```php +public setRefundId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор возврата в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\RefundReceiptResponse](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | идентификатор возврата в ЮKassa | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 | + +**Returns:** mixed - + + + +#### public setRegisteredAt() : mixed + +```php +public setRegisteredAt(\DateTime registered_at) : mixed +``` + +**Summary** + +Устанавливает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | registered_at | Дата и время формирования чека в фискальном накопителе | + +**Returns:** mixed - + + + +#### public setSettlements() : mixed + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] | value | | + +**Returns:** mixed - + + + +#### public setSpecificProperties() : void + +```php +public setSpecificProperties(array receiptData) : void +``` + +**Summary** + +Установка свойств, присущих конкретному объекту + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\RefundReceiptResponse](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | receiptData | | + +**Returns:** void - + + + +#### public setStatus() : \YooKassa\Request\Receipts\AbstractReceiptResponse + +```php +public setStatus(string value) : \YooKassa\Request\Receipts\AbstractReceiptResponse +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse - + + + +#### public setTaxSystemCode() : mixed + +```php +public setTaxSystemCode(int value) : mixed +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданный аргумент меньше одного или больше шести | + +**Returns:** mixed - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает типа чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным типом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md b/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md new file mode 100644 index 00000000..c5fab1d0 --- /dev/null +++ b/docs/classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md @@ -0,0 +1,1301 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Receipts\SimpleReceiptResponse +### Namespace: [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +--- +**Summary:** + +Класс описывающий чек, не привязанный ни к платежу ни к возврату + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [LENGTH_RECEIPT_ID](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#constant_LENGTH_RECEIPT_ID) | | Длина идентификатора чека | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$fiscal_attribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_attribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscal_document_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_document_number) | | Номер фискального документа. | +| public | [$fiscal_provider_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_provider_id) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscal_storage_number](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscal_storage_number) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$fiscalAttribute](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalAttribute) | | Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. | +| public | [$fiscalDocumentNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalDocumentNumber) | | Номер фискального документа. | +| public | [$fiscalProviderId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalProviderId) | | Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. | +| public | [$fiscalStorageNumber](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_fiscalStorageNumber) | | Номер фискального накопителя в кассовом аппарате. | +| public | [$id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_id) | | Идентификатор чека в ЮKassa. | +| public | [$items](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_items) | | Список товаров в заказе | +| public | [$object_id](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_object_id) | | Идентификатор объекта чека. | +| public | [$objectId](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_objectId) | | Идентификатор объекта чека. | +| public | [$on_behalf_of](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_on_behalf_of) | | Идентификатор магазина | +| public | [$onBehalfOf](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_onBehalfOf) | | Идентификатор магазина | +| public | [$registered_at](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registered_at) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$registeredAt](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_registeredAt) | | Дата и время формирования чека в фискальном накопителе. | +| public | [$settlements](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_settlements) | | Перечень совершенных расчетов. | +| public | [$status](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_status) | | Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). | +| public | [$tax_system_code](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_tax_system_code) | | Код системы налогообложения. Число 1-6. | +| public | [$taxSystemCode](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_taxSystemCode) | | Код системы налогообложения. Число 1-6. | +| public | [$type](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#property_type) | | Тип чека в онлайн-кассе: приход "payment" или возврат "refund". | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [addItem()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addItem) | | Добавляет товар в чек | +| public | [addSettlement()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_addSettlement) | | Добавляет оплату в массив | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalAttribute) | | Возвращает фискальный признак чека | +| public | [getFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalDocumentNumber) | | Возвращает номер фискального документа | +| public | [getFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalProviderId) | | Возвращает идентификатор чека в онлайн-кассе | +| public | [getFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getFiscalStorageNumber) | | Возвращает номер фискального накопителя в кассовом аппарате | +| public | [getId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getId) | | Возвращает идентификатор чека в ЮKassa | +| public | [getItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getItems) | | Возвращает список товаров в заказ | +| public | [getObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getObjectId) | | Возвращает идентификатор платежа или возврата, для которого был сформирован чек. | +| public | [getOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getOnBehalfOf) | | Возвращает идентификатор магазин | +| public | [getRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getRegisteredAt) | | Возвращает дату и время формирования чека в фискальном накопителе | +| public | [getSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getSettlements) | | Возвращает Массив оплат, обеспечивающих выдачу товара | +| public | [getStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getStatus) | | Возвращает статус доставки данных для чека в онлайн-кассу | +| public | [getTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getTaxSystemCode) | | Возвращает код системы налогообложения | +| public | [getType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_getType) | | Возвращает тип чека в онлайн-кассе | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [notEmpty()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_notEmpty) | | Проверяет есть ли в чеке хотя бы одна позиция | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setFiscalAttribute()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalAttribute) | | Устанавливает фискальный признак чека | +| public | [setFiscalDocumentNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalDocumentNumber) | | Устанавливает номер фискального документа | +| public | [setFiscalProviderId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalProviderId) | | Устанавливает идентификатор чека в онлайн-кассе | +| public | [setFiscalStorageNumber()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setFiscalStorageNumber) | | Устанавливает номер фискального накопителя в кассовом аппарате | +| public | [setId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setId) | | Устанавливает идентификатор чека | +| public | [setItems()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setItems) | | Устанавливает список позиций в чеке | +| public | [setObjectId()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setObjectId) | | Устанавливает идентификатор платежа или возврата, для которого был сформирован чек | +| public | [setOnBehalfOf()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setOnBehalfOf) | | Возвращает идентификатор магазина, от имени которого нужно отправить чек | +| public | [setRegisteredAt()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setRegisteredAt) | | Устанавливает дату и время формирования чека в фискальном накопителе | +| public | [setSettlements()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setSettlements) | | Устанавливает массив оплат, обеспечивающих выдачу товара | +| public | [setSpecificProperties()](../classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md#method_setSpecificProperties) | | Установка свойств, присущих конкретному объекту | +| public | [setStatus()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setStatus) | | Устанавливает состояние регистрации фискального чека | +| public | [setTaxSystemCode()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения | +| public | [setType()](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md#method_setType) | | Устанавливает типа чека | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Receipts/SimpleReceiptResponse.php](../../lib/Request/Receipts/SimpleReceiptResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + * \YooKassa\Request\Receipts\SimpleReceiptResponse +--- +## Constants + +###### LENGTH_RECEIPT_ID +Inherited from [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +Длина идентификатора чека + +```php +LENGTH_RECEIPT_ID = 39 +``` + + +--- +## Properties + +#### public $fiscal_attribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_document_number : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_provider_id : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscal_storage_number : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalAttribute : string +--- +***Description*** + +Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalDocumentNumber : string +--- +***Description*** + +Номер фискального документа. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalProviderId : string +--- +***Description*** + +Идентификатор чека в онлайн-кассе. Присутствует, если чек удалось зарегистрировать. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $fiscalStorageNumber : string +--- +***Description*** + +Номер фискального накопителя в кассовом аппарате. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор чека в ЮKassa. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $items : \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +--- +***Description*** + +Список товаров в заказе + +**Type:** ReceiptResponseItemInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $object_id : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $objectId : string +--- +***Description*** + +Идентификатор объекта чека. + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $on_behalf_of : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $onBehalfOf : string +--- +***Description*** + +Идентификатор магазина + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $registered_at : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $registeredAt : \DateTime +--- +***Description*** + +Дата и время формирования чека в фискальном накопителе. + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $settlements : \YooKassa\Model\SettlementInterface[] +--- +***Description*** + +Перечень совершенных расчетов. + +**Type:** SettlementInterface[] + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $status : string +--- +***Description*** + +Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $tax_system_code : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $taxSystemCode : int +--- +***Description*** + +Код системы налогообложения. Число 1-6. + +**Type:** int + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +#### public $type : string +--- +***Description*** + +Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public addItem() : mixed + +```php +public addItem(\YooKassa\Request\Receipts\ReceiptResponseItemInterface value) : mixed +``` + +**Summary** + +Добавляет товар в чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface | value | Объект добавляемой в чек позиции | + +**Returns:** mixed - + + + +#### public addSettlement() : mixed + +```php +public addSettlement(\YooKassa\Model\SettlementInterface value) : mixed +``` + +**Summary** + +Добавляет оплату в массив + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface | value | | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getFiscalAttribute() : string + +```php +public getFiscalAttribute() : string +``` + +**Summary** + +Возвращает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Фискальный признак чека + + + +#### public getFiscalDocumentNumber() : string + +```php +public getFiscalDocumentNumber() : string +``` + +**Summary** + +Возвращает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального документа + + + +#### public getFiscalProviderId() : string + +```php +public getFiscalProviderId() : string +``` + +**Summary** + +Возвращает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Идентификатор чека в онлайн-кассе + + + +#### public getFiscalStorageNumber() : string + +```php +public getFiscalStorageNumber() : string +``` + +**Summary** + +Возвращает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - Номер фискального накопителя в кассовом аппарате + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор чека в ЮKassa + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] + +```php +public getItems() : \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] +``` + +**Summary** + +Возвращает список товаров в заказ + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Request\Receipts\ReceiptResponseItem[]|\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getObjectId() : string + +```php +public getObjectId() : string +``` + +**Summary** + +Возвращает идентификатор платежа или возврата, для которого был сформирован чек. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + + + +#### public getOnBehalfOf() : string|null + +```php +public getOnBehalfOf() : string|null +``` + +**Summary** + +Возвращает идентификатор магазин + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string|null - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getRegisteredAt() : \DateTime + +```php +public getRegisteredAt() : \DateTime +``` + +**Summary** + +Возвращает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \DateTime - Дата и время формирования чека в фискальном накопителе + + + +#### public getSettlements() : \YooKassa\Model\SettlementInterface[] + +```php +public getSettlements() : \YooKassa\Model\SettlementInterface[] +``` + +**Summary** + +Возвращает Массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** \YooKassa\Model\SettlementInterface[] - + + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус доставки данных для чека в онлайн-кассу + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getTaxSystemCode() : int + +```php +public getTaxSystemCode() : int +``` + +**Summary** + +Возвращает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** int - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** string - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public notEmpty() : bool + +```php +public notEmpty() : bool +``` + +**Summary** + +Проверяет есть ли в чеке хотя бы одна позиция + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) + +**Returns:** bool - True если чек не пуст, false если в чеке нет ни одной позиции + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setFiscalAttribute() : mixed + +```php +public setFiscalAttribute(string fiscal_attribute) : mixed +``` + +**Summary** + +Устанавливает фискальный признак чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_attribute | Фискальный признак чека | + +**Returns:** mixed - + + + +#### public setFiscalDocumentNumber() : mixed + +```php +public setFiscalDocumentNumber(string value) : mixed +``` + +**Summary** + +Устанавливает номер фискального документа + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Номер фискального документа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** mixed - + + + +#### public setFiscalProviderId() : mixed + +```php +public setFiscalProviderId(string fiscal_provider_id) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека в онлайн-кассе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_provider_id | Идентификатор чека в онлайн-кассе | + +**Returns:** mixed - + + + +#### public setFiscalStorageNumber() : mixed + +```php +public setFiscalStorageNumber(string fiscal_storage_number) : mixed +``` + +**Summary** + +Устанавливает номер фискального накопителя в кассовом аппарате + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | fiscal_storage_number | Номер фискального накопителя в кассовом аппарате | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 40 | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setItems() : mixed + +```php +public setItems(\YooKassa\Request\Receipts\ReceiptResponseItemInterface[] value) : mixed +``` + +**Summary** + +Устанавливает список позиций в чеке + +**Description** + +Если до этого в чеке уже были установлены значения, они удаляются и полностью заменяются переданным списком +позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс +ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Receipts\ReceiptResponseItemInterface[] | value | Список товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передали пустой массив значений | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения был передан не массив и не итератор, лабо если одно из переданных значений не реализует интерфейс ReceiptItemInterface | + +**Returns:** mixed - + + + +#### public setObjectId() : mixed + +```php +public setObjectId( value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа или возврата, для которого был сформирован чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| | value | | + +**Returns:** mixed - + + + +#### public setOnBehalfOf() : mixed + +```php +public setOnBehalfOf(string value) : mixed +``` + +**Summary** + +Возвращает идентификатор магазина, от имени которого нужно отправить чек + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор магазина, от имени которого нужно отправить чек | + +**Returns:** mixed - + + + +#### public setRegisteredAt() : mixed + +```php +public setRegisteredAt(\DateTime registered_at) : mixed +``` + +**Summary** + +Устанавливает дату и время формирования чека в фискальном накопителе + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | registered_at | Дата и время формирования чека в фискальном накопителе | + +**Returns:** mixed - + + + +#### public setSettlements() : mixed + +```php +public setSettlements(\YooKassa\Model\SettlementInterface[] value) : mixed +``` + +**Summary** + +Устанавливает массив оплат, обеспечивающих выдачу товара + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SettlementInterface[] | value | | + +**Returns:** mixed - + + + +#### public setSpecificProperties() : void + +```php +public setSpecificProperties(array receiptData) : void +``` + +**Summary** + +Установка свойств, присущих конкретному объекту + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\SimpleReceiptResponse](../classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | receiptData | | + +**Returns:** void - + + + +#### public setStatus() : \YooKassa\Request\Receipts\AbstractReceiptResponse + +```php +public setStatus(string value) : \YooKassa\Request\Receipts\AbstractReceiptResponse +``` + +**Summary** + +Устанавливает состояние регистрации фискального чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Состояние регистрации фискального чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное состояние регистрации не существует | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент не строка | + +**Returns:** \YooKassa\Request\Receipts\AbstractReceiptResponse - + + + +#### public setTaxSystemCode() : mixed + +```php +public setTaxSystemCode(int value) : mixed +``` + +**Summary** + +Устанавливает код системы налогообложения + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6 | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если переданный аргумент - не число | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданный аргумент меньше одного или больше шести | + +**Returns:** mixed - + + + +#### public setType() : mixed + +```php +public setType(string value) : mixed +``` + +**Summary** + +Устанавливает типа чека + +**Details:** +* Inherited From: [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Тип чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная строка не является валидным типом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md b/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md new file mode 100644 index 00000000..323ad07e --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-AbstractRefundResponse.md @@ -0,0 +1,876 @@ +# [YooKassa API SDK](../home.md) + +# Abstract Class: \YooKassa\Request\Refunds\AbstractRefundResponse +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Абстрактный класс ответа от API с информацией о возврате + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Refund.md#property_amount) | | Сумма возврата | +| public | [$created_at](../classes/YooKassa-Model-Refund.md#property_created_at) | | Время создания возврата | +| public | [$createdAt](../classes/YooKassa-Model-Refund.md#property_createdAt) | | Время создания возврата | +| public | [$description](../classes/YooKassa-Model-Refund.md#property_description) | | Комментарий, основание для возврата средств покупателю | +| public | [$id](../classes/YooKassa-Model-Refund.md#property_id) | | Идентификатор возврата платежа | +| public | [$payment_id](../classes/YooKassa-Model-Refund.md#property_payment_id) | | Идентификатор платежа | +| public | [$paymentId](../classes/YooKassa-Model-Refund.md#property_paymentId) | | Идентификатор платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Refund.md#property_receipt_registration) | | Статус регистрации чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Refund.md#property_receiptRegistration) | | Статус регистрации чека | +| public | [$status](../classes/YooKassa-Model-Refund.md#property_status) | | Статус возврата | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Refunds-AbstractRefundResponse.md#method___construct) | | Конструктор | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Refund.md#method_getAmount) | | Возвращает сумму возврата | +| public | [getCreatedAt()](../classes/YooKassa-Model-Refund.md#method_getCreatedAt) | | Возвращает дату создания возврата | +| public | [getDescription()](../classes/YooKassa-Model-Refund.md#method_getDescription) | | Возвращает комментарий к возврату | +| public | [getId()](../classes/YooKassa-Model-Refund.md#method_getId) | | Возвращает идентификатор возврата платежа | +| public | [getPaymentId()](../classes/YooKassa-Model-Refund.md#method_getPaymentId) | | Возвращает идентификатор платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_getReceiptRegistration) | | Возвращает статус регистрации чека | +| public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | | Возвращает инициатора платежа или возврата | +| public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | +| public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | +| public | [setDescription()](../classes/YooKassa-Model-Refund.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setId()](../classes/YooKassa-Model-Refund.md#method_setId) | | Устанавливает идентификатор возврата | +| public | [setPaymentId()](../classes/YooKassa-Model-Refund.md#method_setPaymentId) | | Устанавливает идентификатор платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_setReceiptRegistration) | | Устанавливает статус регистрации чека | +| public | [setRequestor()](../classes/YooKassa-Model-Refund.md#method_setRequestor) | | Устанавливает инициатора платежа или возврата | +| public | [setSources()](../classes/YooKassa-Model-Refund.md#method_setSources) | | Устанавливает sources (массив распределения денег между магазинами) | +| public | [setStatus()](../classes/YooKassa-Model-Refund.md#method_setStatus) | | Усианавливает стутус возврата платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Refunds/AbstractRefundResponse.php](../../lib/Request/Refunds/AbstractRefundResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + * \YooKassa\Request\Refunds\AbstractRefundResponse +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $description : string +--- +***Description*** + +Комментарий, основание для возврата средств покупателю + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор возврата платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $payment_id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $status : string +--- +***Description*** + +Статус возврата + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array options) : mixed +``` + +**Summary** + +Конструктор + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\AbstractRefundResponse](../classes/YooKassa-Request-Refunds-AbstractRefundResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | options | Ассоциативный массив с информацией, вернувшейся от API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает дату создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \DateTime - Время создания возврата + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Комментарий, основание для возврата средств покупателю + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус регистрации чека + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\RequestorInterface - Инициатор платежа или возврата + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус текущего возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус возврата + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная сумма меньше или равна нулю | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime value) : mixed +``` + +**Summary** + +Устанавливает вермя создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Время создания возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если быо передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданную строку или число не удалось интерпретировать как дату и время | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если было передано значение невалидного типа | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий, основание для возврата средств покупателю | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус регистрации чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | Инициатор платежа или возврата | + +**Returns:** mixed - + + + +#### public setSources() : mixed + +```php +public setSources(\YooKassa\Model\SourceInterface[]|array value) : mixed +``` + +**Summary** + +Устанавливает sources (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Усианавливает стутус возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус возврата платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md new file mode 100644 index 00000000..03a57903 --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequest.md @@ -0,0 +1,942 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\CreateRefundRequest +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс объекта запроса для создания возврата + +--- +### Examples +Пример использования билдера + +```php +// Создание запроса возврата через билдер +try { + $refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder(); + $refundBuilder + ->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f') + ->setAmount(3500.00) + ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) + ->setDescription('Не подошел цвет') + ->setReceiptItems(array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ), + )) + ->setReceiptEmail('john.doe@merchant.com') + ->setTaxSystemCode(1); + + // Создаем объект запроса + $request = $refundBuilder->build(); + + // Можно изменить данные, если нужно + $request->setDescription('Не подошел цвет и размер'); + + $idempotenceKey = uniqid('', true); + $response = $client->createRefund($request, $idempotenceKey); +} catch (Exception $e) { + $response = $e; +} + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_amount) | | Сумма возврата | +| public | [$amount](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_amount) | | Сумма | +| public | [$description](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_description) | | Комментарий к операции возврата, основание для возврата средств покупателю. | +| public | [$paymentId](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_paymentId) | | Айди платежа для которого создаётся возврат | +| public | [$receipt](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_receipt) | | Инстанс чека или null | +| public | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_receipt) | | Данные фискального чека 54-ФЗ | +| public | [$sources](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#property_sources) | | Информация о распределении денег — сколько и в какой магазин нужно перевести | +| public | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequest.md#property_transfers) | | Данные о распределении платежа между магазинами | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_builder) | | Возвращает билдер объектов текущего типа | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getAmount) | | Возвращает сумму оплаты | +| public | [getDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getDescription) | | Возвращает комментарий к возврату или null, если комментарий не задан | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getPaymentId) | | Возвращает идентификатор платежа для которого создаётся возврат средств | +| public | [getReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getReceipt) | | Возвращает чек, если он есть | +| public | [getSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [getTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_getTransfers) | | Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. | +| public | [hasAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasAmount) | | Проверяет была ли установлена сумма оплаты | +| public | [hasDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasDescription) | | Проверяет задан ли комментарий к создаваемому возврату | +| public | [hasReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasReceipt) | | Проверяет наличие чека | +| public | [hasSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_hasSources) | | Проверяет наличие информации о распределении денег | +| public | [hasTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_hasTransfers) | | Проверяет наличие данных о распределении денег | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [removeReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_removeReceipt) | | Удаляет чек из запроса | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setAmount) | | Устанавливает сумму оплаты | +| public | [setDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа для которого создаётся возврат | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setReceipt) | | Устанавливает чек | +| public | [setSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_setSources) | | Устанавливает sources (массив распределения денег между магазинами) | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequest.md#method_setTransfers) | | Устанавливает transfers (массив распределения денег между магазинами) | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md#method_validate) | | Валидирует текущий объект запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Refunds/CreateRefundRequest.php](../../lib/Request/Refunds/CreateRefundRequest.php) +* Package: Default +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + * \YooKassa\Request\Refunds\CreateRefundRequest +* Implements: + * [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** + + + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +#### public $description : string +--- +***Description*** + +Комментарий к операции возврата, основание для возврата средств покупателю. + +**Type:** string + +**Details:** + + + +#### public $paymentId : string +--- +***Description*** + +Айди платежа для которого создаётся возврат + +**Type:** string + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface|null +--- +***Description*** + +Инстанс чека или null + +**Type:** ReceiptInterface|null + +**Details:** + + + +#### public $receipt : \YooKassa\Model\ReceiptInterface +--- +***Description*** + +Данные фискального чека 54-ФЗ + +**Type:** ReceiptInterface + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +#### public $sources : \YooKassa\Model\SourceInterface[]|null +--- +***Description*** + +Информация о распределении денег — сколько и в какой магазин нужно перевести + +**Type:** SourceInterface[]|null + +**Details:** + + + +#### public $transfers : \YooKassa\Model\TransferInterface[] +--- +***Description*** + +Данные о распределении платежа между магазинами + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder +``` + +**Summary** + +Возвращает билдер объектов текущего типа + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс билдера запрсов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма оплаты + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату или null, если комментарий не задан + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** string - Комментарий к операции возврата, основание для возврата средств покупателю. + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа для которого создаётся возврат средств + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** string - Идентификатор платежа для которого создаётся возврат + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает чек, если он есть + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Данные фискального чека 54-ФЗ или null если чека нет + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - Информация о распределении денег + + + +#### public getTransfers() : \YooKassa\Model\TransferInterface[] + +```php +public getTransfers() : \YooKassa\Model\TransferInterface[] +``` + +**Summary** + +Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + +**Description** + +Присутствует, если вы используете решение ЮKassa для платформ. +(https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** \YooKassa\Model\TransferInterface[] - Данные о распределении денег + + + +#### public hasAmount() : bool + +```php +public hasAmount() : bool +``` + +**Summary** + +Проверяет была ли установлена сумма оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если сумма оплаты была установлена, false если нет + + + +#### public hasDescription() : bool + +```php +public hasDescription() : bool +``` + +**Summary** + +Проверяет задан ли комментарий к создаваемому возврату + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** bool - True если комментарий установлен, false если нет + + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет наличие чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - True если чек есть, false если нет + + + +#### public hasSources() : bool + +```php +public hasSources() : bool +``` + +**Summary** + +Проверяет наличие информации о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** bool - + + + +#### public hasTransfers() : bool + +```php +public hasTransfers() : bool +``` + +**Summary** + +Проверяет наличие данных о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** bool - + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public removeReceipt() : mixed + +```php +public removeReceipt() : mixed +``` + +**Summary** + +Удаляет чек из запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму оплаты + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма оплаты | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий к операции возврата, основание для возврата средств покупателю | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если была передана не строка | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа для которого создаётся возврат + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение идентификатора платежа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение является строкой, но не является валидным значением идентификатора платежа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передано значение не валидного типа | + +**Returns:** mixed - + + + +#### public setReceipt() : mixed + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|null value) : mixed +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передан не инстанс класса чека и не null | + +**Returns:** mixed - + + + +#### public setSources() : mixed + +```php +public setSources(\YooKassa\Model\SourceInterface[]|array value) : mixed +``` + +**Summary** + +Устанавливает sources (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] OR array | value | Массив распределения денег между магазинами | + +**Returns:** mixed - + + + +#### public setTransfers() : mixed + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : mixed +``` + +**Summary** + +Устанавливает transfers (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Валидирует текущий объект запроса + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) + +**Returns:** bool - True если текущий объект запроса валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md new file mode 100644 index 00000000..4b47421d --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md @@ -0,0 +1,557 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\CreateRefundRequestBuilder +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс билдера запросов к API на создание возврата средств + +--- +### Examples +Пример использования билдера + +```php +// Создание запроса возврата через билдер +try { + $refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder(); + $refundBuilder + ->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f') + ->setAmount(3500.00) + ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) + ->setDescription('Не подошел цвет') + ->setReceiptItems(array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ), + )) + ->setReceiptEmail('john.doe@merchant.com') + ->setTaxSystemCode(1); + + // Создаем объект запроса + $request = $refundBuilder->build(); + + // Можно изменить данные, если нужно + $request->setDescription('Не подошел цвет и размер'); + + $idempotenceKey = uniqid('', true); + $response = $client->createRefund($request, $idempotenceKey); +} catch (Exception $e) { + $response = $e; +} + +``` +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$amount](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_amount) | | Сумма | +| protected | [$currentObject](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md#property_currentObject) | | Собираемый объет запроса к API | +| protected | [$receipt](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_receipt) | | Объект с информацией о чеке | +| protected | [$transfers](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#property_transfers) | | Массив платежей в пользу разных мерчантов | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [addReceiptItem()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptItem) | | Добавляет в чек товар | +| public | [addReceiptShipping()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_addReceiptShipping) | | Добавляет в чек доставку товара | +| public | [build()](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md#method_build) | | Строит объект запроса к API | +| public | [setAmount()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setAmount) | | Устанавливает сумму | +| public | [setCurrency()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setCurrency) | | Устанавливает валюту в которой будет происходить подтверждение оплаты заказа | +| public | [setDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md#method_setPaymentId) | | Устанавливает айди платежа для которого создаётся возврат | +| public | [setReceipt()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceipt) | | Устанавливает чек | +| public | [setReceiptEmail()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptEmail) | | Устанавливает адрес электронной почты получателя чека | +| public | [setReceiptItems()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptItems) | | Устанавлвиает список товаров для создания чека | +| public | [setReceiptPhone()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setReceiptPhone) | | Устанавливает телефон получателя чека | +| public | [setSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md#method_setSources) | | Устанавливает источники возврата | +| public | [setTaxSystemCode()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTaxSystemCode) | | Устанавливает код системы налогообложения. | +| public | [setTransfers()](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md#method_setTransfers) | | Устанавливает трансферы | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md#method_initCurrentObject) | | Возвращает новый объект для сборки | +--- +### Details +* File: [lib/Request/Refunds/CreateRefundRequestBuilder.php](../../lib/Request/Refunds/CreateRefundRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + * \YooKassa\Request\Refunds\CreateRefundRequestBuilder +--- +## Properties + +#### protected $amount : \YooKassa\Model\MonetaryAmount +--- +**Summary** + +Сумма + +**Type:** MonetaryAmount + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +#### protected $currentObject : \YooKassa\Request\Refunds\CreateRefundRequest +--- +**Summary** + +Собираемый объет запроса к API + +**Type:** CreateRefundRequest + +**Details:** + + + +#### protected $receipt : \YooKassa\Model\Receipt +--- +**Summary** + +Объект с информацией о чеке + +**Type:** Receipt + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +#### protected $transfers : \YooKassa\Model\TransferInterface[] +--- +**Summary** + +Массив платежей в пользу разных мерчантов + +**Type:** TransferInterface[] + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public addReceiptItem() : self + +```php +public addReceiptItem(string title, string price, float quantity, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек товар + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название или описание товара | +| string | price | Цена товара в валюте, заданной в заказе | +| float | quantity | Количество товара | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public addReceiptShipping() : self + +```php +public addReceiptShipping(string title, string price, int vatCode, null|string paymentMode = null, null|string paymentSubject = null) : self +``` + +**Summary** + +Добавляет в чек доставку товара + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +* See Also: + * [](\YooKassa\Model\Receipt\PaymentSubject::class) + * [](\YooKassa\Model\Receipt\PaymentMode::class) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | title | Название доставки в чеке | +| string | price | Стоимость доставки | +| int | vatCode | Ставка НДС | +| null OR string | paymentMode | значение перечисления PaymentMode | +| null OR string | paymentSubject | значение перечисления PaymentSubject | + +**Returns:** self - Инстанс билдера запросов + + + +#### public build() : \YooKassa\Request\Refunds\CreateRefundRequestInterface|\YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Request\Refunds\CreateRefundRequestInterface|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Строит объект запроса к API + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestBuilder](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Устаналвиваемые параметры запроса | + +**Returns:** \YooKassa\Request\Refunds\CreateRefundRequestInterface|\YooKassa\Common\AbstractRequest - Инстанс сгенерированного объекта запроса к API + + + +#### public setAmount() : self + +```php +public setAmount(\YooKassa\Model\AmountInterface|array|string value) : self +``` + +**Summary** + +Устанавливает сумму + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface OR array OR string | value | Сумма оплаты | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setCurrency() : self + +```php +public setCurrency(string value) : self +``` + +**Summary** + +Устанавливает валюту в которой будет происходить подтверждение оплаты заказа + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Валюта в которой подтверждается оплата | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setDescription() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder + +```php +public setDescription(string value) : \YooKassa\Request\Refunds\CreateRefundRequestBuilder +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestBuilder](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий к возврату | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если была передана не строка | + +**Returns:** \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс текущего билдера + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setPaymentId() : \YooKassa\Request\Refunds\CreateRefundRequestBuilder + +```php +public setPaymentId(string value) : \YooKassa\Request\Refunds\CreateRefundRequestBuilder +``` + +**Summary** + +Устанавливает айди платежа для которого создаётся возврат + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestBuilder](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Айди платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если передано пустое значение айди платежа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение является строкой, но не является валидным значением айди платежа | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если передано значение не валидного типа | + +**Returns:** \YooKassa\Request\Refunds\CreateRefundRequestBuilder - Инстанс текущего билдера + + + +#### public setReceipt() : self + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|array value) : self +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR array | value | Инстанс чека или ассоциативный массив с данными чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Генерируется если было передано значение невалидного типа | + +**Returns:** self - + + + +#### public setReceiptEmail() : self + +```php +public setReceiptEmail(string value) : self +``` + +**Summary** + +Устанавливает адрес электронной почты получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Email получателя чека | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptItems() : self + +```php +public setReceiptItems(array value) : self +``` + +**Summary** + +Устанавлвиает список товаров для создания чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | value | Массив товаров в заказе | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если хотя бы один из товаров имеет неверную структуру | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setReceiptPhone() : self + +```php +public setReceiptPhone(string value) : self +``` + +**Summary** + +Устанавливает телефон получателя чека + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Телефон получателя чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в качестве значения была передана не строка | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setSources() : self + +```php +public setSources(\YooKassa\Model\SourceInterface[]|array value) : self +``` + +**Summary** + +Устанавливает источники возврата + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestBuilder](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] OR array | value | Массив трансферов | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTaxSystemCode() : self + +```php +public setTaxSystemCode(int value) : self +``` + +**Summary** + +Устанавливает код системы налогообложения. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int | value | Код системы налогообложения. Число 1-6. | + +**Returns:** self - Инстанс билдера запросов + + + +#### public setTransfers() : self + +```php +public setTransfers(\YooKassa\Model\TransferInterface[]|array|null value) : self +``` + +**Summary** + +Устанавливает трансферы + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\TransferInterface[] OR array OR null | value | Массив трансферов | + +**Returns:** self - Инстанс билдера запросов + + + +#### protected initCurrentObject() : \YooKassa\Request\Refunds\CreateRefundRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Refunds\CreateRefundRequest +``` + +**Summary** + +Возвращает новый объект для сборки + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestBuilder](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md) + +**Returns:** \YooKassa\Request\Refunds\CreateRefundRequest - Собираемый объет запроса к API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md new file mode 100644 index 00000000..ae9892c3 --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md @@ -0,0 +1,261 @@ +# [YooKassa API SDK](../home.md) + +# Interface: CreateRefundRequestInterface +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Интерфейс объекта запроса на возврат + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getAmount()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_getAmount) | | Возвращает сумму возвращаемых средств | +| public | [getDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_getDescription) | | Возвращает комментарий к возврату или null, если комментарий не задан | +| public | [getPaymentId()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_getPaymentId) | | Возвращает айди платежа для которого создаётся возврат средств | +| public | [getReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_getReceipt) | | Возвращает инстанс чека или null если чек не задан | +| public | [getSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [hasDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_hasDescription) | | Проверяет задан ли комментарий к создаваемому возврату | +| public | [hasReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_hasReceipt) | | Проверяет задан ли чек | +| public | [hasSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_hasSources) | | Проверяет наличие информации о распределении денег | +| public | [setDescription()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setReceipt()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_setReceipt) | | Устанавливает чек | +| public | [setSources()](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md#method_setSources) | | Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести | + +--- +### Details +* File: [lib/Request/Refunds/CreateRefundRequestInterface.php](../../lib/Request/Refunds/CreateRefundRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Айди платежа для которого создаётся возврат | +| property-read | | Сумма возврата | +| property-read | | Комментарий к операции возврата, основание для возврата средств покупателю. | +| property-read | | Инстанс чека или null | +--- +## Methods + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает айди платежа для которого создаётся возврат средств + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** string - Айди платежа для которого создаётся возврат + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возвращаемых средств + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий к операции возврата, основание для возврата средств покупателю | + +**Returns:** mixed - + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату или null, если комментарий не задан + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** string - Комментарий к операции возврата, основание для возврата средств покупателю. + + + +#### public hasDescription() : bool + +```php +public hasDescription() : bool +``` + +**Summary** + +Проверяет задан ли комментарий к создаваемому возврату + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** bool - True если комментарий установлен, false если нет + + + +#### public setReceipt() : mixed + +```php +public setReceipt(\YooKassa\Model\ReceiptInterface|null value) : mixed +``` + +**Summary** + +Устанавливает чек + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\ReceiptInterface OR null | value | Инстанс чека или null для удаления информации о чеке | + +**Returns:** mixed - + + + +#### public getReceipt() : \YooKassa\Model\ReceiptInterface|null + +```php +public getReceipt() : \YooKassa\Model\ReceiptInterface|null +``` + +**Summary** + +Возвращает инстанс чека или null если чек не задан + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** \YooKassa\Model\ReceiptInterface|null - Инстанс чека или null + + + +#### public hasReceipt() : bool + +```php +public hasReceipt() : bool +``` + +**Summary** + +Проверяет задан ли чек + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** bool - True если чек есть, false если нет + + + +#### public setSources() : mixed + +```php +public setSources(\YooKassa\Model\SourceInterface[] value) : mixed +``` + +**Summary** + +Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] | value | Информация о распределении денег | + +**Returns:** mixed - + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - Информация о распределении денег + + + +#### public hasSources() : bool + +```php +public hasSources() : bool +``` + +**Summary** + +Проверяет наличие информации о распределении денег + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) + +**Returns:** bool - + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md new file mode 100644 index 00000000..4b4f7df0 --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\CreateRefundRequestSerializer +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс сериалайзера запросов к API на создание нового возврата средств + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md#method_serialize) | | Сериализует переданный объект запроса к API в массив | +--- +### Details +* File: [lib/Request/Refunds/CreateRefundRequestSerializer.php](../../lib/Request/Refunds/CreateRefundRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Refunds\CreateRefundRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Refunds\CreateRefundRequestInterface request) : array +``` + +**Summary** + +Сериализует переданный объект запроса к API в массив + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\CreateRefundRequestSerializer](../classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Refunds\CreateRefundRequestInterface | request | Сериализуемый объект запроса | + +**Returns:** array - Ассоциативный массив для передачи в API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md b/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md new file mode 100644 index 00000000..e513535a --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-CreateRefundResponse.md @@ -0,0 +1,873 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\CreateRefundResponse +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс объекта ответа от API при создании нового возврата + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Refund.md#property_amount) | | Сумма возврата | +| public | [$created_at](../classes/YooKassa-Model-Refund.md#property_created_at) | | Время создания возврата | +| public | [$createdAt](../classes/YooKassa-Model-Refund.md#property_createdAt) | | Время создания возврата | +| public | [$description](../classes/YooKassa-Model-Refund.md#property_description) | | Комментарий, основание для возврата средств покупателю | +| public | [$id](../classes/YooKassa-Model-Refund.md#property_id) | | Идентификатор возврата платежа | +| public | [$payment_id](../classes/YooKassa-Model-Refund.md#property_payment_id) | | Идентификатор платежа | +| public | [$paymentId](../classes/YooKassa-Model-Refund.md#property_paymentId) | | Идентификатор платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Refund.md#property_receipt_registration) | | Статус регистрации чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Refund.md#property_receiptRegistration) | | Статус регистрации чека | +| public | [$status](../classes/YooKassa-Model-Refund.md#property_status) | | Статус возврата | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Refund.md#method_getAmount) | | Возвращает сумму возврата | +| public | [getCreatedAt()](../classes/YooKassa-Model-Refund.md#method_getCreatedAt) | | Возвращает дату создания возврата | +| public | [getDescription()](../classes/YooKassa-Model-Refund.md#method_getDescription) | | Возвращает комментарий к возврату | +| public | [getId()](../classes/YooKassa-Model-Refund.md#method_getId) | | Возвращает идентификатор возврата платежа | +| public | [getPaymentId()](../classes/YooKassa-Model-Refund.md#method_getPaymentId) | | Возвращает идентификатор платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_getReceiptRegistration) | | Возвращает статус регистрации чека | +| public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | | Возвращает инициатора платежа или возврата | +| public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | +| public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | +| public | [setDescription()](../classes/YooKassa-Model-Refund.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setId()](../classes/YooKassa-Model-Refund.md#method_setId) | | Устанавливает идентификатор возврата | +| public | [setPaymentId()](../classes/YooKassa-Model-Refund.md#method_setPaymentId) | | Устанавливает идентификатор платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_setReceiptRegistration) | | Устанавливает статус регистрации чека | +| public | [setRequestor()](../classes/YooKassa-Model-Refund.md#method_setRequestor) | | Устанавливает инициатора платежа или возврата | +| public | [setSources()](../classes/YooKassa-Model-Refund.md#method_setSources) | | Устанавливает sources (массив распределения денег между магазинами) | +| public | [setStatus()](../classes/YooKassa-Model-Refund.md#method_setStatus) | | Усианавливает стутус возврата платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Refunds/CreateRefundResponse.php](../../lib/Request/Refunds/CreateRefundResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + * [\YooKassa\Request\Refunds\AbstractRefundResponse](../classes/YooKassa-Request-Refunds-AbstractRefundResponse.md) + * \YooKassa\Request\Refunds\CreateRefundResponse +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $description : string +--- +***Description*** + +Комментарий, основание для возврата средств покупателю + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор возврата платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $payment_id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $status : string +--- +***Description*** + +Статус возврата + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает дату создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \DateTime - Время создания возврата + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Комментарий, основание для возврата средств покупателю + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус регистрации чека + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\RequestorInterface - Инициатор платежа или возврата + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус текущего возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус возврата + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная сумма меньше или равна нулю | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime value) : mixed +``` + +**Summary** + +Устанавливает вермя создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Время создания возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если быо передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданную строку или число не удалось интерпретировать как дату и время | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если было передано значение невалидного типа | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий, основание для возврата средств покупателю | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус регистрации чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | Инициатор платежа или возврата | + +**Returns:** mixed - + + + +#### public setSources() : mixed + +```php +public setSources(\YooKassa\Model\SourceInterface[]|array value) : mixed +``` + +**Summary** + +Устанавливает sources (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Усианавливает стутус возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус возврата платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundResponse.md b/docs/classes/YooKassa-Request-Refunds-RefundResponse.md new file mode 100644 index 00000000..73aad92d --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-RefundResponse.md @@ -0,0 +1,873 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\RefundResponse +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс объекта ответа от API при запросе одного конкретного возврата + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$amount](../classes/YooKassa-Model-Refund.md#property_amount) | | Сумма возврата | +| public | [$created_at](../classes/YooKassa-Model-Refund.md#property_created_at) | | Время создания возврата | +| public | [$createdAt](../classes/YooKassa-Model-Refund.md#property_createdAt) | | Время создания возврата | +| public | [$description](../classes/YooKassa-Model-Refund.md#property_description) | | Комментарий, основание для возврата средств покупателю | +| public | [$id](../classes/YooKassa-Model-Refund.md#property_id) | | Идентификатор возврата платежа | +| public | [$payment_id](../classes/YooKassa-Model-Refund.md#property_payment_id) | | Идентификатор платежа | +| public | [$paymentId](../classes/YooKassa-Model-Refund.md#property_paymentId) | | Идентификатор платежа | +| public | [$receipt_registration](../classes/YooKassa-Model-Refund.md#property_receipt_registration) | | Статус регистрации чека | +| public | [$receiptRegistration](../classes/YooKassa-Model-Refund.md#property_receiptRegistration) | | Статус регистрации чека | +| public | [$status](../classes/YooKassa-Model-Refund.md#property_status) | | Статус возврата | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getAmount()](../classes/YooKassa-Model-Refund.md#method_getAmount) | | Возвращает сумму возврата | +| public | [getCreatedAt()](../classes/YooKassa-Model-Refund.md#method_getCreatedAt) | | Возвращает дату создания возврата | +| public | [getDescription()](../classes/YooKassa-Model-Refund.md#method_getDescription) | | Возвращает комментарий к возврату | +| public | [getId()](../classes/YooKassa-Model-Refund.md#method_getId) | | Возвращает идентификатор возврата платежа | +| public | [getPaymentId()](../classes/YooKassa-Model-Refund.md#method_getPaymentId) | | Возвращает идентификатор платежа | +| public | [getReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_getReceiptRegistration) | | Возвращает статус регистрации чека | +| public | [getRequestor()](../classes/YooKassa-Model-Refund.md#method_getRequestor) | | Возвращает инициатора платежа или возврата | +| public | [getSources()](../classes/YooKassa-Model-Refund.md#method_getSources) | | Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести | +| public | [getStatus()](../classes/YooKassa-Model-Refund.md#method_getStatus) | | Возвращает статус текущего возврата | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setAmount()](../classes/YooKassa-Model-Refund.md#method_setAmount) | | Устанавливает сумму возврата | +| public | [setCreatedAt()](../classes/YooKassa-Model-Refund.md#method_setCreatedAt) | | Устанавливает вермя создания возврата | +| public | [setDescription()](../classes/YooKassa-Model-Refund.md#method_setDescription) | | Устанавливает комментарий к возврату | +| public | [setId()](../classes/YooKassa-Model-Refund.md#method_setId) | | Устанавливает идентификатор возврата | +| public | [setPaymentId()](../classes/YooKassa-Model-Refund.md#method_setPaymentId) | | Устанавливает идентификатор платежа | +| public | [setReceiptRegistration()](../classes/YooKassa-Model-Refund.md#method_setReceiptRegistration) | | Устанавливает статус регистрации чека | +| public | [setRequestor()](../classes/YooKassa-Model-Refund.md#method_setRequestor) | | Устанавливает инициатора платежа или возврата | +| public | [setSources()](../classes/YooKassa-Model-Refund.md#method_setSources) | | Устанавливает sources (массив распределения денег между магазинами) | +| public | [setStatus()](../classes/YooKassa-Model-Refund.md#method_setStatus) | | Усианавливает стутус возврата платежа | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +--- +### Details +* File: [lib/Request/Refunds/RefundResponse.php](../../lib/Request/Refunds/RefundResponse.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + * [\YooKassa\Request\Refunds\AbstractRefundResponse](../classes/YooKassa-Request-Refunds-AbstractRefundResponse.md) + * \YooKassa\Request\Refunds\RefundResponse +--- +## Properties + +#### public $amount : \YooKassa\Model\AmountInterface +--- +***Description*** + +Сумма возврата + +**Type:** AmountInterface + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $created_at : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $createdAt : \DateTime +--- +***Description*** + +Время создания возврата + +**Type:** \DateTime + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $description : string +--- +***Description*** + +Комментарий, основание для возврата средств покупателю + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $id : string +--- +***Description*** + +Идентификатор возврата платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $payment_id : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $receipt_registration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $receiptRegistration : string +--- +***Description*** + +Статус регистрации чека + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +#### public $status : string +--- +***Description*** + +Статус возврата + +**Type:** string + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getAmount() : \YooKassa\Model\AmountInterface + +```php +public getAmount() : \YooKassa\Model\AmountInterface +``` + +**Summary** + +Возвращает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\AmountInterface - Сумма возврата + + + +#### public getCreatedAt() : \DateTime + +```php +public getCreatedAt() : \DateTime +``` + +**Summary** + +Возвращает дату создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \DateTime - Время создания возврата + + + +#### public getDescription() : string + +```php +public getDescription() : string +``` + +**Summary** + +Возвращает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Комментарий, основание для возврата средств покупателю + + + +#### public getId() : string + +```php +public getId() : string +``` + +**Summary** + +Возвращает идентификатор возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор возврата + + + +#### public getPaymentId() : string + +```php +public getPaymentId() : string +``` + +**Summary** + +Возвращает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Идентификатор платежа + + + +#### public getReceiptRegistration() : string + +```php +public getReceiptRegistration() : string +``` + +**Summary** + +Возвращает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус регистрации чека + + + +#### public getRequestor() : \YooKassa\Model\RequestorInterface + +```php +public getRequestor() : \YooKassa\Model\RequestorInterface +``` + +**Summary** + +Возвращает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\RequestorInterface - Инициатор платежа или возврата + + + +#### public getSources() : \YooKassa\Model\SourceInterface[] + +```php +public getSources() : \YooKassa\Model\SourceInterface[] +``` + +**Summary** + +Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** \YooKassa\Model\SourceInterface[] - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| inheritdoc | | | + + +#### public getStatus() : string + +```php +public getStatus() : string +``` + +**Summary** + +Возвращает статус текущего возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) + +**Returns:** string - Статус возврата + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setAmount() : mixed + +```php +public setAmount(\YooKassa\Model\AmountInterface value) : mixed +``` + +**Summary** + +Устанавливает сумму возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\AmountInterface | value | Сумма возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданная сумма меньше или равна нулю | + +**Returns:** mixed - + + + +#### public setCreatedAt() : mixed + +```php +public setCreatedAt(\DateTime value) : mixed +``` + +**Summary** + +Устанавливает вермя создания возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime | value | Время создания возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если быо передано пустое значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданную строку или число не удалось интерпретировать как дату и время | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Выбрасывается если было передано значение невалидного типа | + +**Returns:** mixed - + + + +#### public setDescription() : mixed + +```php +public setDescription(string value) : mixed +``` + +**Summary** + +Устанавливает комментарий к возврату + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Комментарий, основание для возврата средств покупателю | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setId() : mixed + +```php +public setId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор возврата | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setReceiptRegistration() : mixed + +```php +public setReceiptRegistration(string value) : mixed +``` + +**Summary** + +Устанавливает статус регистрации чека + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус регистрации чека | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public setRequestor() : mixed + +```php +public setRequestor(\YooKassa\Model\RequestorInterface|array value) : mixed +``` + +**Summary** + +Устанавливает инициатора платежа или возврата + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\RequestorInterface OR array | value | Инициатор платежа или возврата | + +**Returns:** mixed - + + + +#### public setSources() : mixed + +```php +public setSources(\YooKassa\Model\SourceInterface[]|array value) : mixed +``` + +**Summary** + +Устанавливает sources (массив распределения денег между магазинами) + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Model\SourceInterface[] OR array | value | | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Усианавливает стутус возврата платежа + +**Details:** +* Inherited From: [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус возврата платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\EmptyPropertyValueException | Выбрасывается если был передан пустой аргумент | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если було передано невалидное значение | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если аргумент не является строкой | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md new file mode 100644 index 00000000..b1341dbf --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequest.md @@ -0,0 +1,1044 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\RefundsRequest +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс объекта запроса к API списка возвратов магазина + +--- +### Constants +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [MAX_LIMIT_VALUE](../classes/YooKassa-Request-Refunds-RefundsRequest.md#constant_MAX_LIMIT_VALUE) | | Максимальное количество объектов возвратов в выборке | +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [$createdAtGt](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_createdAtGt) | | Время создания, от (не включая) | +| public | [$createdAtGte](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_createdAtGte) | | Время создания, от (включительно) | +| public | [$createdAtLt](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_createdAtLt) | | Время создания, до (не включая) | +| public | [$createdAtLte](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_createdAtLte) | | Время создания, до (включительно) | +| public | [$cursor](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_cursor) | | Токен для получения следующей страницы выборки | +| public | [$limit](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_limit) | | Ограничение количества объектов возврата, отображаемых на одной странице выдачи | +| public | [$paymentId](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_paymentId) | | Идентификатор платежа | +| public | [$status](../classes/YooKassa-Request-Refunds-RefundsRequest.md#property_status) | | Статус возврата | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractObject.md#method___construct) | | AbstractObject constructor. | +| public | [__get()](../classes/YooKassa-Common-AbstractObject.md#method___get) | | Возвращает значение свойства | +| public | [__isset()](../classes/YooKassa-Common-AbstractObject.md#method___isset) | | Проверяет наличие свойства | +| public | [__set()](../classes/YooKassa-Common-AbstractObject.md#method___set) | | Устанавливает значение свойства | +| public | [__unset()](../classes/YooKassa-Common-AbstractObject.md#method___unset) | | Удаляет свойство | +| public | [builder()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_builder) | | Возвращает инстанс билдера объектов запросов списка возвратов магазина | +| public | [clearValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_clearValidationError) | | Очищает статус валидации текущего запроса | +| public | [fromArray()](../classes/YooKassa-Common-AbstractObject.md#method_fromArray) | | Устанавливает значения свойств текущего объекта из массива | +| public | [getCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getCreatedAtGt) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getCreatedAtGte) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getCreatedAtLt) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getCreatedAtLte) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCursor()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getCursor) | | Возвращает токен для получения следующей страницы выборки | +| public | [getLastValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_getLastValidationError) | | Возвращает последнюю ошибку валидации | +| public | [getLimit()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getLimit) | | Ограничение количества объектов платежа | +| public | [getPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getPaymentId) | | Возвращает идентификатор платежа если он задан или null | +| public | [getStatus()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_getStatus) | | Возвращает статус выбираемых возвратов или null если он до этого не был установлен | +| public | [hasCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasCreatedAtGt) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasCreatedAtGte) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasCreatedAtLt) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCreatedAtLte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasCreatedAtLte) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCursor()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasCursor) | | Проверяет был ли установлен токен следующей страницы | +| public | [hasLimit()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasLimit) | | Проверяет был ли установлено ограничение количества объектов платежа | +| public | [hasPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasPaymentId) | | Проверяет, был ли задан идентификатор платежа | +| public | [hasStatus()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_hasStatus) | | Проверяет был ли установлен статус выбираемых возвратов | +| public | [jsonSerialize()](../classes/YooKassa-Common-AbstractObject.md#method_jsonSerialize) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации | +| public | [offsetExists()](../classes/YooKassa-Common-AbstractObject.md#method_offsetExists) | | Проверяет наличие свойства | +| public | [offsetGet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetGet) | | Возвращает значение свойства | +| public | [offsetSet()](../classes/YooKassa-Common-AbstractObject.md#method_offsetSet) | | Устанавливает значение свойства | +| public | [offsetUnset()](../classes/YooKassa-Common-AbstractObject.md#method_offsetUnset) | | Удаляет свойство | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются возвраты | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются возвраты | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются возвраты | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются возвраты | +| public | [setCursor()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setCursor) | | Устанавливает токен следующей страницы выборки | +| public | [setLimit()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setLimit) | | Устанавливает ограничение количества объектов платежа | +| public | [setPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setPaymentId) | | Устанавливает идентификатор платежа или null если требуется его удалить | +| public | [setStatus()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_setStatus) | | Устанавливает статус выбираемых возвратов | +| public | [toArray()](../classes/YooKassa-Common-AbstractObject.md#method_toArray) | | Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize() | +| public | [validate()](../classes/YooKassa-Request-Refunds-RefundsRequest.md#method_validate) | | Проверяет валидность текущего объекта запроса | +| protected | [getUnknownProperties()](../classes/YooKassa-Common-AbstractObject.md#method_getUnknownProperties) | | Возвращает массив свойств которые не существуют, но были заданы у объекта | +| protected | [setValidationError()](../classes/YooKassa-Common-AbstractRequest.md#method_setValidationError) | | Устанавливает ошибку валидации | +--- +### Details +* File: [lib/Request/Refunds/RefundsRequest.php](../../lib/Request/Refunds/RefundsRequest.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + * [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + * \YooKassa\Request\Refunds\RefundsRequest +* Implements: + * [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) +--- +## Constants + +###### MAX_LIMIT_VALUE +Максимальное количество объектов возвратов в выборке + +```php +MAX_LIMIT_VALUE = 100 +``` + + +--- +## Properties + +#### public $createdAtGt : \DateTime +--- +***Description*** + +Время создания, от (не включая) + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAtGte : \DateTime +--- +***Description*** + +Время создания, от (включительно) + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAtLt : \DateTime +--- +***Description*** + +Время создания, до (не включая) + +**Type:** \DateTime + +**Details:** + + + +#### public $createdAtLte : \DateTime +--- +***Description*** + +Время создания, до (включительно) + +**Type:** \DateTime + +**Details:** + + + +#### public $cursor : string +--- +***Description*** + +Токен для получения следующей страницы выборки + +**Type:** string + +**Details:** + + + +#### public $limit : int|null +--- +***Description*** + +Ограничение количества объектов возврата, отображаемых на одной странице выдачи + +**Type:** int|null + +**Details:** + + + +#### public $paymentId : string +--- +***Description*** + +Идентификатор платежа + +**Type:** string + +**Details:** + + + +#### public $status : string +--- +***Description*** + +Статус возврата + +**Type:** string + +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array data = array()) : mixed +``` + +**Summary** + +AbstractObject constructor. + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | data | | + +**Returns:** mixed - + + + +#### public __get() : mixed + +```php +public __get(string propertyName) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public __isset() : bool + +```php +public __isset(string propertyName) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public __set() : mixed + +```php +public __set(string propertyName, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public __unset() : mixed + +```php +public __unset(string propertyName) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | propertyName | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public builder() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +Static public builder() : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Возвращает инстанс билдера объектов запросов списка возвратов магазина + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Билдер объектов запросов списка возвратов + + + +#### public clearValidationError() : mixed + +```php +public clearValidationError() : mixed +``` + +**Summary** + +Очищает статус валидации текущего запроса + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** mixed - + + + +#### public fromArray() : mixed + +```php +public fromArray(array|\Traversable sourceArray) : mixed +``` + +**Summary** + +Устанавливает значения свойств текущего объекта из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | sourceArray | Ассоциативный массив с настройками | + +**Returns:** mixed - + + + +#### public getCreatedAtGt() : \DateTime|null + +```php +public getCreatedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** \DateTime|null - Время создания, от (не включая) + + + +#### public getCreatedAtGte() : \DateTime|null + +```php +public getCreatedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** \DateTime|null - Время создания, от (включительно) + + + +#### public getCreatedAtLt() : \DateTime|null + +```php +public getCreatedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** \DateTime|null - Время создания, до (не включая) + + + +#### public getCreatedAtLte() : \DateTime|null + +```php +public getCreatedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** \DateTime|null - Время создания, до (включительно) + + + +#### public getCursor() : string|null + +```php +public getCursor() : string|null +``` + +**Summary** + +Возвращает токен для получения следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** string|null - Токен для получения следующей страницы выборки + + + +#### public getLastValidationError() : string + +```php +public getLastValidationError() : string +``` + +**Summary** + +Возвращает последнюю ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) + +**Returns:** string - Последняя произошедшая ошибка валидации + + + +#### public getLimit() : int|null + +```php +public getLimit() : int|null +``` + +**Summary** + +Ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** int|null - Ограничение количества объектов платежа + + + +#### public getPaymentId() : string|null + +```php +public getPaymentId() : string|null +``` + +**Summary** + +Возвращает идентификатор платежа если он задан или null + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** string|null - Идентификатор платежа + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус выбираемых возвратов или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** string|null - Статус выбираемых возвратов + + + +#### public hasCreatedAtGt() : bool + +```php +public hasCreatedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtGte() : bool + +```php +public hasCreatedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtLt() : bool + +```php +public hasCreatedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCreatedAtLte() : bool + +```php +public hasCreatedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public hasCursor() : bool + +```php +public hasCursor() : bool +``` + +**Summary** + +Проверяет был ли установлен токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если токен был установлен, false если нет + + + +#### public hasLimit() : bool + +```php +public hasLimit() : bool +``` + +**Summary** + +Проверяет был ли установлено ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если было установлено, false если нет + + + +#### public hasPaymentId() : bool + +```php +public hasPaymentId() : bool +``` + +**Summary** + +Проверяет, был ли задан идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если идентификатор был задан, false если нет + + + +#### public hasStatus() : bool + +```php +public hasStatus() : bool +``` + +**Summary** + +Проверяет был ли установлен статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если статус был установлен, false если нет + + + +#### public jsonSerialize() : array + +```php +public jsonSerialize() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public offsetExists() : bool + +```php +public offsetExists(string offset) : bool +``` + +**Summary** + +Проверяет наличие свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя проверяемого свойства | + +**Returns:** bool - True если свойство имеется, false если нет + + + +#### public offsetGet() : mixed + +```php +public offsetGet(string offset) : mixed +``` + +**Summary** + +Возвращает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | + +**Returns:** mixed - Значение свойства + + + +#### public offsetSet() : mixed + +```php +public offsetSet(string offset, mixed value) : mixed +``` + +**Summary** + +Устанавливает значение свойства + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя свойства | +| mixed | value | Значение свойства | + +**Returns:** mixed - + + + +#### public offsetUnset() : mixed + +```php +public offsetUnset(string offset) : mixed +``` + +**Summary** + +Удаляет свойство + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | offset | Имя удаляемого свойства | + +**Returns:** mixed - + + + +#### public setCreatedAtGt() : mixed + +```php +public setCreatedAtGt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtGte() : mixed + +```php +public setCreatedAtGte(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtLt() : mixed + +```php +public setCreatedAtLt(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCreatedAtLte() : mixed + +```php +public setCreatedAtLte(\DateTime|string|int|null value) : mixed +``` + +**Summary** + +Устанавливает дату создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** mixed - + + + +#### public setCursor() : mixed + +```php +public setCursor(string value) : mixed +``` + +**Summary** + +Устанавливает токен следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Токен следующей страницы выборки или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setLimit() : mixed + +```php +public setLimit(int|null value) : mixed +``` + +**Summary** + +Устанавливает ограничение количества объектов платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| int OR null | value | Ограничение количества объектов платежа или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передано не целое число | + +**Returns:** mixed - + + + +#### public setPaymentId() : mixed + +```php +public setPaymentId(string|null value) : mixed +``` + +**Summary** + +Устанавливает идентификатор платежа или null если требуется его удалить + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 символам | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public setStatus() : mixed + +```php +public setStatus(string value) : mixed +``` + +**Summary** + +Устанавливает статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** mixed - + + + +#### public toArray() : array + +```php +public toArray() : array +``` + +**Summary** + +Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации +Является алиасом метода AbstractObject::jsonSerialize() + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив со свойствами текущего объекта + + + +#### public validate() : bool + +```php +public validate() : bool +``` + +**Summary** + +Проверяет валидность текущего объекта запроса + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) + +**Returns:** bool - True если объект валиден, false если нет + + + +#### protected getUnknownProperties() : array + +```php +protected getUnknownProperties() : array +``` + +**Summary** + +Возвращает массив свойств которые не существуют, но были заданы у объекта + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) + +**Returns:** array - Ассоциативный массив с не существующими у текущего объекта свойствами + + + +#### protected setValidationError() : mixed + +```php +protected setValidationError(string value) : mixed +``` + +**Summary** + +Устанавливает ошибку валидации + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ошибка, произошедшая при валидации объекта | + +**Returns:** mixed - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md new file mode 100644 index 00000000..cf894595 --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md @@ -0,0 +1,363 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\RefundsRequestBuilder +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс билдера объектов запросов к API списка возвратов + +--- +### Constants +* No constants found +--- +### Properties +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| protected | [$currentObject](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#property_currentObject) | | Инстанс собираемого запроса | +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method___construct) | | Конструктор, инициализирует пустой запрос, который в будущем начнём собирать | +| public | [build()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_build) | | Собирает и возвращает объект запроса списка возвратов магазина | +| public | [setCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setCreatedAtGt) | | Устанавливает дату создания от которой выбираются возвраты | +| public | [setCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setCreatedAtGte) | | Устанавливает дату создания от которой выбираются возвраты | +| public | [setCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setCreatedAtLt) | | Устанавливает дату создания до которой выбираются возвраты | +| public | [setCreatedAtLte()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setCreatedAtLte) | | Устанавливает дату создания до которой выбираются возвраты | +| public | [setCursor()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setCursor) | | Устанавливает токен следующей страницы выборки | +| public | [setLimit()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setLimit) | | Устанавливает ограничение количества объектов возвратов | +| public | [setOptions()](../classes/YooKassa-Common-AbstractRequestBuilder.md#method_setOptions) | | Устанавливает свойства запроса из массива | +| public | [setPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setPaymentId) | | Устанавливает идентификатор платежа или null если требуется его удалить | +| public | [setStatus()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_setStatus) | | Устанавливает статус выбираемых возвратов | +| protected | [initCurrentObject()](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md#method_initCurrentObject) | | Инициализирует новый инстанс собираемого объекта | +--- +### Details +* File: [lib/Request/Refunds/RefundsRequestBuilder.php](../../lib/Request/Refunds/RefundsRequestBuilder.php) +* Package: YooKassa +* Class Hierarchy: + * [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + * \YooKassa\Request\Refunds\RefundsRequestBuilder +--- +## Properties + +#### protected $currentObject : \YooKassa\Request\Refunds\RefundsRequest +--- +**Summary** + +Инстанс собираемого запроса + +**Type:** RefundsRequest +Инстанс собираемого объекта запроса +**Details:** + + + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct() : mixed +``` + +**Summary** + +Конструктор, инициализирует пустой запрос, который в будущем начнём собирать + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) + +**Returns:** mixed - + + + +#### public build() : \YooKassa\Request\Refunds\RefundsRequestInterface|\YooKassa\Common\AbstractRequest + +```php +public build(array|null options = null) : \YooKassa\Request\Refunds\RefundsRequestInterface|\YooKassa\Common\AbstractRequest +``` + +**Summary** + +Собирает и возвращает объект запроса списка возвратов магазина + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR null | options | Массив с настройками запроса | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestInterface|\YooKassa\Common\AbstractRequest - Инстанс объекта запроса к API для получения списка возвратов магазина + + + +#### public setCreatedAtGt() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setCreatedAtGt(\DateTime|string|int|null value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCreatedAtGte() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setCreatedAtGte(\DateTime|string|int|null value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, от (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCreatedAtLt() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setCreatedAtLt(\DateTime|string|int|null value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (не включая) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCreatedAtLte() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setCreatedAtLte(\DateTime|string|int|null value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает дату создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \DateTime OR string OR int OR null | value | Время создания, до (включительно) или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Генерируется если была передана дата в невалидном формате (была передана строка или число, которые не удалось преобразовать в валидную дату) | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException|\Exception | Генерируется если была передана дата с не тем типом (передана не строка, не число и не значение типа \DateTime) | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setCursor() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setCursor(string value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает токен следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Токен следующей страницы выборки или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setLimit() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setLimit(string value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает ограничение количества объектов возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Ограничение количества объектов возвратов или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод было передана не целое число | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего билдера + + + +#### public setOptions() : \YooKassa\Common\AbstractRequestBuilder + +```php +public setOptions(array|\Traversable options) : \YooKassa\Common\AbstractRequestBuilder +``` + +**Summary** + +Устанавливает свойства запроса из массива + +**Details:** +* Inherited From: [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array OR \Traversable | options | Массив свойств запроса | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \InvalidArgumentException | Выбрасывается если аргумент не массив и не итерируемый объект | +| \YooKassa\Common\Exceptions\InvalidPropertyException | Выбрасывается если не удалось установить один из параметров, переданныч в массиве настроек | + +**Returns:** \YooKassa\Common\AbstractRequestBuilder - Инстанс текущего билдера запросов + + + +#### public setPaymentId() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setPaymentId(string|null value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает идентификатор платежа или null если требуется его удалить + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string OR null | value | Идентификатор платежа | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если длина переданной строки не равна 36 символам | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### public setStatus() : \YooKassa\Request\Refunds\RefundsRequestBuilder + +```php +public setStatus(string value) : \YooKassa\Request\Refunds\RefundsRequestBuilder +``` + +**Summary** + +Устанавливает статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| string | value | Статус выбираемых платежей или null чтобы удалить значение | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \YooKassa\Common\Exceptions\InvalidPropertyValueException | Выбрасывается если переданное значение не является валидным статусом | +| \YooKassa\Common\Exceptions\InvalidPropertyValueTypeException | Выбрасывается если в метод была передана не строка | + +**Returns:** \YooKassa\Request\Refunds\RefundsRequestBuilder - Инстанс текущего объекта билдера + + + +#### protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequest + +```php +protected initCurrentObject() : \YooKassa\Request\Refunds\RefundsRequest +``` + +**Summary** + +Инициализирует новый инстанс собираемого объекта + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) + +**Returns:** \YooKassa\Request\Refunds\RefundsRequest - Инстанс собираемого запроса + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md new file mode 100644 index 00000000..d246c2ff --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequestInterface.md @@ -0,0 +1,307 @@ +# [YooKassa API SDK](../home.md) + +# Interface: RefundsRequestInterface +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Интерфейс объекта запроса списка возвратов + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [getCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getCreatedAtGt) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getCreatedAtGte) | | Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getCreatedAtLt) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCreatedAtLte()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getCreatedAtLte) | | Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена | +| public | [getCursor()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getCursor) | | Возвращает токен для получения следующей страницы выборки | +| public | [getPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getPaymentId) | | Возвращает идентификатор платежа если он задан или null | +| public | [getStatus()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_getStatus) | | Возвращает статус выбираемых возвратов или null если он до этого не был установлен | +| public | [hasCreatedAtGt()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasCreatedAtGt) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtGte()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasCreatedAtGte) | | Проверяет была ли установлена дата создания от которой выбираются возвраты | +| public | [hasCreatedAtLt()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasCreatedAtLt) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCreatedAtLte()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasCreatedAtLte) | | Проверяет была ли установлена дата создания до которой выбираются возвраты | +| public | [hasCursor()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasCursor) | | Проверяет был ли установлен токен следующей страницы | +| public | [hasPaymentId()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasPaymentId) | | Проверяет, был ли задан идентификатор платежа | +| public | [hasStatus()](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md#method_hasStatus) | | Проверяет был ли установлен статус выбираемых возвратов | + +--- +### Details +* File: [lib/Request/Refunds/RefundsRequestInterface.php](../../lib/Request/Refunds/RefundsRequestInterface.php) +* Package: \YooKassa +--- +### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| property-read | | Идентификатор платежа | +| property-read | | Время создания, от (включительно) | +| property-read | | Время создания, от (не включая) | +| property-read | | Время создания, до (включительно) | +| property-read | | Время создания, до (не включая) | +| property-read | | Статус возврата | +| property-read | | Токен для получения следующей страницы выборки | +| property-read | | Ограничение количества объектов, отображаемых на одной странице выдачи | +--- +## Methods + +#### public getPaymentId() : string|null + +```php +public getPaymentId() : string|null +``` + +**Summary** + +Возвращает идентификатор платежа если он задан или null + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** string|null - Идентификатор платежа + + + +#### public hasPaymentId() : bool + +```php +public hasPaymentId() : bool +``` + +**Summary** + +Проверяет, был ли задан идентификатор платежа + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если идентификатор был задан, false если нет + + + +#### public getCreatedAtGte() : \DateTime|null + +```php +public getCreatedAtGte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, от (включительно) + + + +#### public hasCreatedAtGte() : bool + +```php +public hasCreatedAtGte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getCreatedAtGt() : \DateTime|null + +```php +public getCreatedAtGt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, от (не включая) + + + +#### public hasCreatedAtGt() : bool + +```php +public hasCreatedAtGt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания от которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getCreatedAtLte() : \DateTime|null + +```php +public getCreatedAtLte() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, до (включительно) + + + +#### public hasCreatedAtLte() : bool + +```php +public hasCreatedAtLte() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getCreatedAtLt() : \DateTime|null + +```php +public getCreatedAtLt() : \DateTime|null +``` + +**Summary** + +Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** \DateTime|null - Время создания, до (не включая) + + + +#### public hasCreatedAtLt() : bool + +```php +public hasCreatedAtLt() : bool +``` + +**Summary** + +Проверяет была ли установлена дата создания до которой выбираются возвраты + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если дата была установлена, false если нет + + + +#### public getStatus() : string|null + +```php +public getStatus() : string|null +``` + +**Summary** + +Возвращает статус выбираемых возвратов или null если он до этого не был установлен + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** string|null - Статус выбираемых возвратов + + + +#### public hasStatus() : bool + +```php +public hasStatus() : bool +``` + +**Summary** + +Проверяет был ли установлен статус выбираемых возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если статус был установлен, false если нет + + + +#### public getCursor() : string|null + +```php +public getCursor() : string|null +``` + +**Summary** + +Возвращает токен для получения следующей страницы выборки + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** string|null - Токен для получения следующей страницы выборки + + + +#### public hasCursor() : bool + +```php +public hasCursor() : bool +``` + +**Summary** + +Проверяет был ли установлен токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) + +**Returns:** bool - True если токен был установлен, false если нет + + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md b/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md new file mode 100644 index 00000000..f6866f29 --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md @@ -0,0 +1,66 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\RefundsRequestSerializer +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс сериализатора объектов запросов к API для получения списка возвратов + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [serialize()](../classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md#method_serialize) | | Сериализует объект запроса к API для дальнейшей его отправки | +--- +### Details +* File: [lib/Request/Refunds/RefundsRequestSerializer.php](../../lib/Request/Refunds/RefundsRequestSerializer.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Refunds\RefundsRequestSerializer + +--- +## Methods + +#### public serialize() : array + +```php +public serialize(\YooKassa\Request\Refunds\RefundsRequestInterface request) : array +``` + +**Summary** + +Сериализует объект запроса к API для дальнейшей его отправки + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsRequestSerializer](../classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| \YooKassa\Request\Refunds\RefundsRequestInterface | request | Сериализуемый объект | + +**Returns:** array - Массив с инфомрацией, отпарвляемый в дальнейшем в API + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md b/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md new file mode 100644 index 00000000..bf38b598 --- /dev/null +++ b/docs/classes/YooKassa-Request-Refunds-RefundsResponse.md @@ -0,0 +1,124 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Refunds\RefundsResponse +### Namespace: [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +--- +**Summary:** + +Класс объекта ответа от API со списком возвратов магазина + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Refunds-RefundsResponse.md#method___construct) | | Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива | +| public | [getItems()](../classes/YooKassa-Request-Refunds-RefundsResponse.md#method_getItems) | | Возвращает список возвратов | +| public | [getNextCursor()](../classes/YooKassa-Request-Refunds-RefundsResponse.md#method_getNextCursor) | | Возвращает токен следующей страницы, если он задан, или null | +| public | [hasNextCursor()](../classes/YooKassa-Request-Refunds-RefundsResponse.md#method_hasNextCursor) | | Проверяет имееотся ли в ответе токен следующей страницы | +--- +### Details +* File: [lib/Request/Refunds/RefundsResponse.php](../../lib/Request/Refunds/RefundsResponse.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Refunds\RefundsResponse + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array options) : mixed +``` + +**Summary** + +Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsResponse](../classes/YooKassa-Request-Refunds-RefundsResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | options | Массив настроек, пришедший от API | +##### Throws: +| Type | Description | +| ---- | ----------- | +| \Exception | | + +**Returns:** mixed - + + + +#### public getItems() : \YooKassa\Model\RefundInterface[] + +```php +public getItems() : \YooKassa\Model\RefundInterface[] +``` + +**Summary** + +Возвращает список возвратов + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsResponse](../classes/YooKassa-Request-Refunds-RefundsResponse.md) + +**Returns:** \YooKassa\Model\RefundInterface[] - Список возвратов + + + +#### public getNextCursor() : string|null + +```php +public getNextCursor() : string|null +``` + +**Summary** + +Возвращает токен следующей страницы, если он задан, или null + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsResponse](../classes/YooKassa-Request-Refunds-RefundsResponse.md) + +**Returns:** string|null - Токен следующей страницы + + + +#### public hasNextCursor() : bool + +```php +public hasNextCursor() : bool +``` + +**Summary** + +Проверяет имееотся ли в ответе токен следующей страницы + +**Details:** +* Inherited From: [\YooKassa\Request\Refunds\RefundsResponse](../classes/YooKassa-Request-Refunds-RefundsResponse.md) + +**Returns:** bool - True если токен следующей страницы есть, false если нет + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md b/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md new file mode 100644 index 00000000..93819b8e --- /dev/null +++ b/docs/classes/YooKassa-Request-Webhook-WebhookListResponse.md @@ -0,0 +1,102 @@ +# [YooKassa API SDK](../home.md) + +# Class: \YooKassa\Request\Webhook\WebhookListResponse +### Namespace: [\YooKassa\Request\Webhook](../namespaces/yookassa-request-webhook.md) +--- +**Summary:** + +Актуальный список объектов webhook для переданного OAuth-токена + +--- +### Constants +* No constants found +--- +### Methods +| Visibility | Name | Flag | Summary | +| ----------:| ---- | ---- | ------- | +| public | [__construct()](../classes/YooKassa-Request-Webhook-WebhookListResponse.md#method___construct) | | Конструктор, устанавливает список полученных от API установленных webhook для переданного OAuth-токена | +| public | [getItems()](../classes/YooKassa-Request-Webhook-WebhookListResponse.md#method_getItems) | | Возвращает список установленных webhook для переданного OAuth-токена | +| public | [getType()](../classes/YooKassa-Request-Webhook-WebhookListResponse.md#method_getType) | | Возвращает тип ответа. Доступен только `list` | +--- +### Details +* File: [lib/Request/Webhook/WebhookListResponse.php](../../lib/Request/Webhook/WebhookListResponse.php) +* Package: YooKassa +* Class Hierarchy: + * \YooKassa\Request\Webhook\WebhookListResponse + +--- +## Methods + +#### public __construct() : mixed + +```php +public __construct(array response) : mixed +``` + +**Summary** + +Конструктор, устанавливает список полученных от API установленных webhook для переданного OAuth-токена + +**Details:** +* Inherited From: [\YooKassa\Request\Webhook\WebhookListResponse](../classes/YooKassa-Request-Webhook-WebhookListResponse.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| array | response | Разобранный ответ от API в виде массива | + +**Returns:** mixed - + + + +#### public getItems() : \YooKassa\Model\Webhook\Webhook[] + +```php +public getItems() : \YooKassa\Model\Webhook\Webhook[] +``` + +**Summary** + +Возвращает список установленных webhook для переданного OAuth-токена + +**Details:** +* Inherited From: [\YooKassa\Request\Webhook\WebhookListResponse](../classes/YooKassa-Request-Webhook-WebhookListResponse.md) + +**Returns:** \YooKassa\Model\Webhook\Webhook[] - Список установленных webhook + + + +#### public getType() : string + +```php +public getType() : string +``` + +**Summary** + +Возвращает тип ответа. Доступен только `list` + +**Details:** +* Inherited From: [\YooKassa\Request\Webhook\WebhookListResponse](../classes/YooKassa-Request-Webhook-WebhookListResponse.md) + +**Returns:** string - + + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/examples/01-configuration.md b/docs/examples/01-configuration.md new file mode 100644 index 00000000..7bc9fa79 --- /dev/null +++ b/docs/examples/01-configuration.md @@ -0,0 +1,238 @@ +## Настройки SDK API ЮKassa + +[Справочник API ЮKassa](https://yookassa.ru/developers/api) + +С помощью этого SDK вы можете работать с онлайн-платежами: отправлять запросы на оплату, +сохранять платежную информацию для повторных списаний, совершать возвраты и многое другое. + +* [Аутентификация](#Аутентификация) +* [Статистические данные об используемом окружении](#Статистические-данные-об-используемом-окружении) +* [Получение информации о магазине](#Получение-информации-о-магазине) +* [Работа с Webhook](#Работа-с-Webhook) +* [Входящие уведомления](#Входящие-уведомления) + +--- + +### Аутентификация + +Для работы с API необходимо прописать в конфигурации данные аутентификации. Существует два способа аутентификации: +- shopId + секретный ключ +- OAuth-токен. [Подробнее в документации к API](https://yookassa.ru/developers/partners-api/basics) + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +// shopId + секретный ключ +$client->setAuth('xxxxxx', 'test_XXXXXXX'); +// или OAuth-токен +$client->setAuthToken('token_XXXXXXX'); +``` + +--- + +### Статистические данные об используемом окружении + +Для поддержки качества, а также быстром реагировании на ошибки, SDK передает статистику в запросах к API ЮKassa. + +По молчанию, SDK передает в запросах версию операционной системы, версию Python, а также версию SDK. +Но вы можете передать дополнительные данные об используемом фреймворке, CMS, а также модуле в CMS. + +Например, это может выглядеть так: +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); +$userAgent = $client->getApiClient()->getUserAgent(); +$userAgent->setFramework('Symfony', '5.2.1'); +$userAgent->setCms('Symfony CMF', '1.2.1'); +$userAgent->setModule('YooKassa', '1.0.0'); +``` + +--- + +### Получение информации о магазине + +После установки конфигурации можно проверить корректность данных, а также получить информацию о магазине. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $response = $client->me(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` +В результате мы увидим примерно следующее: +``` +array(5) { + ["account_id"] => string(6) "XXXXXX" + ["test"]=> bool(true) + ["fiscalization_enabled"]=> bool(true) + ["payment_methods"]=> array(2) { + [0]=> string(9) "yoo_money" + [1]=> string(9) "bank_card" + } + ["status"]=> string(7) "enabled" +} +``` +[Подробнее в документации к API](https://yookassa.ru/developers/api?lang=php#me_object) + +--- + +### Работа с Webhook + +Если вы подключаетесь к API через Oauth-токен, то можете настроить получение уведомлений о смене статуса платежа или возврата. + +Например, ЮKassa может сообщить, когда объект платежа, созданный в вашем приложении, перейдет в статус `waiting_for_capture`. + +В данном примере мы устанавливаем вебхуки для succeeded и canceled уведомлений. +А так же проверяем, не установлены ли уже вебхуки. И если установлены на неверный адрес, удаляем. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$webHookUrl = 'https://merchant-site.ru/payment-notification'; +$needWebHookList = array( + \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED, + \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED, +); + +try { + $currentWebHookList = $client->getWebhooks()->getItems(); + foreach ($needWebHookList as $event) { + $hookIsSet = false; + foreach ($currentWebHookList as $webHook) { + if ($webHook->getEvent() === $event) { + if ($webHook->getUrl() !== $webHookUrl) { + $hookIsSet = false; + $client->removeWebhook($webHook->getId()); + } else { + $hookIsSet = true; + } + } + } + if (!$hookIsSet) { + $client->addWebhook(array('event' => $event, 'url' => $webHookUrl)); + } + } +} catch (Exception $e) { + echo $e->getMessage(); +} +var_dump($client->getWebhooks()->getItems()); +``` + +В результате мы увидим примерно следующее: +``` +array(2) { + [0] => object(YooKassa\Model\Webhook\Webhook)#7 (4) { + ["id":"YooKassa\Model\Webhook\Webhook":private] => string(39) "wh-52e51c6e-29a2-4a0d-854b-01cf022b5613" + ["event":"YooKassa\Model\Webhook\Webhook":private] => string(16) "payment.canceled" + ["url":"YooKassa\Model\Webhook\Webhook":private] => string(66) "https://merchant-site.ru/payment-notification" + } + [1] => object(YooKassa\Model\Webhook\Webhook)#8 (4) { + ["id":"YooKassa\Model\Webhook\Webhook":private] => string(39) "wh-c331b3ee-fb65-428d-b128-1b837d9c4d93" + ["event":"YooKassa\Model\Webhook\Webhook":private] => string(17) "payment.succeeded" + ["url":"YooKassa\Model\Webhook\Webhook":private] => string(66) "https://merchant-site.ru/payment-notification" + } +} +``` +[Подробнее в документации к API](https://yookassa.ru/developers/api?lang=php#webhook) + +### Входящие уведомления + +Если вы хотите отслеживать состояние платежей и возвратов, вы можете подписаться на уведомления ([webhook](#Работа-с-Webhook), callback). + +Уведомления пригодятся в тех случаях, когда объект API изменяется без вашего участия. +Например, если пользователю нужно подтвердить платеж, процесс оплаты может занять от нескольких минут до нескольких часов. +Вместо того чтобы всё это время периодически отправлять GET-запросы, чтобы узнать статус платежа, вы можете просто дожидаться уведомления от ЮKassa. + +[Входящие уведомления в документации](https://yookassa.ru/developers/using-api/webhooks?lang=php) + +#### Использование + +Как только произойдет событие, на которое вы подписались, на URL, который вы указали при настройке, придет уведомление. +В нем будут все данные об объекте на момент, когда произошло событие. + +Вам нужно подтвердить, что вы получили уведомление. Для этого ответьте HTTP-кодом 200. ЮKassa проигнорирует всё, +что будет находиться в теле или заголовках ответа. Ответы с любыми другими HTTP-кодами будут считаться невалидными, +и ЮKassa продолжит доставлять уведомление в течение 24 часов, начиная с момента, когда событие произошло. + +#### Пример обработки уведомления с помощью SDK + +```php +require_once 'vendor/autoload.php'; + +try { + $source = file_get_contents('php://input'); + $data = json_decode($source, true); + + $factory = new \YooKassa\Model\Notification\NotificationFactory(); + $notificationObject = $factory->factory($data); + $responseObject = $notificationObject->getObject(); + + if ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_SUCCEEDED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::PAYMENT_CANCELED) { + $someData = array( + 'paymentId' => $responseObject->getId(), + 'paymentStatus' => $responseObject->getStatus(), + ); + // Специфичная логика + // ... + } elseif ($notificationObject->getEvent() === \YooKassa\Model\NotificationEventType::REFUND_SUCCEEDED) { + $someData = array( + 'refundId' => $responseObject->getId(), + 'refundStatus' => $responseObject->getStatus(), + 'paymentId' => $responseObject->getPaymentId(), + ); + // ... + // Специфичная логика + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + + // Специфичная логика + // ... + + $client = new \YooKassa\Client(); + $client->setAuth('xxxxxx', 'test_XXXXXXX'); + + // Получим актуальную информацию о платеже + if ($paymentInfo = $client->getPaymentInfo($someData['paymentId'])) { + $paymentStatus = $paymentInfo->getStatus(); + // Специфичная логика + // ... + } else { + header('HTTP/1.1 400 Something went wrong'); + exit(); + } + +} catch (Exception $e) { + header('HTTP/1.1 400 Something went wrong'); + exit(); +} +``` diff --git a/docs/examples/02-payments.md b/docs/examples/02-payments.md new file mode 100644 index 00000000..bff17e6d --- /dev/null +++ b/docs/examples/02-payments.md @@ -0,0 +1,341 @@ +## Работа с платежами + +SDK позволяет создавать, подтверждать, отменять платежи, а также получать информацию о них. + +Объект платежа `PaymentResponse` содержит всю информацию о платеже, актуальную на текущий момент времени. +Он формируется при создании платежа и приходит в ответ на любой запрос, связанный с платежами. + +* [Запрос на создание платежа](#Запрос-на-создание-платежа) +* [Запрос на создание платежа через билдер](#Запрос-на-создание-платежа-через-билдер) +* [Запрос на частичное подтверждение платежа](#Запрос-на-частичное-подтверждение-платежа) +* [Запрос на отмену незавершенного платежа](#Запрос-на-отмену-незавершенного-платежа) +* [Получить информацию о платеже](#Получить-информацию-о-платеже) +* [Получить список платежей с фильтрацией](#Получить-список-платежей-с-фильтрацией) + +--- + +### Запрос на создание платежа + +[Создание платежа в документации](https://yookassa.ru/developers/api?lang=php#create_payment) + +Чтобы принять оплату, необходимо создать объект платежа — `CreatePaymentRequest`. Он содержит всю необходимую информацию +для проведения оплаты (сумму, валюту и статус). У платежа линейный жизненный цикл, +он последовательно переходит из статуса в статус. + +В ответ на запрос придет объект платежа - `PaymentResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $idempotenceKey = uniqid('', true); + $response = $client->createPayment( + array( + 'amount' => array( + 'value' => '1000.00', + 'currency' => 'RUB', + ), + 'confirmation' => array( + 'type' => 'redirect', + 'locale' => 'ru_RU', + 'return_url' => 'https://merchant-site.ru/return_url', + ), + 'capture' => true, + 'description' => 'Заказ №72', + 'metadata' => array( + 'orderNumber' => 1001 + ), + 'receipt' => array( + 'customer' => array( + 'full_name' => 'Ivanov Ivan Ivanovich', + 'email' => 'email@email.ru', + 'phone' => '79211234567', + 'inn' => '6321341814' + ), + 'items' => array( + array( + 'description' => 'Переносное зарядное устройство Хувей', + 'quantity' => '1.00', + 'amount' => array( + 'value' => 1000, + 'currency' => 'RUB' + ), + 'vat_code' => '2', + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + 'country_of_origin_code' => 'CN', + 'product_code' => '44 4D 01 00 21 FA 41 00 23 05 41 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12 00 AB 00', + 'customs_declaration_number' => '10714040/140917/0090376', + 'excise' => '20.00', + 'supplier' => array( + 'name' => 'string', + 'phone' => 'string', + 'inn' => 'string' + ) + ), + ) + ) + ), + $idempotenceKey + ); + + //получаем confirmationUrl для дальнейшего редиректа + $confirmationUrl = $response->getConfirmation()->getConfirmationUrl(); +} catch (\Exception $e) { + $response = $e; +} + +if (!empty($response)) { + print_r($response); +} +``` +--- + +### Запрос на создание платежа через билдер + +[Создание платежа в документации](https://yookassa.ru/developers/api?lang=php#create_payment) + +Билдер позволяет создать объект платежа — `CreatePaymentRequest` программным способом, через объекты. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $builder = \YooKassa\Request\Payments\CreatePaymentRequest::builder(); + $builder->setAmount(100) + ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) + ->setCapture(true) + ->setDescription('Оплата заказа 112233') + ->setMetadata(array( + 'cms_name' => 'yoo_api_test', + 'order_id' => '112233', + 'language' => 'ru', + 'transaction_id' => '123-456-789', + )); + + // Устанавливаем страницу для редиректа после оплаты + $builder->setConfirmation(array( + 'type' => \YooKassa\Model\ConfirmationType::REDIRECT, + 'returnUrl' => 'https://merchant-site.ru/payment-return-page', + )); + + // Можем установить конкретный способ оплаты + $builder->setPaymentMethodData(\YooKassa\Model\PaymentMethodType::BANK_CARD); + + // Составляем чек + $builder->setReceiptEmail('john.doe@merchant.com'); + $builder->setReceiptPhone('71111111111'); + // Добавим товар + $builder->addReceiptItem( + 'Платок Gucci', + 3000, + 1.0, + 2, + 'full_payment', + 'commodity' + ); + // Добавим доставку + $builder->addReceiptShipping( + 'Delivery/Shipping/Доставка', + 100, + 1, + \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, + \YooKassa\Model\Receipt\PaymentSubject::SERVICE + ); + + // Можно добавить распределение денег по магазинам + $builder->setTransfers(array( + array( + 'account_id' => 123456, + 'amount' => array( + array( + 'value' => 1000, + 'currency' => \YooKassa\Model\CurrencyCode::RUB + ) + ), + ), + array( + 'account_id' => 654321, + 'amount' => array( + array( + 'value' => 2000, + 'currency' => \YooKassa\Model\CurrencyCode::RUB + ) + ), + ) + )); + + // Создаем объект запроса + $request = $builder->build(); + + // Можно изменить данные, если нужно + $request->setDescription($request->getDescription() . ' - merchant comment'); + + $idempotenceKey = uniqid('', true); + $response = $client->createPayment($request); + + //получаем confirmationUrl для дальнейшего редиректа + $confirmationUrl = $response->getConfirmation()->getConfirmationUrl(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` +--- + +### Запрос на частичное подтверждение платежа + +[Подтверждение платежа в документации](https://yookassa.ru/developers/api?lang=php#capture_payment) + +Подтверждает вашу готовность принять платеж. После подтверждения платеж перейдет в статус succeeded. +Это значит, что вы можете выдать товар или оказать услугу пользователю. + +Подтвердить можно только платеж в статусе `waiting_for_capture` и только в течение определенного времени +(зависит от способа оплаты). Если вы не подтвердите платеж в отведенное время, он автоматически перейдет +в статус `canceled`, и деньги вернутся пользователю. + +В ответ на запрос придет объект платежа в актуальном статусе. +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$paymentId = '21b23b5b-000f-5061-a000-0674e49a8c10'; +$request = array( + "amount" => array( + "value" => "1000.00", + "currency" => "RUB" + ), + "transfers" => array( + array( + "account_id" => "123", + "amount" => array( + "value" => "300.00", + "currency" => "RUB" + ) + ), + array( + "account_id" => "456", + "amount" => array( + "value" => "700.00", + "currency" => "RUB" + ) + ) + ) +); +$idempotenceKey = uniqid('', true); +try { + $response = $client->capturePayment($request, $paymentId, $idempotenceKey); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` +[Подробнее о подтверждении и отмене платежей](https://yookassa.ru/developers/payments/payment-process#capture-and-cancel) + +--- + +### Запрос на отмену незавершенного платежа + +[Отмена платежа в документации](https://yookassa.ru/developers/api?lang=php#cancel_payment) + +Отменяет платеж, находящийся в статусе `waiting_for_capture`. Отмена платежа значит, что вы не готовы +выдать пользователю товар или оказать услугу. Как только вы отменяете платеж, мы начинаем возвращать деньги на счет плательщика. Для платежей банковскими картами или из кошелька ЮMoney отмена происходит мгновенно. Для остальных способов оплаты возврат может занимать до нескольких дней. + +В ответ на запрос придет объект платежа в актуальном статусе. +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$paymentId = '215d8da0-000f-50be-b000-0003308c89be'; +$idempotenceKey = uniqid('', true); +try { + $response = $client->cancelPayment($paymentId, $idempotenceKey); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` +[Подробнее о подтверждении и отмене платежей](https://yookassa.ru/developers/payments/payment-process#capture-and-cancel) + +--- + +### Получить информацию о платеже + +[Информация о платеже в документации](https://yookassa.ru/developers/api?lang=php#get_payment) + +Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. + +В ответ на запрос придет объект платежа в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$paymentId = '215d8da0-000f-50be-b000-0003308c89be'; +try { + $response = $client->getPaymentInfo($paymentId); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` +--- + +### Получить список платежей с фильтрацией + +[Список платежей в документации](https://yookassa.ru/developers/api?lang=php#get_payments_list) + +Запрос позволяет получить список платежей, отфильтрованный по заданным критериям. + +В ответ на запрос вернется список платежей с учетом переданных параметров. В списке будет информация о платежах, +созданных за последние 3 года. Список будет отсортирован по времени создания платежей в порядке убывания. + +Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе на запрос +вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$cursor = null; +$params = array( + 'limit' => 30, + 'status' => \YooKassa\Model\PaymentStatus::CANCELED, + 'payment_method' => \YooKassa\Model\PaymentMethodType::BANK_CARD, + 'created_at_gte' => '2021-01-01T00:00:00.000Z', + 'created_at_lt' => '2021-03-30T23:59:59.999Z', +); +try { + do { + $params['cursor'] = $cursor; + $payments = $client->getPayments($params); + foreach ($payments->getItems() as $payment) { + echo $payment->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' . + $payment->getStatus() . ' - ' . + $payment->getId() . "\n"; + } + } while ($cursor = $payments->getNextCursor()); +} catch (\Exception $e) { + $response = $e; + var_dump($response); +} +``` +[Подробнее о работе со списками](https://yookassa.ru/developers/using-api/lists) \ No newline at end of file diff --git a/docs/examples/03-refunds.md b/docs/examples/03-refunds.md new file mode 100644 index 00000000..1428d6f5 --- /dev/null +++ b/docs/examples/03-refunds.md @@ -0,0 +1,178 @@ +## Работа с возвратами + +С помощью SDK можно возвращать платежи — полностью или частично. Порядок возврата зависит от способа оплаты +(`payment_method`) исходного платежа. При оплате банковской картой деньги возвращаются на карту, +которая была использована для проведения платежа. [Как проводить возвраты](https://yookassa.ru/developers/payments/refunds) + +Часть способов оплаты (например, наличные) не поддерживают возвраты. [Какие платежи можно вернуть](https://yookassa.ru/developers/payment-methods/overview#all) + +* [Запрос на создание возврата](#Запрос-на-создание-возврата) +* [Запрос на создание возврата через билдер](#Запрос-на-создание-возврата-через-билдер) +* [Получить информацию о возврате](#Получить-информацию-о-возврате) +* [Получить список возвратов с фильтрацией](#Получить-список-возвратов-с-фильтрацией) + +--- + +### Запрос на создание возврата + +[Создание возврата в документации](https://yookassa.ru/developers/api?lang=php#create_refund) + +Создает возврат успешного платежа на указанную сумму. Платеж можно вернуть только в течение трех лет с момента его создания. +Комиссия ЮKassa за проведение платежа не возвращается. + +В ответ на запрос придет объект возврата - `RefundResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $response = $client->createRefund( + array( + 'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df', + 'amount' => array( + 'value' => '1000.00', + 'currency' => \YooKassa\Model\CurrencyCode::RUB, + ), + 'sources' => array( + array( + 'account_id' => '456', + 'amount' => array( + 'value' => '1000.00', + 'currency' => \YooKassa\Model\CurrencyCode::RUB, + ) + ), + ), + ), + uniqid('', true) + ); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` + +--- + +### Запрос на создание возврата через билдер + +[Информация о создании возврата в документации](https://yookassa.ru/developers/api?lang=php#create_refund) + +Билдер позволяет создать объект возврата — `CreateRefundRequest` программным способом, через объекты. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $refundBuilder = \YooKassa\Request\Refunds\CreateRefundRequest::builder(); + $refundBuilder + ->setPaymentId('24b94598-000f-5000-9000-1b68e7b15f3f') + ->setAmount(3500.00) + ->setCurrency(\YooKassa\Model\CurrencyCode::RUB) + ->setDescription('Не подошел цвет') + ->setReceiptItems(array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => \YooKassa\Model\CurrencyCode::RUB, + ), + 'vat_code' => 2, + 'payment_mode' => 'full_payment', + 'payment_subject' => 'commodity', + ), + )) + ->setReceiptEmail('john.doe@merchant.com') + ->setTaxSystemCode(1); + + // Создаем объект запроса + $request = $refundBuilder->build(); + + // Можно изменить данные, если нужно + $request->setDescription('Не подошел цвет и размер'); + + $idempotenceKey = uniqid('', true); + $response = $client->createRefund($request, $idempotenceKey); +} catch (Exception $e) { + $response = $e; +} +``` + +--- + +### Получить информацию о возврате + +[Информация о возврате в документации](https://yookassa.ru/developers/api?lang=php#get_refund) + +Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. + +В ответ на запрос придет объект возврата - `RefundResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $response = $client->getRefundInfo('216749f7-0016-50be-b000-078d43a63ae4'); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` + +--- + +### Получить список возвратов с фильтрацией + +[Список возвратов в документации](https://yookassa.ru/developers/api?lang=php#get_refunds_list) + +Запрос позволяет получить список возвратов, отфильтрованный по заданным критериям. + +В ответ на запрос вернется список возвратов с учетом переданных параметров. В списке будет информация о возвратах, +созданных за последние 3 года. Список будет отсортирован по времени создания возвратов в порядке убывания. + +Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе на запрос +вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$cursor = null; +$params = array( + 'limit' => 30, + 'status' => \YooKassa\Model\RefundStatus::SUCCEEDED, + 'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9', + 'created_at_gte' => '2021-01-01T00:00:00.000Z', + 'created_at_lt' => '2021-03-30T23:59:59.999Z', +); +try { + do { + $params['cursor'] = $cursor; + $refunds = $client->getRefunds($params); + foreach ($refunds->getItems() as $refund) { + echo $refund->getCreatedAt()->format('Y-m-d H:i:s') . ' - ' . + $refund->getStatus() . ' - ' . + $refund->getId() . "\n"; + } + } while ($cursor = $refunds->getNextCursor()); +} catch (\Exception $e) { + $response = $e; + var_dump($response); +} +``` +[Подробнее о работе со списками](https://yookassa.ru/developers/using-api/lists) \ No newline at end of file diff --git a/docs/examples/04-receipts.md b/docs/examples/04-receipts.md new file mode 100644 index 00000000..619b8dd9 --- /dev/null +++ b/docs/examples/04-receipts.md @@ -0,0 +1,207 @@ +## Работа с чеками + +> Для тех, кто использует [решение ЮKassa для 54-ФЗ](https://yookassa.ru/developers/54fz/basics). + +С помощью SDK можно получать информацию о чеках, для которых вы отправили данные через ЮKassa. + +* [Запрос на создание чека](#Запрос-на-создание-чека) +* [Запрос на создание чека через билдер](#Запрос-на-создание-чека-через-билдер) +* [Получить информацию о чеке](#Получить-информацию-о-чеке) +* [Получить список чеков с фильтрацией](#Получить-список-чеков-с-фильтрацией) + +--- + +### Запрос на создание чека + +[Информация о создании чека в документации](https://yookassa.ru/developers/api?lang=php#create_receipt) + +Запрос позволяет передать онлайн-кассе данные для формирования [чека зачета предоплаты](https://yookassa.ru/developers/54fz/payments#settlement-receipt). + +Если вы работаете по сценарию [Сначала платеж, потом чек](https://yookassa.ru/developers/54fz/basics#receipt-after-payment), +в запросе также нужно передавать данные для формирования чека прихода и чека возврата прихода. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $response = $client->createReceipt( + array( + 'customer' => array( + 'email' => 'johndoe@yoomoney.ru', + 'phone' => '79000000000', + ), + 'type' => 'payment', + 'payment_id' => '24e89cb0-000f-5000-9000-1de77fa0d6df', + 'on_behalf_of' => '123', + 'send' => true, + 'items' => array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => \YooKassa\Model\CurrencyCode::RUB, + ), + 'vat_code' => 2, + 'payment_mode' => \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, + 'payment_subject' => \YooKassa\Model\Receipt\PaymentSubject::COMMODITY, + ), + ), + 'tax_system_code' => 1, + ), + uniqid('', true) + ); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` + +--- + +### Запрос на создание чека через билдер + +[Информация о создании чека в документации](https://yookassa.ru/developers/api?lang=php#create_receipt) + +Билдер позволяет создать объект платежа — `ReceiptRequest` программным способом, через объекты. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh'; + $receiptBuilder = \YooKassa\Request\Receipts\CreatePostReceiptRequest::builder(); + $receiptBuilder->setType(\YooKassa\Model\ReceiptType::PAYMENT) + ->setObjectId('24b94598-000f-5000-9000-1b68e7b15f3f') + ->setCustomer(array( + 'email' => 'john.doe@merchant.com', + 'phone' => '71111111111', + )) + ->setItems(array( + array( + 'description' => 'Платок Gucci', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3000.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, + 'payment_subject' => \YooKassa\Model\Receipt\PaymentSubject::COMMODITY, + 'product_code' => (string)(new \YooKassa\Helpers\ProductCode($inputDataMatrix)), + ), + )) + ->setSettlements(array( + array( + 'type' => 'prepayment', + 'amount' => array( + 'value' => 100.00, + 'currency' => 'RUB', + ), + ), + )) + ->setSend(true); + + // Создаем объект запроса + $request = $receiptBuilder->build(); + + // Можно изменить данные, если нужно + $request->setOnBehalfOf('159753'); + $request->addItem(new \YooKassa\Model\ReceiptItem(array( + 'description' => 'Платок Gucci Новый', + 'quantity' => '1.00', + 'amount' => array( + 'value' => '3500.00', + 'currency' => 'RUB', + ), + 'vat_code' => 2, + 'payment_mode' => \YooKassa\Model\Receipt\PaymentMode::FULL_PAYMENT, + 'payment_subject' => \YooKassa\Model\Receipt\PaymentSubject::COMMODITY, + ))); + + $idempotenceKey = uniqid('', true); + $response = $client->createReceipt($request, $idempotenceKey); +} catch (Exception $e) { + $response = $e; +} + +var_dump($response); +``` + +--- + +### Получить информацию о чеке + +[Информация о чеке в документации](https://yookassa.ru/developers/api?lang=php#get_receipt) + +Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. + +В ответ на запрос придет объект чека - `ReceiptResponse` в актуальном статусе. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +try { + $response = $client->getReceiptInfo('ra-27ed1660-0001-0050-7a5e-10f80e0f0f29'); + echo $response->getStatus(); +} catch (\Exception $e) { + $response = $e; +} + +var_dump($response); +``` + +--- + +### Получить список чеков с фильтрацией + +[Список чеков в документации](https://yookassa.ru/developers/api?lang=php#get_receipts_list) + +Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. +Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. + +В ответ на запрос вернется список чеков с учетом переданных параметров. В списке будет информация о чеках, +созданных за последние 3 года. Список будет отсортирован по времени создания чеков в порядке убывания. + +Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. +В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + +```php +require_once 'vendor/autoload.php'; + +$client = new \YooKassa\Client(); +$client->setAuth('xxxxxx', 'test_XXXXXXX'); + +$cursor = null; +$params = array( + 'limit' => 30, + 'status' => \YooKassa\Model\ReceiptRegistrationStatus::SUCCEEDED, + 'payment_id' => '1da5c87d-0984-50e8-a7f3-8de646dd9ec9', + 'created_at_gte' => '2021-01-01T00:00:00.000Z', + 'created_at_lt' => '2021-03-30T23:59:59.999Z', +); +try { + do { + $params['cursor'] = $cursor; + $receipts = $client->getReceipts($params); + foreach ($receipts->getItems() as $receipt) { + echo $receipt->getStatus() . ' - ' . $receipt->getId() . "\n"; + } + } while ($cursor = $receipts->getNextCursor()); +} catch (\Exception $e) { + $response = $e; + var_dump($response); +} +``` +[Подробнее о работе со списками](https://yookassa.ru/developers/using-api/lists) \ No newline at end of file diff --git a/docs/examples/readme.md b/docs/examples/readme.md new file mode 100644 index 00000000..049da700 --- /dev/null +++ b/docs/examples/readme.md @@ -0,0 +1,28 @@ +## Примеры использования SDK + +#### [Настройки SDK API ЮKassa](01-configuration.md) +* [Аутентификация](01-configuration.md#Аутентификация) +* [Статистические данные об используемом окружении](01-configuration.md#Статистические-данные-об-используемом-окружении) +* [Получение информации о магазине](01-configuration.md#Получение-информации-о-магазине) +* [Работа с Webhook](01-configuration.md#Работа-с-Webhook) +* [Входящие уведомления](01-configuration.md#Входящие-уведомления) + +#### [Работа с платежами](02-payments.md) +* [Запрос на создание платежа](02-payments.md#Запрос-на-создание-платежа) +* [Запрос на создание платежа через билдер](02-payments.md#Запрос-на-создание-платежа-через-билдер) +* [Запрос на частичное подтверждение платежа](02-payments.md#Запрос-на-частичное-подтверждение-платежа) +* [Запрос на отмену незавершенного платежа](02-payments.md#Запрос-на-отмену-незавершенного-платежа) +* [Получить информацию о платеже](02-payments.md#Получить-информацию-о-платеже) +* [Получить список платежей с фильтрацией](02-payments.md#Получить-список-платежей-с-фильтрацией) + +#### [Работа с возвратами](03-refunds.md) +* [Запрос на создание возврата](03-refunds.md#Запрос-на-создание-возврата) +* [Запрос на создание возврата через билдер](03-refunds.md#Запрос-на-создание-возврата-через-билдер) +* [Получить информацию о возврате](03-refunds.md#Получить-информацию-о-возврате) +* [Получить список возвратов с фильтрацией](03-refunds.md#Получить-список-возвратов-с-фильтрацией) + +#### [Работа с чеками](04-receipts.md) +* [Запрос на создание чека](04-receipts.md#Запрос-на-создание-чека) +* [Запрос на создание чека через билдер](04-receipts.md#Запрос-на-создание-чека-через-билдер) +* [Получить информацию о чеке](04-receipts.md#Получить-информацию-о-чеке) +* [Получить список чеков с фильтрацией](04-receipts.md#Получить-список-чеков-с-фильтрацией) \ No newline at end of file diff --git a/docs/namespaces/default.md b/docs/namespaces/default.md new file mode 100644 index 00000000..ddc443fd --- /dev/null +++ b/docs/namespaces/default.md @@ -0,0 +1,50 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \ +### Namespaces +* [\YooKassa](../namespaces/yookassa.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\JsonSerializable](../classes/JsonSerializable.md) | | +### Functions + +#### yookassaSdkLoadClass() : mixed + +```php + yookassaSdkLoadClass(mixed className) : mixed +``` + +**Details:** +* File: [lib/autoload.php](../files/lib-autoload.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | className | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| package | | | + + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-client.md b/docs/namespaces/yookassa-client.md new file mode 100644 index 00000000..b56dcf09 --- /dev/null +++ b/docs/namespaces/yookassa-client.md @@ -0,0 +1,33 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Client +## Parent: [\YooKassa](../namespaces/yookassa.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Client\ApiClientInterface](../classes/YooKassa-Client-ApiClientInterface.md) | Interface ApiClientInterface | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Client\BaseClient](../classes/YooKassa-Client-BaseClient.md) | | +| [\YooKassa\Client\CurlClient](../classes/YooKassa-Client-CurlClient.md) | Класс клиента Curl запросов | +| [\YooKassa\Client\UserAgent](../classes/YooKassa-Client-UserAgent.md) | Класс для создания заголовка User-Agent в запросах к API | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-common-exceptions.md b/docs/namespaces/yookassa-common-exceptions.md new file mode 100644 index 00000000..1441cd6a --- /dev/null +++ b/docs/namespaces/yookassa-common-exceptions.md @@ -0,0 +1,43 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Common\Exceptions +## Parent: [\YooKassa\Common](../namespaces/yookassa-common.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Common\Exceptions\ApiConnectionException](../classes/YooKassa-Common-Exceptions-ApiConnectionException.md) | | +| [\YooKassa\Common\Exceptions\ApiException](../classes/YooKassa-Common-Exceptions-ApiException.md) | | +| [\YooKassa\Common\Exceptions\AuthorizeException](../classes/YooKassa-Common-Exceptions-AuthorizeException.md) | | +| [\YooKassa\Common\Exceptions\BadApiRequestException](../classes/YooKassa-Common-Exceptions-BadApiRequestException.md) | | +| [\YooKassa\Common\Exceptions\EmptyPropertyValueException](../classes/YooKassa-Common-Exceptions-EmptyPropertyValueException.md) | | +| [\YooKassa\Common\Exceptions\ExtensionNotFoundException](../classes/YooKassa-Common-Exceptions-ExtensionNotFoundException.md) | | +| [\YooKassa\Common\Exceptions\ForbiddenException](../classes/YooKassa-Common-Exceptions-ForbiddenException.md) | | +| [\YooKassa\Common\Exceptions\InternalServerError](../classes/YooKassa-Common-Exceptions-InternalServerError.md) | | +| [\YooKassa\Common\Exceptions\InvalidPropertyException](../classes/YooKassa-Common-Exceptions-InvalidPropertyException.md) | | +| [\YooKassa\Common\Exceptions\InvalidPropertyValueException](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueException.md) | | +| [\YooKassa\Common\Exceptions\InvalidPropertyValueTypeException](../classes/YooKassa-Common-Exceptions-InvalidPropertyValueTypeException.md) | | +| [\YooKassa\Common\Exceptions\InvalidRequestException](../classes/YooKassa-Common-Exceptions-InvalidRequestException.md) | | +| [\YooKassa\Common\Exceptions\JsonException](../classes/YooKassa-Common-Exceptions-JsonException.md) | | +| [\YooKassa\Common\Exceptions\NotFoundException](../classes/YooKassa-Common-Exceptions-NotFoundException.md) | | +| [\YooKassa\Common\Exceptions\ResponseProcessingException](../classes/YooKassa-Common-Exceptions-ResponseProcessingException.md) | | +| [\YooKassa\Common\Exceptions\TooManyRequestsException](../classes/YooKassa-Common-Exceptions-TooManyRequestsException.md) | | +| [\YooKassa\Common\Exceptions\UnauthorizedException](../classes/YooKassa-Common-Exceptions-UnauthorizedException.md) | | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-common.md b/docs/namespaces/yookassa-common.md new file mode 100644 index 00000000..b6721dc6 --- /dev/null +++ b/docs/namespaces/yookassa-common.md @@ -0,0 +1,38 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Common +## Parent: [\YooKassa](../namespaces/yookassa.md) +### Namespaces +* [\YooKassa\Common\Exceptions](../namespaces/yookassa-common-exceptions.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Common\AbstractEnum](../classes/YooKassa-Common-AbstractEnum.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Common\AbstractObject](../classes/YooKassa-Common-AbstractObject.md) | Базовый класс генерируемых объектов | +| [\YooKassa\Common\AbstractPaymentRequest](../classes/YooKassa-Common-AbstractPaymentRequest.md) | Класс объекта запроса к API | +| [\YooKassa\Common\AbstractPaymentRequestBuilder](../classes/YooKassa-Common-AbstractPaymentRequestBuilder.md) | Базовый класс объекта платежного запроса, передаваемого в методы клиента API | +| [\YooKassa\Common\AbstractRefundRequest](../classes/YooKassa-Common-AbstractRefundRequest.md) | Класс объекта запроса к API | +| [\YooKassa\Common\AbstractRequest](../classes/YooKassa-Common-AbstractRequest.md) | Базовый класс объекта запроса, передаваемого в методы клиента API | +| [\YooKassa\Common\AbstractRequestBuilder](../classes/YooKassa-Common-AbstractRequestBuilder.md) | Базовый класс билдера запросов | +| [\YooKassa\Common\HttpVerb](../classes/YooKassa-Common-HttpVerb.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Common\LoggerWrapper](../classes/YooKassa-Common-LoggerWrapper.md) | | +| [\YooKassa\Common\ResponseObject](../classes/YooKassa-Common-ResponseObject.md) | Класс HTTP ответа | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-helpers-config.md b/docs/namespaces/yookassa-helpers-config.md new file mode 100644 index 00000000..f277f23f --- /dev/null +++ b/docs/namespaces/yookassa-helpers-config.md @@ -0,0 +1,31 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Helpers\Config +## Parent: [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Helpers\Config\ConfigurationLoaderInterface](../classes/YooKassa-Helpers-Config-ConfigurationLoaderInterface.md) | | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Helpers\Config\ConfigurationLoader](../classes/YooKassa-Helpers-Config-ConfigurationLoader.md) | | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-helpers.md b/docs/namespaces/yookassa-helpers.md new file mode 100644 index 00000000..62ece7af --- /dev/null +++ b/docs/namespaces/yookassa-helpers.md @@ -0,0 +1,34 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Helpers +## Parent: [\YooKassa](../namespaces/yookassa.md) +### Namespaces +* [\YooKassa\Helpers\Config](../namespaces/yookassa-helpers-config.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Helpers\ProductCode](../classes/YooKassa-Helpers-ProductCode.md) | Класс для формирования тега 1162 на основе кода в формате Data Matrix | +| [\YooKassa\Helpers\Random](../classes/YooKassa-Helpers-Random.md) | Класс хэлпера для генерации случайных значений, используется в тестах | +| [\YooKassa\Helpers\RawHeadersParser](../classes/YooKassa-Helpers-RawHeadersParser.md) | | +| [\YooKassa\Helpers\StringObject](../classes/YooKassa-Helpers-StringObject.md) | Класс объекта, кастящегося в строку, используется только в тестах | +| [\YooKassa\Helpers\TypeCast](../classes/YooKassa-Helpers-TypeCast.md) | Класс хэлпер для преобразования типов значений | +| [\YooKassa\Helpers\UUID](../classes/YooKassa-Helpers-UUID.md) | | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-confirmation.md b/docs/namespaces/yookassa-model-confirmation.md new file mode 100644 index 00000000..35329e04 --- /dev/null +++ b/docs/namespaces/yookassa-model-confirmation.md @@ -0,0 +1,34 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\Confirmation +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\Confirmation\AbstractConfirmation](../classes/YooKassa-Model-Confirmation-AbstractConfirmation.md) | Способ подтверждения платежа. | +| [\YooKassa\Model\Confirmation\ConfirmationCodeVerification](../classes/YooKassa-Model-Confirmation-ConfirmationCodeVerification.md) | Сценарий при котором необходимо получить одноразовый код от плательщика для подтверждения платежа | +| [\YooKassa\Model\Confirmation\ConfirmationDeepLink](../classes/YooKassa-Model-Confirmation-ConfirmationDeepLink.md) | Сценарий при котором необходимо направить плательщика в приложение партнера | +| [\YooKassa\Model\Confirmation\ConfirmationEmbedded](../classes/YooKassa-Model-Confirmation-ConfirmationEmbedded.md) | Способ подтверждения платежа. | +| [\YooKassa\Model\Confirmation\ConfirmationExternal](../classes/YooKassa-Model-Confirmation-ConfirmationExternal.md) | Сценарий при котором необходимо ожидать пока пользователь самостоятельно подтвердит платеж. Например, пользователь подтверждает платеж ответом на SMS или в приложении партнера | +| [\YooKassa\Model\Confirmation\ConfirmationFactory](../classes/YooKassa-Model-Confirmation-ConfirmationFactory.md) | Class ConfirmationFactory | +| [\YooKassa\Model\Confirmation\ConfirmationQr](../classes/YooKassa-Model-Confirmation-ConfirmationQr.md) | Способ подтверждения платежа. | +| [\YooKassa\Model\Confirmation\ConfirmationRedirect](../classes/YooKassa-Model-Confirmation-ConfirmationRedirect.md) | Сценарий, при котором необходимо отправить плательщика на веб-страницу ЮKassa или партнера для подтверждения платежа | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-confirmationattributes.md b/docs/namespaces/yookassa-model-confirmationattributes.md new file mode 100644 index 00000000..4b9439ce --- /dev/null +++ b/docs/namespaces/yookassa-model-confirmationattributes.md @@ -0,0 +1,34 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\ConfirmationAttributes +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes](../classes/YooKassa-Model-ConfirmationAttributes-AbstractConfirmationAttributes.md) | Способ подтверждения платежа | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesCodeVerification](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesCodeVerification.md) | Сценарий при котором необходимо получить одноразовый код от плательщика для подтверждения платежа | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesDeepLink](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesDeepLink.md) | Сценарий при котором необходимо направить плательщика в приложение партнера | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesEmbedded](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesEmbedded.md) | Способ подтверждения платежа | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesExternal](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesExternal.md) | Сценарий при котором необходимо ожидать пока пользователь самостоятельно подтвердит платеж. Например, пользователь подтверждает платеж ответом на SMS или в приложении партнера | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesFactory](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesFactory.md) | Class ConfirmationAttributesFactory | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesQr](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesQr.md) | Способ подтверждения платежа | +| [\YooKassa\Model\ConfirmationAttributes\ConfirmationAttributesRedirect](../classes/YooKassa-Model-ConfirmationAttributes-ConfirmationAttributesRedirect.md) | Способ подтверждения платежа | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-notification.md b/docs/namespaces/yookassa-model-notification.md new file mode 100644 index 00000000..65b9471a --- /dev/null +++ b/docs/namespaces/yookassa-model-notification.md @@ -0,0 +1,36 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\Notification +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\Notification\NotificationInterface](../classes/YooKassa-Model-Notification-NotificationInterface.md) | | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\Notification\AbstractNotification](../classes/YooKassa-Model-Notification-AbstractNotification.md) | Базовый класс уведомлений | +| [\YooKassa\Model\Notification\NotificationCanceled](../classes/YooKassa-Model-Notification-NotificationCanceled.md) | Класс объекта, присылаемого API при изменении статуса платежа на "canceled" | +| [\YooKassa\Model\Notification\NotificationFactory](../classes/YooKassa-Model-Notification-NotificationFactory.md) | Фабрика для получения конкретного объекта уведомления. | +| [\YooKassa\Model\Notification\NotificationRefundSucceeded](../classes/YooKassa-Model-Notification-NotificationRefundSucceeded.md) | Класс объекта, присылаемого API при изменении статуса возврата на "succeeded" | +| [\YooKassa\Model\Notification\NotificationSucceeded](../classes/YooKassa-Model-Notification-NotificationSucceeded.md) | Класс объекта, присылаемого API при изменении статуса платежа на "succeeded" | +| [\YooKassa\Model\Notification\NotificationWaitingForCapture](../classes/YooKassa-Model-Notification-NotificationWaitingForCapture.md) | Класс объекта, присылаемого API при изменении статуса платежа на "waiting_for_capture" | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md b/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md new file mode 100644 index 00000000..c1a8c0e0 --- /dev/null +++ b/docs/namespaces/yookassa-model-paymentdata-b2b-sberbank.md @@ -0,0 +1,33 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PaymentData\B2b\Sberbank +## Parent: [\YooKassa\Model\PaymentData\B2b](../namespaces/yookassa-model-paymentdata-b2b.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataInterface](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataInterface.md) | Interface VatDataInterface | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatData](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatData.md) | Данные об НДС | +| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataRate](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataRate.md) | PaymentDataB2bSberbankVatDataRate - Налоговая ставка НДС |Код|Описание| --- | --- |7|7%| |10|10%| |18|18%| |20|20%| | +| [\YooKassa\Model\PaymentData\B2b\Sberbank\VatDataType](../classes/YooKassa-Model-PaymentData-B2b-Sberbank-VatDataType.md) | PaymentDataB2bSberbankVatDataType - Способ расчёта НДС |Код|Описание| --- | --- |calculated|Сумма НДС включена в сумму платежа| |mixed|Разные ставки НДС для разных товаров| |untaxed|Сумма платежа НДС не облагается| | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentdata-b2b.md b/docs/namespaces/yookassa-model-paymentdata-b2b.md new file mode 100644 index 00000000..df11625f --- /dev/null +++ b/docs/namespaces/yookassa-model-paymentdata-b2b.md @@ -0,0 +1,25 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PaymentData\B2b +## Parent: [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +### Namespaces +* [\YooKassa\Model\PaymentData\B2b\Sberbank](../namespaces/yookassa-model-paymentdata-b2b-sberbank.md) + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentdata.md b/docs/namespaces/yookassa-model-paymentdata.md new file mode 100644 index 00000000..bae7bc37 --- /dev/null +++ b/docs/namespaces/yookassa-model-paymentdata.md @@ -0,0 +1,45 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PaymentData +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Namespaces +* [\YooKassa\Model\PaymentData\B2b](../namespaces/yookassa-model-paymentdata-b2b.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PaymentData\AbstractPaymentData](../classes/YooKassa-Model-PaymentData-AbstractPaymentData.md) | Данные используемые для создания метода оплаты. | +| [\YooKassa\Model\PaymentData\PaymentDataAlfabank](../classes/YooKassa-Model-PaymentData-PaymentDataAlfabank.md) | PaymentDataAlfabank Платежные данные для проведения оплаты через Альфа Клик или Альфа Молнию. | +| [\YooKassa\Model\PaymentData\PaymentDataApplePay](../classes/YooKassa-Model-PaymentData-PaymentDataApplePay.md) | PaymentDataApplePay Платежные данные для проведения оплаты при помощи Apple Pay | +| [\YooKassa\Model\PaymentData\PaymentDataB2bSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataB2bSberbank.md) | PaymentDataB2BSberbank Платежные данные для проведения оплаты при помощи Сбербанк Бизнес Онлайн. | +| [\YooKassa\Model\PaymentData\PaymentDataBankCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCard.md) | PaymentDataBankCard Платежные данные для проведения оплаты при помощи банковской карты | +| [\YooKassa\Model\PaymentData\PaymentDataBankCardCard](../classes/YooKassa-Model-PaymentData-PaymentDataBankCardCard.md) | Данные банковской карты Необходим при оплате PCI-DSS данными. | +| [\YooKassa\Model\PaymentData\PaymentDataCash](../classes/YooKassa-Model-PaymentData-PaymentDataCash.md) | PaymentDataCash Платежные данные для проведения оплаты Qiwi. | +| [\YooKassa\Model\PaymentData\PaymentDataFactory](../classes/YooKassa-Model-PaymentData-PaymentDataFactory.md) | Фабрика создания объекта платежных данных из массива | +| [\YooKassa\Model\PaymentData\PaymentDataGooglePay](../classes/YooKassa-Model-PaymentData-PaymentDataGooglePay.md) | PaymentDataGooglePay Платежные данные для проведения оплаты при помощи Google Pay. | +| [\YooKassa\Model\PaymentData\PaymentDataInstallments](../classes/YooKassa-Model-PaymentData-PaymentDataInstallments.md) | Данные для проведения оплаты по частям | +| [\YooKassa\Model\PaymentData\PaymentDataMobileBalance](../classes/YooKassa-Model-PaymentData-PaymentDataMobileBalance.md) | PaymentDataMobileBalance Платежные данные для проведения оплаты Qiwi. | +| [\YooKassa\Model\PaymentData\PaymentDataQiwi](../classes/YooKassa-Model-PaymentData-PaymentDataQiwi.md) | PaymentDataQiwi Платежные данные для проведения оплаты Qiwi. | +| [\YooKassa\Model\PaymentData\PaymentDataSberbank](../classes/YooKassa-Model-PaymentData-PaymentDataSberbank.md) | PaymentDataSberbank Платежные данные для проведения оплаты при помощи Сбербанк Онлайн. | +| [\YooKassa\Model\PaymentData\PaymentDataTinkoffBank](../classes/YooKassa-Model-PaymentData-PaymentDataTinkoffBank.md) | Данные используемые для создания метода оплаты. | +| [\YooKassa\Model\PaymentData\PaymentDataWebmoney](../classes/YooKassa-Model-PaymentData-PaymentDataWebmoney.md) | PaymentDataWebmoney Платежные данные для проведения оплаты Webmoney. | +| [\YooKassa\Model\PaymentData\PaymentDataWechat](../classes/YooKassa-Model-PaymentData-PaymentDataWechat.md) | Данные используемые для создания метода оплаты. | +| [\YooKassa\Model\PaymentData\PaymentDataYooMoney](../classes/YooKassa-Model-PaymentData-PaymentDataYooMoney.md) | Данные для проведения оплаты через ЮMoney | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md b/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md new file mode 100644 index 00000000..8b1509eb --- /dev/null +++ b/docs/namespaces/yookassa-model-paymentmethod-b2b-sberbank.md @@ -0,0 +1,31 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PaymentMethod\B2b\Sberbank +## Parent: [\YooKassa\Model\PaymentMethod\B2b](../namespaces/yookassa-model-paymentmethod-b2b.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetailsInterface](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetailsInterface.md) | Interface PayerBankDetailsInterface | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails](../classes/YooKassa-Model-PaymentMethod-B2b-Sberbank-PayerBankDetails.md) | Банковские реквизиты плательщика | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentmethod-b2b.md b/docs/namespaces/yookassa-model-paymentmethod-b2b.md new file mode 100644 index 00000000..d4839771 --- /dev/null +++ b/docs/namespaces/yookassa-model-paymentmethod-b2b.md @@ -0,0 +1,25 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PaymentMethod\B2b +## Parent: [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +### Namespaces +* [\YooKassa\Model\PaymentMethod\B2b\Sberbank](../namespaces/yookassa-model-paymentmethod-b2b-sberbank.md) + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-paymentmethod.md b/docs/namespaces/yookassa-model-paymentmethod.md new file mode 100644 index 00000000..32ec7f31 --- /dev/null +++ b/docs/namespaces/yookassa-model-paymentmethod.md @@ -0,0 +1,47 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\PaymentMethod +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Namespaces +* [\YooKassa\Model\PaymentMethod\B2b](../namespaces/yookassa-model-paymentmethod-b2b.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\PaymentMethod\AbstractPaymentMethod](../classes/YooKassa-Model-PaymentMethod-AbstractPaymentMethod.md) | Абстрактный класс, описывающий основные свойства и методы платежных методов | +| [\YooKassa\Model\PaymentMethod\BankCardSource](../classes/YooKassa-Model-PaymentMethod-BankCardSource.md) | BankCardSource - Источник данных банковской карты |Код|Описание| --- | --- |apple_pay|Источник данных apple_pay| |google_pay|Источник данных google_pay| | +| [\YooKassa\Model\PaymentMethod\PaymentMethodAlfaBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodAlfaBank.md) | Класс, описывающий метод оплаты, при оплате через Альфа Банк | +| [\YooKassa\Model\PaymentMethod\PaymentMethodApplePay](../classes/YooKassa-Model-PaymentMethod-PaymentMethodApplePay.md) | Класс, описывающий метод оплаты, при оплате через Apple Pay | +| [\YooKassa\Model\PaymentMethod\PaymentMethodB2bSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodB2bSberbank.md) | Класс, описывающий метод оплаты, при оплате через Сбербанк Бизнес Онлайн | +| [\YooKassa\Model\PaymentMethod\PaymentMethodBankCard](../classes/YooKassa-Model-PaymentMethod-PaymentMethodBankCard.md) | Класс, описывающий метод оплаты банковской картой | +| [\YooKassa\Model\PaymentMethod\PaymentMethodCardType](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCardType.md) | Тип банковской карты. Возможные значения: - `MasterCard` (для карт Mastercard и Maestro), - `Visa` (для карт Visa и Visa Electron), - `Mir`, - `UnionPay`, - `JCB`, - `AmericanExpress`, - `DinersClub` - `Unknown`. | +| [\YooKassa\Model\PaymentMethod\PaymentMethodCash](../classes/YooKassa-Model-PaymentMethod-PaymentMethodCash.md) | Класс, описывающий метод оплаты, при оплате наличными через терминал | +| [\YooKassa\Model\PaymentMethod\PaymentMethodFactory](../classes/YooKassa-Model-PaymentMethod-PaymentMethodFactory.md) | Фабрика создания объекта платежных методов из массива | +| [\YooKassa\Model\PaymentMethod\PaymentMethodGooglePay](../classes/YooKassa-Model-PaymentMethod-PaymentMethodGooglePay.md) | Класс, описывающий метод оплаты, при оплате через Google Pay | +| [\YooKassa\Model\PaymentMethod\PaymentMethodInstallments](../classes/YooKassa-Model-PaymentMethod-PaymentMethodInstallments.md) | Класс, описывающий метод оплаты при оплате по частям | +| [\YooKassa\Model\PaymentMethod\PaymentMethodMobileBalance](../classes/YooKassa-Model-PaymentMethod-PaymentMethodMobileBalance.md) | Класс, описывающий метод оплаты, при оплате с баланса мобильного телефона | +| [\YooKassa\Model\PaymentMethod\PaymentMethodPsb](../classes/YooKassa-Model-PaymentMethod-PaymentMethodPsb.md) | Абстрактный класс, описывающий основные свойства и методы платежных методов | +| [\YooKassa\Model\PaymentMethod\PaymentMethodQiwi](../classes/YooKassa-Model-PaymentMethod-PaymentMethodQiwi.md) | Класс, описывающий метод оплаты, при оплате через Qiwi | +| [\YooKassa\Model\PaymentMethod\PaymentMethodSberbank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodSberbank.md) | Класс, описывающий метод оплаты, при оплате через Сбербанк Онлайн | +| [\YooKassa\Model\PaymentMethod\PaymentMethodTinkoffBank](../classes/YooKassa-Model-PaymentMethod-PaymentMethodTinkoffBank.md) | Класс, описывающий метод оплаты, при оплате через Tinkoff | +| [\YooKassa\Model\PaymentMethod\PaymentMethodWebmoney](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWebmoney.md) | Класс, описывающий метод оплаты, при оплате через Webmoney. | +| [\YooKassa\Model\PaymentMethod\PaymentMethodWechat](../classes/YooKassa-Model-PaymentMethod-PaymentMethodWechat.md) | Абстрактный класс, описывающий основные свойства и методы платежных методов | +| [\YooKassa\Model\PaymentMethod\PaymentMethodYooMoney](../classes/YooKassa-Model-PaymentMethod-PaymentMethodYooMoney.md) | Класс, описывающий метод оплаты, при оплате через ЮMoney | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-receipt.md b/docs/namespaces/yookassa-model-receipt.md new file mode 100644 index 00000000..9bb3c6d6 --- /dev/null +++ b/docs/namespaces/yookassa-model-receipt.md @@ -0,0 +1,31 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\Receipt +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\Receipt\AgentType](../classes/YooKassa-Model-Receipt-AgentType.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Model\Receipt\PaymentMode](../classes/YooKassa-Model-Receipt-PaymentMode.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Model\Receipt\PaymentSubject](../classes/YooKassa-Model-Receipt-PaymentSubject.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Model\Receipt\ReceiptItemAmount](../classes/YooKassa-Model-Receipt-ReceiptItemAmount.md) | Class ReceiptItemAmount | +| [\YooKassa\Model\Receipt\SettlementType](../classes/YooKassa-Model-Receipt-SettlementType.md) | Базовый класс генерируемых enum'ов | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model-webhook.md b/docs/namespaces/yookassa-model-webhook.md new file mode 100644 index 00000000..e85e05d5 --- /dev/null +++ b/docs/namespaces/yookassa-model-webhook.md @@ -0,0 +1,27 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model\Webhook +## Parent: [\YooKassa\Model](../namespaces/yookassa-model.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\Webhook\Webhook](../classes/YooKassa-Model-Webhook-Webhook.md) | Класс Webhook содержит информацию о подписке на одно событие | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-model.md b/docs/namespaces/yookassa-model.md new file mode 100644 index 00000000..08369875 --- /dev/null +++ b/docs/namespaces/yookassa-model.md @@ -0,0 +1,84 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Model +## Parent: [\YooKassa](../namespaces/yookassa.md) +### Namespaces +* [\YooKassa\Model\Confirmation](../namespaces/yookassa-model-confirmation.md) +* [\YooKassa\Model\ConfirmationAttributes](../namespaces/yookassa-model-confirmationattributes.md) +* [\YooKassa\Model\Notification](../namespaces/yookassa-model-notification.md) +* [\YooKassa\Model\PaymentData](../namespaces/yookassa-model-paymentdata.md) +* [\YooKassa\Model\PaymentMethod](../namespaces/yookassa-model-paymentmethod.md) +* [\YooKassa\Model\Receipt](../namespaces/yookassa-model-receipt.md) +* [\YooKassa\Model\Webhook](../namespaces/yookassa-model-webhook.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\AirlineInterface](../classes/YooKassa-Model-AirlineInterface.md) | | +| [\YooKassa\Model\AmountInterface](../classes/YooKassa-Model-AmountInterface.md) | Interface AmountInterface | +| [\YooKassa\Model\AuthorizationDetailsInterface](../classes/YooKassa-Model-AuthorizationDetailsInterface.md) | Interface AuthorizationDetailsInterface - Данные об авторизации платежа | +| [\YooKassa\Model\CancellationDetailsInterface](../classes/YooKassa-Model-CancellationDetailsInterface.md) | Interface CancellationDetailsInterface | +| [\YooKassa\Model\LegInterface](../classes/YooKassa-Model-LegInterface.md) | | +| [\YooKassa\Model\PassengerInterface](../classes/YooKassa-Model-PassengerInterface.md) | | +| [\YooKassa\Model\PaymentInterface](../classes/YooKassa-Model-PaymentInterface.md) | Interface PaymentInterface | +| [\YooKassa\Model\ReceiptCustomerInterface](../classes/YooKassa-Model-ReceiptCustomerInterface.md) | Interface ReceiptCustomerInterface | +| [\YooKassa\Model\ReceiptInterface](../classes/YooKassa-Model-ReceiptInterface.md) | Interface ReceiptInterface | +| [\YooKassa\Model\ReceiptItemInterface](../classes/YooKassa-Model-ReceiptItemInterface.md) | Interface ReceiptItemInterface | +| [\YooKassa\Model\RecipientInterface](../classes/YooKassa-Model-RecipientInterface.md) | Интерфейс получателя платежа. | +| [\YooKassa\Model\RefundInterface](../classes/YooKassa-Model-RefundInterface.md) | Interface RefundInterface | +| [\YooKassa\Model\RequestorInterface](../classes/YooKassa-Model-RequestorInterface.md) | Interface RequestorInterface | +| [\YooKassa\Model\SettlementInterface](../classes/YooKassa-Model-SettlementInterface.md) | Interface PostReceiptResponseSettlementInterface | +| [\YooKassa\Model\SourceInterface](../classes/YooKassa-Model-SourceInterface.md) | Interface TransferInterface | +| [\YooKassa\Model\SupplierInterface](../classes/YooKassa-Model-SupplierInterface.md) | Interface SupplierInterface | +| [\YooKassa\Model\TransferInterface](../classes/YooKassa-Model-TransferInterface.md) | Interface TransferInterface | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Model\Airline](../classes/YooKassa-Model-Airline.md) | Класс описывающий авиабилет | +| [\YooKassa\Model\AuthorizationDetails](../classes/YooKassa-Model-AuthorizationDetails.md) | AuthorizationDetails - Данные об авторизации платежа | +| [\YooKassa\Model\CancellationDetails](../classes/YooKassa-Model-CancellationDetails.md) | CancellationDetails - Комментарий к отмене платежа | +| [\YooKassa\Model\CancellationDetailsPartyCode](../classes/YooKassa-Model-CancellationDetailsPartyCode.md) | CancellationDetailsPartyCode - Возможные инициаторы отмены платежа | +| [\YooKassa\Model\CancellationDetailsReasonCode](../classes/YooKassa-Model-CancellationDetailsReasonCode.md) | CancellationDetailsReasonCode - Возможные причины отмены платежа | +| [\YooKassa\Model\ConfirmationType](../classes/YooKassa-Model-ConfirmationType.md) | ConfirmationType - Тип пользовательского процесса подтверждения платежа |Код|Описание| --- | --- |redirect|Необходимо направить плательщика на страницу партнера| |external|Необходимо ождать пока плательщик самостоятельно подтвердит платеж| |deeplink|Необходимо направить плательщика в приложение партнера| |code_verification|Необходимо получить одноразовый код от плательщика для подтверждения платежа| |embedded|Необходимо получить токен для checkout.js| |qr|Необходимо получить QR-код| | +| [\YooKassa\Model\CurrencyCode](../classes/YooKassa-Model-CurrencyCode.md) | CurrencyCode - Код валюты, ISO-4217 3-alpha currency symbol | +| [\YooKassa\Model\Leg](../classes/YooKassa-Model-Leg.md) | Класс, описывающий маршрут | +| [\YooKassa\Model\Metadata](../classes/YooKassa-Model-Metadata.md) | Metadata - Метаданные платежа указанные мерчантом. | +| [\YooKassa\Model\MonetaryAmount](../classes/YooKassa-Model-MonetaryAmount.md) | MonetaryAmount - Сумма определенная в валюте | +| [\YooKassa\Model\NotificationEventType](../classes/YooKassa-Model-NotificationEventType.md) | NotificationEventType - Тип уведомления |Код|Описание| --- | --- |payment.waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| |payment.succeeded|Успешно оплачен и подтвержден магазином| |payment.canceled|Неуспех оплаты или отменен магазином| |refund.succeeded|Успешный возврат| | +| [\YooKassa\Model\NotificationType](../classes/YooKassa-Model-NotificationType.md) | Базовый класс генерируемых enum'ов | +| [\YooKassa\Model\Passenger](../classes/YooKassa-Model-Passenger.md) | Класс описывающий данные пассажира | +| [\YooKassa\Model\Payment](../classes/YooKassa-Model-Payment.md) | Payment - Данные о платеже | +| [\YooKassa\Model\PaymentMethodType](../classes/YooKassa-Model-PaymentMethodType.md) | PaymentMethodType - Тип источника средств для проведения платежа |Код|Описание| --- | --- |yoo_money|Платеж из кошелька ЮMoney| |bank_card|Платеж с произвольной банковской карты| |sberbank|Платеж СбербанкОнлайн| |cash|Платеж наличными| |mobile_balance|Платеж с баланса мобильного телефона| |apple_pay|Платеж ApplePay| |google_pay|Платеж Google Pay| |qiwi|Платеж из кошелька Qiwi| |webmoney|Платеж из кошелька Webmoney| |alfabank|Платеж через Альфа-Клик| |b2b_sberbank|Сбербанк Бизнес Онлайн| |tinkoff_bank|Интернет-банк Тинькофф| |psb|ПромсвязьБанк| |installments|Заплатить по частям| |wechat|Платеж через WeChat| | +| [\YooKassa\Model\PaymentStatus](../classes/YooKassa-Model-PaymentStatus.md) | PaymentStatus - Состояние платежа |Код|Описание| --- | --- |pending|Ожидает оплаты покупателем| |waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| |succeeded|Успешно оплачен и подтвержден магазином| |canceled|Неуспех оплаты или отменен магазином (cancel)| | +| [\YooKassa\Model\Receipt](../classes/YooKassa-Model-Receipt.md) | Класс данных для формирования чека в онлайн-кассе (для соблюдения 54-ФЗ) | +| [\YooKassa\Model\ReceiptCustomer](../classes/YooKassa-Model-ReceiptCustomer.md) | Информация о плательщике | +| [\YooKassa\Model\ReceiptItem](../classes/YooKassa-Model-ReceiptItem.md) | Информация о товарной позиции в заказе, позиция фискального чека | +| [\YooKassa\Model\ReceiptRegistrationStatus](../classes/YooKassa-Model-ReceiptRegistrationStatus.md) | Класс с перечислением статусов доставки данных для чека в онлайн-кассу (`pending`, `succeeded` или `canceled`) | +| [\YooKassa\Model\ReceiptType](../classes/YooKassa-Model-ReceiptType.md) | ReceiptType - Тип чека в онлайн-кассе. | +| [\YooKassa\Model\Recipient](../classes/YooKassa-Model-Recipient.md) | Класс получателя платежа. | +| [\YooKassa\Model\Refund](../classes/YooKassa-Model-Refund.md) | Класс объекта с информацией о возврате платежа | +| [\YooKassa\Model\RefundStatus](../classes/YooKassa-Model-RefundStatus.md) | RefundStatus - Состояние возврата платежа |Код|Описание| --- | --- |pending|Ожидает обработки| |succeeded|Успешно возвращен| |canceled|В проведении возврата отказано| | +| [\YooKassa\Model\Requestor](../classes/YooKassa-Model-Requestor.md) | Инициатор платежа или возврата. | +| [\YooKassa\Model\Settlement](../classes/YooKassa-Model-Settlement.md) | Class Settlement | +| [\YooKassa\Model\Source](../classes/YooKassa-Model-Source.md) | Класс объекта распределения денег в магазин | +| [\YooKassa\Model\Supplier](../classes/YooKassa-Model-Supplier.md) | Информация о поставщике товара или услуги. | +| [\YooKassa\Model\Transfer](../classes/YooKassa-Model-Transfer.md) | Класс объекта распределения денег в магазин | +| [\YooKassa\Model\TransferStatus](../classes/YooKassa-Model-TransferStatus.md) | PaymentStatus - Статус операции распределения средств конечному получателю |Код|Описание| --- | --- |pending|Ожидает оплаты покупателем| |waiting_for_capture|Успешно оплачен покупателем, ожидает подтверждения магазином (capture или aviso)| |succeeded|Успешно оплачен и получен магазином| |canceled|Неуспех оплаты или отменен магазином (cancel)| | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-payments-payment.md b/docs/namespaces/yookassa-request-payments-payment.md new file mode 100644 index 00000000..8b246af0 --- /dev/null +++ b/docs/namespaces/yookassa-request-payments-payment.md @@ -0,0 +1,35 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\Payments\Payment +## Parent: [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Payments\Payment\CreateCaptureRequestInterface](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestInterface.md) | Interface CreateCaptureRequestInterface | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Payments\Payment\CancelResponse](../classes/YooKassa-Request-Payments-Payment-CancelResponse.md) | Класс объекта ответа от API на запрос отмены платежа | +| [\YooKassa\Request\Payments\Payment\CreateCaptureRequest](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequest.md) | Класс объекта запроса к API на подтверждение оплаты | +| [\YooKassa\Request\Payments\Payment\CreateCaptureRequestBuilder](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestBuilder.md) | Базовый класс объекта платежного запроса, передаваемого в методы клиента API | +| [\YooKassa\Request\Payments\Payment\CreateCaptureRequestSerializer](../classes/YooKassa-Request-Payments-Payment-CreateCaptureRequestSerializer.md) | Класс объекта осуществляющего сериализацию запроса к API на подтверждение заказа | +| [\YooKassa\Request\Payments\Payment\CreateCaptureResponse](../classes/YooKassa-Request-Payments-Payment-CreateCaptureResponse.md) | Класс объекта ответа от API на запрос подтверждения платежа | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-payments.md b/docs/namespaces/yookassa-request-payments.md new file mode 100644 index 00000000..b79342a2 --- /dev/null +++ b/docs/namespaces/yookassa-request-payments.md @@ -0,0 +1,43 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\Payments +## Parent: [\YooKassa\Request](../namespaces/yookassa-request.md) +### Namespaces +* [\YooKassa\Request\Payments\Payment](../namespaces/yookassa-request-payments-payment.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Payments\CreatePaymentRequestInterface](../classes/YooKassa-Request-Payments-CreatePaymentRequestInterface.md) | Interface CreatePaymentRequestInterface | +| [\YooKassa\Request\Payments\PaymentsRequestInterface](../classes/YooKassa-Request-Payments-PaymentsRequestInterface.md) | Interface PaymentsRequestInterface | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Payments\AbstractPaymentResponse](../classes/YooKassa-Request-Payments-AbstractPaymentResponse.md) | Абстрактный класс ответа от API, возвращающего информацию о платеже | +| [\YooKassa\Request\Payments\CreatePaymentRequest](../classes/YooKassa-Request-Payments-CreatePaymentRequest.md) | Класс объекта запроса к API на проведение нового платежа | +| [\YooKassa\Request\Payments\CreatePaymentRequestBuilder](../classes/YooKassa-Request-Payments-CreatePaymentRequestBuilder.md) | Класс билдера объектов запрсов к API на создание платежа | +| [\YooKassa\Request\Payments\CreatePaymentRequestSerializer](../classes/YooKassa-Request-Payments-CreatePaymentRequestSerializer.md) | Класс сериалайзера объекта запроса к API на проведение платежа | +| [\YooKassa\Request\Payments\CreatePaymentResponse](../classes/YooKassa-Request-Payments-CreatePaymentResponse.md) | Класс объекта ответа возвращаемого API при запросе на создание платежа | +| [\YooKassa\Request\Payments\PaymentResponse](../classes/YooKassa-Request-Payments-PaymentResponse.md) | Класс объекта ответа, возвращаемого API при запросе конкретного платежа | +| [\YooKassa\Request\Payments\PaymentsRequest](../classes/YooKassa-Request-Payments-PaymentsRequest.md) | Класс объекта запроса к API для получения списка платежей магазина | +| [\YooKassa\Request\Payments\PaymentsRequestBuilder](../classes/YooKassa-Request-Payments-PaymentsRequestBuilder.md) | Класс билдера запросов к API для получения списка платежей магазина | +| [\YooKassa\Request\Payments\PaymentsRequestSerializer](../classes/YooKassa-Request-Payments-PaymentsRequestSerializer.md) | Класс сериализатора объектов запросов к API для получения списка платежей | +| [\YooKassa\Request\Payments\PaymentsResponse](../classes/YooKassa-Request-Payments-PaymentsResponse.md) | Класс объекта ответа от API со списком платежей магазина | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-receipts.md b/docs/namespaces/yookassa-request-receipts.md new file mode 100644 index 00000000..bde4af07 --- /dev/null +++ b/docs/namespaces/yookassa-request-receipts.md @@ -0,0 +1,46 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\Receipts +## Parent: [\YooKassa\Request](../namespaces/yookassa-request.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Receipts\CreatePostReceiptRequestInterface](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestInterface.md) | Interface CreateReceiptRequestInterface | +| [\YooKassa\Request\Receipts\ReceiptResponseInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseInterface.md) | Interface ReceiptInterface | +| [\YooKassa\Request\Receipts\ReceiptResponseItemInterface](../classes/YooKassa-Request-Receipts-ReceiptResponseItemInterface.md) | Interface ReceiptItemInterface | +| [\YooKassa\Request\Receipts\ReceiptsRequestInterface](../classes/YooKassa-Request-Receipts-ReceiptsRequestInterface.md) | Интерфейс объекта запроса списка возвратов | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Receipts\AbstractReceiptResponse](../classes/YooKassa-Request-Receipts-AbstractReceiptResponse.md) | Class AbstractReceipt | +| [\YooKassa\Request\Receipts\CreatePostReceiptRequest](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequest.md) | Класс объекта запроса к API на создание чека | +| [\YooKassa\Request\Receipts\CreatePostReceiptRequestBuilder](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestBuilder.md) | Класс билдера объектов запрсов к API на создание чека | +| [\YooKassa\Request\Receipts\CreatePostReceiptRequestSerializer](../classes/YooKassa-Request-Receipts-CreatePostReceiptRequestSerializer.md) | Класс сериалайзера объекта запроса к API создание чека | +| [\YooKassa\Request\Receipts\PaymentReceiptResponse](../classes/YooKassa-Request-Receipts-PaymentReceiptResponse.md) | Класс описывающий чек, привязанный к платежу | +| [\YooKassa\Request\Receipts\ReceiptResponseFactory](../classes/YooKassa-Request-Receipts-ReceiptResponseFactory.md) | Фабричный класс для работы с чеками | +| [\YooKassa\Request\Receipts\ReceiptResponseItem](../classes/YooKassa-Request-Receipts-ReceiptResponseItem.md) | Класс, описывающий товар в чеке | +| [\YooKassa\Request\Receipts\ReceiptsRequest](../classes/YooKassa-Request-Receipts-ReceiptsRequest.md) | Класс объекта запроса к API списка возвратов магазина | +| [\YooKassa\Request\Receipts\ReceiptsRequestBuilder](../classes/YooKassa-Request-Receipts-ReceiptsRequestBuilder.md) | Класс билдера объектов запросов к API списка чеков | +| [\YooKassa\Request\Receipts\ReceiptsRequestSerializer](../classes/YooKassa-Request-Receipts-ReceiptsRequestSerializer.md) | Класс сериализатора объектов запросов к API для получения списка возвратов | +| [\YooKassa\Request\Receipts\ReceiptsResponse](../classes/YooKassa-Request-Receipts-ReceiptsResponse.md) | Класс для работы со списком чеков | +| [\YooKassa\Request\Receipts\RefundReceiptResponse](../classes/YooKassa-Request-Receipts-RefundReceiptResponse.md) | Класс описывающий чек, привязанный к возврату | +| [\YooKassa\Request\Receipts\SimpleReceiptResponse](../classes/YooKassa-Request-Receipts-SimpleReceiptResponse.md) | Класс описывающий чек, не привязанный ни к платежу ни к возврату | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-refunds.md b/docs/namespaces/yookassa-request-refunds.md new file mode 100644 index 00000000..58fbbe45 --- /dev/null +++ b/docs/namespaces/yookassa-request-refunds.md @@ -0,0 +1,41 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\Refunds +## Parent: [\YooKassa\Request](../namespaces/yookassa-request.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Refunds\CreateRefundRequestInterface](../classes/YooKassa-Request-Refunds-CreateRefundRequestInterface.md) | Интерфейс объекта запроса на возврат | +| [\YooKassa\Request\Refunds\RefundsRequestInterface](../classes/YooKassa-Request-Refunds-RefundsRequestInterface.md) | Интерфейс объекта запроса списка возвратов | +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Refunds\AbstractRefundResponse](../classes/YooKassa-Request-Refunds-AbstractRefundResponse.md) | Абстрактный класс ответа от API с информацией о возврате | +| [\YooKassa\Request\Refunds\CreateRefundRequest](../classes/YooKassa-Request-Refunds-CreateRefundRequest.md) | Класс объекта запроса для создания возврата | +| [\YooKassa\Request\Refunds\CreateRefundRequestBuilder](../classes/YooKassa-Request-Refunds-CreateRefundRequestBuilder.md) | Класс билдера запросов к API на создание возврата средств | +| [\YooKassa\Request\Refunds\CreateRefundRequestSerializer](../classes/YooKassa-Request-Refunds-CreateRefundRequestSerializer.md) | Класс сериалайзера запросов к API на создание нового возврата средств | +| [\YooKassa\Request\Refunds\CreateRefundResponse](../classes/YooKassa-Request-Refunds-CreateRefundResponse.md) | Класс объекта ответа от API при создании нового возврата | +| [\YooKassa\Request\Refunds\RefundResponse](../classes/YooKassa-Request-Refunds-RefundResponse.md) | Класс объекта ответа от API при запросе одного конкретного возврата | +| [\YooKassa\Request\Refunds\RefundsRequest](../classes/YooKassa-Request-Refunds-RefundsRequest.md) | Класс объекта запроса к API списка возвратов магазина | +| [\YooKassa\Request\Refunds\RefundsRequestBuilder](../classes/YooKassa-Request-Refunds-RefundsRequestBuilder.md) | Класс билдера объектов запросов к API списка возвратов | +| [\YooKassa\Request\Refunds\RefundsRequestSerializer](../classes/YooKassa-Request-Refunds-RefundsRequestSerializer.md) | Класс сериализатора объектов запросов к API для получения списка возвратов | +| [\YooKassa\Request\Refunds\RefundsResponse](../classes/YooKassa-Request-Refunds-RefundsResponse.md) | Класс объекта ответа от API со списком возвратов магазина | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request-webhook.md b/docs/namespaces/yookassa-request-webhook.md new file mode 100644 index 00000000..53b0e1a4 --- /dev/null +++ b/docs/namespaces/yookassa-request-webhook.md @@ -0,0 +1,27 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request\Webhook +## Parent: [\YooKassa\Request](../namespaces/yookassa-request.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Request\Webhook\WebhookListResponse](../classes/YooKassa-Request-Webhook-WebhookListResponse.md) | Актуальный список объектов webhook для переданного OAuth-токена | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa-request.md b/docs/namespaces/yookassa-request.md new file mode 100644 index 00000000..80991d01 --- /dev/null +++ b/docs/namespaces/yookassa-request.md @@ -0,0 +1,28 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa\Request +## Parent: [\YooKassa](../namespaces/yookassa.md) +### Namespaces +* [\YooKassa\Request\Payments](../namespaces/yookassa-request-payments.md) +* [\YooKassa\Request\Receipts](../namespaces/yookassa-request-receipts.md) +* [\YooKassa\Request\Refunds](../namespaces/yookassa-request-refunds.md) +* [\YooKassa\Request\Webhook](../namespaces/yookassa-request-webhook.md) + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/namespaces/yookassa.md b/docs/namespaces/yookassa.md new file mode 100644 index 00000000..080fdc9b --- /dev/null +++ b/docs/namespaces/yookassa.md @@ -0,0 +1,33 @@ +# [YooKassa API SDK](../home.md) + +# Namespace: \YooKassa +## Parent: [default](../namespaces/default.md) +### Namespaces +* [\YooKassa\Client](../namespaces/yookassa-client.md) +* [\YooKassa\Common](../namespaces/yookassa-common.md) +* [\YooKassa\Helpers](../namespaces/yookassa-helpers.md) +* [\YooKassa\Model](../namespaces/yookassa-model.md) +* [\YooKassa\Request](../namespaces/yookassa-request.md) +### Classes +| Name | Summary | +| ---- | ------- | +| [\YooKassa\Client](../classes/YooKassa-Client.md) | Класс клиента API | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 00000000..7847d900 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,50 @@ +# [YooKassa API SDK](home.md) + +# Namespace: \ +### Namespaces +* [\YooKassa](namespaces/yookassa.md) +### Interfaces +| Name | Summary | +| ---- | ------- | +| [\JsonSerializable](classes/JsonSerializable.md) | | +### Functions + +#### yookassaSdkLoadClass() : mixed + +```php + yookassaSdkLoadClass(mixed className) : mixed +``` + +**Details:** +* File: [lib/autoload.php](files/lib-autoload.md) +##### Parameters: +| Type | Name | Description | +| ---- | ---- | ----------- | +| mixed | className | | + +**Returns:** mixed - + +##### Tags +| Tag | Version | Description | +| --- | ------- | ----------- | +| package | | | + + +--- + +### Top Namespaces + +* [\YooKassa](namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](reports/errors.md) +* [Markers - 0](reports/markers.md) +* [Deprecated - 7](reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/reports/deprecated.md b/docs/reports/deprecated.md new file mode 100644 index 00000000..da694113 --- /dev/null +++ b/docs/reports/deprecated.md @@ -0,0 +1,51 @@ +# [YooKassa API SDK](../home.md) + +# Deprecated Elements +### Table of Contents +* [lib/Model/PaymentData/PaymentDataWechat.php](../../lib/Model/PaymentData/PaymentDataWechat.php) +* [lib/Model/PaymentMethod/PaymentMethodWechat.php](../../lib/Model/PaymentMethod/PaymentMethodWechat.php) +* [lib/Model/PaymentMethodType.php](../../lib/Model/PaymentMethodType.php) +* [lib/Model/Receipt.php](../../lib/Model/Receipt.php) + + +#### [lib/Model/PaymentData/PaymentDataWechat.php](../../lib/Model/PaymentData/PaymentDataWechat.php) +| Line | Element | Description | +| ---- | ------- | ----------- | +| 34 | \YooKassa\Model\PaymentData\PaymentDataWechat | Класс будет удалён в одной из будущих версий. | + +#### [lib/Model/PaymentMethod/PaymentMethodWechat.php](../../lib/Model/PaymentMethod/PaymentMethodWechat.php) +| Line | Element | Description | +| ---- | ------- | ----------- | +| 34 | \YooKassa\Model\PaymentMethod\PaymentMethodWechat | Класс будет удалён в одной из будущих версий. | + +#### [lib/Model/PaymentMethodType.php](../../lib/Model/PaymentMethodType.php) +| Line | Element | Description | +| ---- | ------- | ----------- | +| 85 | \YooKassa\Model\PaymentMethodType::WECHAT | Будет удален в следующих версиях | + +#### [lib/Model/Receipt.php](../../lib/Model/Receipt.php) +| Line | Element | Description | +| ---- | ------- | ----------- | +| 377 | \YooKassa\Model\Receipt::getPhone() | Устарел — данные рекомендуется брать в параметре receipt.customer.phone. | +| 391 | \YooKassa\Model\Receipt::setPhone() | Устарел — данные рекомендуется передавать в параметре receipt.customer.phone. | +| 406 | \YooKassa\Model\Receipt::getEmail() | Устарел — данные рекомендуется брать в параметре receipt.customer.email. | +| 420 | \YooKassa\Model\Receipt::setEmail() | Устарел — данные рекомендуется передавать в параметре receipt.customer.email. | + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/reports/errors.md b/docs/reports/errors.md new file mode 100644 index 00000000..7266fad4 --- /dev/null +++ b/docs/reports/errors.md @@ -0,0 +1,23 @@ +# [YooKassa API SDK](../home.md) + +# Compilation Errors +**No errors have been found in this project.** + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/docs/reports/markers.md b/docs/reports/markers.md new file mode 100644 index 00000000..45e21d52 --- /dev/null +++ b/docs/reports/markers.md @@ -0,0 +1,23 @@ +# [YooKassa API SDK](../home.md) + +# Markers +**No markers have been found in this project.** + +--- + +### Top Namespaces + +* [\YooKassa](../namespaces/yookassa.md) + +--- + +### Reports +* [Errors - 0](../reports/errors.md) +* [Markers - 0](../reports/markers.md) +* [Deprecated - 7](../reports/deprecated.md) + +--- + +This document was automatically generated from source code comments on 2021-04-21 using [phpDocumentor](http://www.phpdoc.org/) + +© 2021 YooMoney \ No newline at end of file diff --git a/lib/Client.php b/lib/Client.php index 805b9aff..1bd9bbe8 100644 --- a/lib/Client.php +++ b/lib/Client.php @@ -65,6 +65,7 @@ use YooKassa\Request\Receipts\CreatePostReceiptRequest; use YooKassa\Request\Receipts\CreatePostReceiptRequestInterface; use YooKassa\Request\Receipts\CreatePostReceiptRequestSerializer; use YooKassa\Request\Receipts\ReceiptResponseFactory; +use YooKassa\Request\Receipts\ReceiptResponseInterface; use YooKassa\Request\Receipts\ReceiptsRequest; use YooKassa\Request\Receipts\ReceiptsRequestSerializer; use YooKassa\Request\Receipts\ReceiptsResponse; @@ -82,6 +83,8 @@ use YooKassa\Request\Webhook\WebhookListResponse; /** * Класс клиента API * + * @example 01-client.php 3 7 Создание клиента + * * @package YooKassa * * @since 1.0.1 @@ -91,10 +94,18 @@ class Client extends BaseClient /** * Текущая версия библиотеки */ - const SDK_VERSION = '2.0.7'; + const SDK_VERSION = '2.1.0'; /** - * Получить список платежей магазина. + * Получить список платежей магазина + * + * Запрос позволяет получить список платежей, отфильтрованный по заданным критериям. + * В ответ на запрос вернется список платежей с учетом переданных параметров. В списке будет информация о платежах, + * созданных за последние 3 года. Список будет отсортирован по времени создания платежей в порядке убывания. + * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе + * на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + * + * @example 01-client.php 226 23 Получить список платежей магазина с фильтрацией * * @param PaymentsRequestInterface|array|null $filter * @@ -160,6 +171,8 @@ class Client extends BaseClient *
  • metadata — дополнительные данные (передаются магазином).
  • * * + * @example 01-client.php 21 28 Запрос на создание платежа + * * @param CreatePaymentRequestInterface|array $payment * @param string|null $idempotenceKey {@link https://yookassa.ru/developers/using-api/basics?lang=php#idempotence} * @@ -209,7 +222,10 @@ class Client extends BaseClient /** * Получить информацию о платеже * - * Выдает объект платежа {@link PaymentInterface} по его уникальному идентификатору. + * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору. + * Выдает объект платежа {@link PaymentInterface} в актуальном статусе. + * + * @example 01-client.php 162 8 Получить информацию о платеже * * @param string $paymentId * @@ -260,6 +276,8 @@ class Client extends BaseClient * у вас есть 7 дней на подтверждение платежа. Для остальных способов оплаты платеж необходимо подтвердить * в течение 6 часов. * + * @example 01-client.php 51 34 Подтверждение платежа + * * @param CreateCaptureRequestInterface|array $captureRequest * @param $paymentId * @param $idempotencyKey {@link https://yookassa.ru/developers/using-api/basics?lang=php#idempotence} @@ -323,6 +341,8 @@ class Client extends BaseClient * возвращать деньги на счет плательщика. Для платежей банковскими картами отмена происходит мгновенно. * Для остальных способов оплаты возврат может занимать до нескольких дней. * + * @example 01-client.php 87 9 Отменить незавершенную оплату заказа + * * @param $paymentId * @param $idempotencyKey {@link https://yookassa.ru/developers/using-api/basics?lang=php#idempotence} * @@ -371,6 +391,14 @@ class Client extends BaseClient /** * Получить список возвратов платежей * + * Запрос позволяет получить список возвратов, отфильтрованный по заданным критериям. + * В ответ на запрос вернется список возвратов с учетом переданных параметров. В списке будет информация о возвратах, + * созданных за последние 3 года. Список будет отсортирован по времени создания возвратов в порядке убывания. + * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. В этом случае в ответе + * на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + * + * @example 01-client.php 274 23 Получить список возвратов платежей магазина с фильтрацией + * * @param RefundsRequestInterface|array|null $filter * * @return RefundsResponse @@ -383,6 +411,7 @@ class Client extends BaseClient * @throws TooManyRequestsException * @throws UnauthorizedException * @throws ExtensionNotFoundException + * @throws Exception */ public function getRefunds($filter = null) { @@ -418,6 +447,8 @@ class Client extends BaseClient * этого платежа. Создание возврата возможно только для платежей в статусе `succeeded`. Комиссии за проведение * возврата нет. Комиссия, которую ЮKassa берёт за проведение исходного платежа, не возвращается. * + * @example 01-client.php 134 26 Запрос на создание возврата + * * @param CreateRefundRequestInterface|array $request * @param null $idempotencyKey {@link https://yookassa.ru/developers/using-api/basics?lang=php#idempotence} * @@ -467,6 +498,11 @@ class Client extends BaseClient /** * Получить информацию о возврате * + * Запрос позволяет получить информацию о текущем состоянии возврата по его уникальному идентификатору. + * В ответ на запрос придет объект возврата {@link RefundResponse} в актуальном статусе. + * + * @example 01-client.php 182 8 Получить информацию о возврате + * * @param $refundId * * @return RefundResponse @@ -479,6 +515,7 @@ class Client extends BaseClient * @throws TooManyRequestsException * @throws UnauthorizedException * @throws ExtensionNotFoundException + * @throws Exception */ public function getRefundInfo($refundId) { @@ -506,8 +543,11 @@ class Client extends BaseClient /** * Создание Webhook + * * Запрос позволяет подписаться на уведомления о событии (например, на переход платежа в статус successed). * + * @example 01-client.php 192 32 Создание Webhook + * * @param $request * @param null $idempotencyKey * @return Webhook|null @@ -561,7 +601,11 @@ class Client extends BaseClient /** * Удаление Webhook - * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. + * + * Запрос позволяет отписаться от уведомлений о событии для переданного OAuth-токена. + * Чтобы удалить webhook, вам нужно передать в запросе его идентификатор. + * + * @example 01-client.php 192 32 Удаление Webhook * * @param $webhookId * @param null $idempotencyKey @@ -605,8 +649,11 @@ class Client extends BaseClient /** * Список созданных Webhook + * * Запрос позволяет узнать, какие webhook есть для переданного OAuth-токена. * + * @example 01-client.php 192 32 Список созданных Webhook + * * @return WebhookListResponse|null * * @throws ApiException @@ -638,7 +685,16 @@ class Client extends BaseClient } /** - * Получить список платежей магазина. + * Получить список чеков магазина + * + * Запрос позволяет получить список чеков, отфильтрованный по заданным критериям. + * Можно запросить чеки по конкретному платежу, чеки по конкретному возврату или все чеки магазина. + * В ответ на запрос вернется список чеков с учетом переданных параметров. В списке будет информация о чеках, + * созданных за последние 3 года. Список будет отсортирован по времени создания чеков в порядке убывания. + * Если результатов больше, чем задано в `limit`, список будет выводиться фрагментами. + * В этом случае в ответе на запрос вернется фрагмент списка и параметр `next_cursor` с указателем на следующий фрагмент. + * + * @example 01-client.php 251 21 Получить список чеков магазина с фильтрацией * * @param PaymentInterface|RefundInterface|array|null $filter * @@ -683,6 +739,13 @@ class Client extends BaseClient } /** + * Отправка чека в облачную кассу + * + * Создает объект чека — `Receipt`. Возвращает успешно созданный чек по уникальному идентификатору + * платежа или возврата. + * + * @example 01-client.php 98 34 Запрос на создание чека + * * @param CreatePostReceiptRequestInterface|array $receipt * @param string|null $idempotenceKey * @@ -734,11 +797,62 @@ class Client extends BaseClient return $receiptResponse; } + /** + * Получить информацию о чеке + * + * Запрос позволяет получить информацию о текущем состоянии чека по его уникальному идентификатору. + * Выдает объект чека {@link ReceiptResponseInterface} в актуальном статусе. + * + * @example 01-client.php 172 8 Получить информацию о чеке + * + * @param string $receiptId + * + * @return ReceiptResponseInterface + * + * @throws ApiException + * @throws BadApiRequestException + * @throws ForbiddenException + * @throws InternalServerError + * @throws NotFoundException + * @throws ResponseProcessingException + * @throws TooManyRequestsException + * @throws UnauthorizedException + * @throws ExtensionNotFoundException + */ + public function getReceiptInfo($receiptId) + { + if ($receiptId === null) { + throw new \InvalidArgumentException('Missing the required parameter $receiptId'); + } elseif (!TypeCast::canCastToString($receiptId)) { + throw new \InvalidArgumentException('Invalid receiptId value: string required'); + } elseif (strlen($receiptId) !== 39) { + throw new \InvalidArgumentException('Invalid receiptId value'); + } + + $path = self::RECEIPTS_PATH.'/'.$receiptId; + + $response = $this->execute($path, HttpVerb::GET, null); + + $result = null; + if ($response->getCode() == 200) { + $resultArray = $this->decodeData($response); + $factory = new ReceiptResponseFactory(); + $result = $factory->factory($resultArray); + } else { + $this->handleError($response); + } + + return $result; + } + /** * Информация о магазине + * * Запрос позволяет получить информацию о магазине для переданного OAuth-токена. * - * @return array|null + * @example 01-client.php 12 7 Информация о магазине + * + * @return array|null Массив с информацией о магазине * * @throws ApiException * @throws BadApiRequestException diff --git a/lib/Client/ApiClientInterface.php b/lib/Client/ApiClientInterface.php index 40a0f262..e73cde87 100644 --- a/lib/Client/ApiClientInterface.php +++ b/lib/Client/ApiClientInterface.php @@ -27,52 +27,69 @@ namespace YooKassa\Client; use Psr\Log\LoggerInterface; +use YooKassa\Common\ResponseObject; /** * Interface ApiClientInterface - * @package YooKassa\Client + * + * @package YooKassa */ interface ApiClientInterface { /** - * @param $path - * @param $method - * @param $queryParams - * @param $httpBody - * @param $headers - * @return mixed + * Создает CURL запрос, получает и возвращает обработанный ответ + * + * @param string $path URL запроса + * @param string $method HTTP метод + * @param array $queryParams Массив GET параметров запроса + * @param string|null $httpBody Тело запроса + * @param array $headers Массив заголовков запроса + * + * @return ResponseObject */ public function call($path, $method, $queryParams, $httpBody = null, $headers = array()); /** - * @param LoggerInterface|null $logger + * Устанавливает объект для логирования + * + * @param LoggerInterface|null $logger Объект для логирования */ public function setLogger($logger); /** + * Возвращает UserAgent + * * @return UserAgent */ public function getUserAgent(); /** - * @param $shopId + * Устанавливает shopId магазина + * + * @param string|int $shopId shopId магазина * @return mixed */ public function setShopId($shopId); /** - * @param $shopPassword + * Устанавливает секретный ключ магазина + * + * @param string $shopPassword * @return mixed */ public function setShopPassword($shopPassword); /** - * @param $bearerToken + * Устанавливает OAuth-токен магазина + * + * @param string $bearerToken * @return mixed */ public function setBearerToken($bearerToken); /** + * Устанавливает настройки + * * @param array $config */ public function setConfig($config); diff --git a/lib/Client/BaseClient.php b/lib/Client/BaseClient.php index e08da41e..2d4fca96 100644 --- a/lib/Client/BaseClient.php +++ b/lib/Client/BaseClient.php @@ -46,15 +46,22 @@ use YooKassa\Helpers\Config\ConfigurationLoaderInterface; class BaseClient { - const PAYMENTS_PATH = '/payments'; - const REFUNDS_PATH = '/refunds'; - const WEBHOOKS_PATH = '/webhooks'; - const RECEIPTS_PATH = '/receipts'; + /** Точка входа для запроса к API по магазину */ const ME_PATH = '/me'; - /** - * Имя HTTP заголовка, используемого для передачи idempotence key - */ + /** Точка входа для запросов к API по платежам */ + const PAYMENTS_PATH = '/payments'; + + /** Точка входа для запросов к API по возвратам */ + const REFUNDS_PATH = '/refunds'; + + /** Точка входа для запросов к API по вебхукам */ + const WEBHOOKS_PATH = '/webhooks'; + + /** Точка входа для запросов к API по чекам */ + const RECEIPTS_PATH = '/receipts'; + + /** Имя HTTP заголовка, используемого для передачи idempotence key */ const IDEMPOTENCY_KEY_HEADER = 'Idempotence-Key'; /** @@ -63,51 +70,61 @@ class BaseClient */ const DEFAULT_DELAY = 1800; - /** - * Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 - */ + /** Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 */ const DEFAULT_TRIES_COUNT = 3; - /** - * Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 - */ + /** Значение по умолчанию количества попыток получения информации от API если пришёл ответ с HTTP статусом 202 */ const DEFAULT_ATTEMPTS_COUNT = 3; /** + * CURL клиент + * * @var null|ApiClientInterface */ protected $apiClient; /** - * @var string + * shopId магазина + * + * @var string|int */ protected $login; /** + * Секретный ключ магазина + * * @var string */ protected $password; /** + * Настройки для CURL клиента + * * @var array */ protected $config; /** * Время через которое будут осуществляться повторные запросы + * * Значение по умолчанию - 1800 миллисекунд. + * * @var int значение в миллисекундах */ protected $timeout; /** * Количество повторных запросов при ответе API статусом 202 + * * Значение по умолчанию 3 + * * @var int */ protected $attempts; /** + * Объект для логирования работы SDK + * * @var LoggerInterface|null */ protected $logger; @@ -127,19 +144,23 @@ class BaseClient if ($configLoader === null) { $configLoader = new ConfigurationLoader(); } - $config = $configLoader->load()->getConfig(); + $config = $configLoader->load()->getConfig(); $this->setConfig($config); $apiClient->setConfig($config); - $this->attempts = self::DEFAULT_ATTEMPTS_COUNT; + $this->attempts = self::DEFAULT_ATTEMPTS_COUNT; $this->apiClient = $apiClient; } /** - * @param $login - * @param $password + * Устанавливает авторизацию по логин/паролю * - * @return static $this + * @example 01-client.php 7 1 Пример авторизации + * + * @param string $login + * @param string $password + * + * @return $this */ public function setAuth($login, $password) { @@ -155,7 +176,11 @@ class BaseClient } /** - * @param $token + * Устанавливает авторизацию по Oauth-токену + * + * @example 01-client.php 9 1 Пример авторизации + * + * @param string $token * * @return $this */ @@ -170,6 +195,8 @@ class BaseClient } /** + * Возвращает CURL клиента для работы с API + * * @return ApiClientInterface */ public function getApiClient() @@ -178,9 +205,11 @@ class BaseClient } /** + * Устанавливает CURL клиента для работы с API + * * @param ApiClientInterface $apiClient * - * @return static $this + * @return $this */ public function setApiClient(ApiClientInterface $apiClient) { @@ -209,6 +238,8 @@ class BaseClient } /** + * Возвращает настройки клиента + * * @return array */ public function getConfig() @@ -217,6 +248,8 @@ class BaseClient } /** + * Устанавливает настройки клиента + * * @param array $config */ public function setConfig($config) @@ -225,11 +258,11 @@ class BaseClient } /** - * Установка значение задержки между повторными запросами + * Установка значения задержки между повторными запросами * * @param int $timeout * - * @return static + * @return $this */ public function setRetryTimeout($timeout) { @@ -243,7 +276,7 @@ class BaseClient * * @param int $attempts * - * @return static + * @return $this */ public function setMaxRequestAttempts($attempts) { @@ -253,7 +286,9 @@ class BaseClient } /** - * @param $serializedData + * Кодирует массив данных в JSON строку + * + * @param array $serializedData * * @return string * @throws Exception @@ -279,6 +314,10 @@ class BaseClient } /** + * Убирает лишние обратные слэши, а также декодирует строку UTF-8 в нормальный вид + * + * Вспомогательная функция для старых версий PHP + * * @param string $json * @return string|false */ @@ -296,6 +335,8 @@ class BaseClient } /** + * Декодирует JSON строку в массив данных + * * @param ResponseObject $response * * @return array @@ -311,6 +352,8 @@ class BaseClient } /** + * Выбрасывает исключение по коду ошибки + * * @param ResponseObject $response * * @throws ApiException @@ -361,7 +404,7 @@ class BaseClient /** * Задержка между повторными запросами * - * @param $response + * @param ResponseObject $response */ protected function delay($response) { @@ -382,9 +425,9 @@ class BaseClient /** * Выполнение запроса и обработка 202 статуса * - * @param $path - * @param $method - * @param $queryParams + * @param string $path + * @param string $method + * @param array $queryParams * @param null $httpBody * @param array $headers * diff --git a/lib/Client/CurlClient.php b/lib/Client/CurlClient.php index a2ccf255..406da491 100644 --- a/lib/Client/CurlClient.php +++ b/lib/Client/CurlClient.php @@ -35,70 +35,49 @@ use YooKassa\Common\ResponseObject; use YooKassa\Helpers\RawHeadersParser; /** - * Class CurlClient - * @package YooKassa\Client + * Класс клиента Curl запросов + * + * @package YooKassa */ class CurlClient implements ApiClientInterface { - /** - * @var array - */ + /** @var array Настройки клиента */ private $config; - /** - * @var string - */ + /** @var string|int shopId магазина */ private $shopId; - /** - * @var string - */ + /** @var string Секретный ключ магазина */ private $shopPassword; - /** - * @var string - */ + /** @var string OAuth токен*/ private $bearerToken; - /** - * @var int - */ + /** @var int Настройка параметра CURLOPT_TIMEOUT*/ private $timeout = 80; - /** - * @var int - */ + /** @var int Настройка параметра CURLOPT_CONNECTTIMEOUT */ private $connectionTimeout = 30; - /** - * @var string - */ + /** @var string Настройка прокси-сервера, если нужен */ private $proxy; - /** @var UserAgent */ + /** @var UserAgent Строка user-agent для статистики */ private $userAgent; - /** - * @var bool - */ + /** @var bool Настройка удержания соединения */ private $keepAlive = true; - /** - * @var array - */ + /** @var array Заголовки по умолчанию */ private $defaultHeaders = array( 'Content-Type' => 'application/json', 'Accept' => 'application/json', ); - /** - * @var resource - */ + /** @var resource Текущий ресурс для работы с curl */ private $curl; - /** - * @var LoggerInterface|null - */ + /** @var LoggerInterface|null Объект для логирования запросов */ private $logger; /** @@ -120,11 +99,11 @@ class CurlClient implements ApiClientInterface /** * @inheritdoc * - * @param $path - * @param $method - * @param $queryParams - * @param null $httpBody - * @param array $headers + * @param string $path URL запроса + * @param string $method HTTP метод + * @param array $queryParams Массив GET параметров запроса + * @param string|null $httpBody Тело запроса + * @param array $headers Массив заголовков запроса * * @return ResponseObject * @throws ApiConnectionException @@ -158,8 +137,10 @@ class CurlClient implements ApiClientInterface } /** - * @param $optionName - * @param $optionValue + * Устанавливает параметры CURL + * + * @param string $optionName Имя параметра + * @param mixed $optionValue Значение параметра * * @return bool */ @@ -197,6 +178,8 @@ class CurlClient implements ApiClientInterface } /** + * Выполняет запрос, получает и возвращает обработанный ответ + * * @return array * @throws ApiConnectionException */ @@ -217,8 +200,10 @@ class CurlClient implements ApiClientInterface } /** - * @param $method - * @param $httpBody + * Устанавливает тело запроса + * + * @param string $method HTTP метод + * @param string $httpBody Тело запроса */ public function setBody($method, $httpBody) { @@ -230,9 +215,11 @@ class CurlClient implements ApiClientInterface } /** - * @param mixed $shopId + * Устанавливает shopId магазина * - * @return CurlClient + * @param mixed $shopId shopId магазина + * + * @return $this */ public function setShopId($shopId) { @@ -242,9 +229,11 @@ class CurlClient implements ApiClientInterface } /** - * @param mixed $shopPassword + * Устанавливает секретный ключ магазина * - * @return CurlClient + * @param mixed $shopPassword Секретный ключ магазина + * + * @return $this */ public function setShopPassword($shopPassword) { @@ -254,7 +243,9 @@ class CurlClient implements ApiClientInterface } /** - * @return mixed + * Возвращает значение параметра CURLOPT_TIMEOUT + * + * @return int */ public function getTimeout() { @@ -262,7 +253,9 @@ class CurlClient implements ApiClientInterface } /** - * @param mixed $timeout + * Устанавливает значение параметра CURLOPT_TIMEOUT + * + * @param int $timeout Максимальное количество секунд для выполнения функций cURL */ public function setTimeout($timeout) { @@ -270,7 +263,9 @@ class CurlClient implements ApiClientInterface } /** - * @return mixed + * Возвращает значение параметра CURLOPT_CONNECTTIMEOUT + * + * @return int */ public function getConnectionTimeout() { @@ -278,7 +273,9 @@ class CurlClient implements ApiClientInterface } /** - * @param mixed $connectionTimeout + * Устанавливает значение параметра CURLOPT_CONNECTTIMEOUT + * + * @param int $connectionTimeout Число секунд ожидания при попытке подключения */ public function setConnectionTimeout($connectionTimeout) { @@ -286,6 +283,8 @@ class CurlClient implements ApiClientInterface } /** + * Возвращает настройки прокси + * * @return string * @since 1.0.14 */ @@ -295,7 +294,9 @@ class CurlClient implements ApiClientInterface } /** - * @param string $proxy + * Устанавливает настройки прокси + * + * @param string $proxy Прокси сервер * * @since 1.0.14 */ @@ -305,6 +306,8 @@ class CurlClient implements ApiClientInterface } /** + * Возвращает настройки + * * @return mixed */ public function getConfig() @@ -313,7 +316,9 @@ class CurlClient implements ApiClientInterface } /** - * @inheritDoc + * Устанавливает настройки + * + * @param array $config Настройки клиента */ public function setConfig($config) { @@ -321,6 +326,8 @@ class CurlClient implements ApiClientInterface } /** + * Возвращает UserAgent + * * @return UserAgent */ public function getUserAgent() @@ -329,9 +336,11 @@ class CurlClient implements ApiClientInterface } /** - * @param string $bearerToken + * Устанавливает OAuth-токен магазина * - * @return static $this + * @param string $bearerToken OAuth-токен магазина + * + * @return $this */ public function setBearerToken($bearerToken) { @@ -341,9 +350,11 @@ class CurlClient implements ApiClientInterface } /** - * @param bool $keepAlive + * Устанавливает флаг сохранения соединения * - * @return CurlClient + * @param bool $keepAlive Флаг сохранения настроек + * + * @return $this */ public function setKeepAlive($keepAlive) { @@ -388,7 +399,7 @@ class CurlClient implements ApiClientInterface } /** - * @param $headers + * @param array $headers * * @return array * @throws AuthorizeException @@ -423,11 +434,11 @@ class CurlClient implements ApiClientInterface } /** - * @param $path - * @param $method - * @param $queryParams - * @param $httpBody - * @param $headers + * @param string $path + * @param string $method + * @param array $queryParams + * @param string $httpBody + * @param array $headers */ private function logRequestParams($path, $method, $queryParams, $httpBody, $headers) { @@ -452,8 +463,8 @@ class CurlClient implements ApiClientInterface } /** - * @param $path - * @param $queryParams + * @param string $path + * @param array $queryParams * * @return string */ @@ -469,9 +480,9 @@ class CurlClient implements ApiClientInterface } /** - * @param $httpBody - * @param $responseInfo - * @param $httpHeaders + * @param string $httpBody + * @param array $responseInfo + * @param array $httpHeaders */ private function logResponse($httpBody, $responseInfo, $httpHeaders) { @@ -493,10 +504,10 @@ class CurlClient implements ApiClientInterface } /** - * @param $method - * @param $httpBody - * @param $headers - * @param $url + * @param string $method + * @param string $httpBody + * @param array $headers + * @param string $url * @throws ExtensionNotFoundException */ private function prepareCurl($method, $httpBody, $headers, $url) diff --git a/lib/Client/UserAgent.php b/lib/Client/UserAgent.php index 54474611..a468a2f8 100644 --- a/lib/Client/UserAgent.php +++ b/lib/Client/UserAgent.php @@ -30,24 +30,41 @@ namespace YooKassa\Client; use YooKassa\Client; /** - * Class UserAgent - * @package YooKassa\Client + * Класс для создания заголовка User-Agent в запросах к API + * + * @package YooKassa */ class UserAgent { + /** Имя заголовка для User-Agent */ const HEADER = 'YM-User-Agent'; + + /** Разделитель части заголовка и её версии */ const VERSION_DELIMITER = '/'; + + /** Разделитель между частями заголовка */ const PART_DELIMITER = ' '; + /** @var string|null Версия операционной системы */ private $_os = null; + + /** @var string|null Версия PHP */ private $_php = null; + + /** @var string|null Версия фреймворка */ private $_framework = null; + + /** @var string|null Версия CMS */ private $_cms = null; + + /** @var string|null Версия модуля */ private $_module = null; + + /** @var string|null Версия SDK */ private $_sdk = null; /** - * UserAgent constructor. + * Конструктор UserAgent */ public function __construct() { @@ -61,6 +78,7 @@ class UserAgent } /** + * Формирует конечную строку из составных частей * @return string */ public function getHeaderString() @@ -86,6 +104,7 @@ class UserAgent } /** + * Возвращает версию операционной системы * @return string */ public function getOs() @@ -94,6 +113,7 @@ class UserAgent } /** + * Устанавливает версию операционной системы * @param string $name * @param string $version */ @@ -103,6 +123,7 @@ class UserAgent } /** + * Возвращает версию PHP * @return string */ public function getPhp() @@ -111,6 +132,7 @@ class UserAgent } /** + * Устанавливает версию PHP * @param string $name * @param string $version */ @@ -120,6 +142,7 @@ class UserAgent } /** + * Возвращает версию фреймворка * @return string|null */ public function getFramework() @@ -128,6 +151,7 @@ class UserAgent } /** + * Устанавливает версию фреймворка * @param string $name * @param string $version */ @@ -137,6 +161,7 @@ class UserAgent } /** + * Возвращает версию CMS * @return null */ public function getCms() @@ -145,6 +170,7 @@ class UserAgent } /** + * Устанавливает версию CMS * @param string $name * @param string $version */ @@ -154,6 +180,7 @@ class UserAgent } /** + * Возвращает версию модуля * @return string */ public function getModule() @@ -162,6 +189,7 @@ class UserAgent } /** + * Устанавливает версию модуля * @param string $name * @param string $version */ @@ -171,6 +199,7 @@ class UserAgent } /** + * Возвращает версию SDK * @return string */ public function getSdk() @@ -179,6 +208,7 @@ class UserAgent } /** + * Устанавливает версию SDK * @param string $name * @param string $version */ diff --git a/lib/Common/AbstractEnum.php b/lib/Common/AbstractEnum.php index ee448416..efa30a3d 100644 --- a/lib/Common/AbstractEnum.php +++ b/lib/Common/AbstractEnum.php @@ -29,7 +29,7 @@ namespace YooKassa\Common; /** * Базовый класс генерируемых enum'ов * - * @package YooKassa\Common + * @package YooKassa */ abstract class AbstractEnum { diff --git a/lib/Common/AbstractObject.php b/lib/Common/AbstractObject.php index e2960079..8f6e36e6 100644 --- a/lib/Common/AbstractObject.php +++ b/lib/Common/AbstractObject.php @@ -41,7 +41,7 @@ if (!interface_exists('JsonSerializable')) { /** * Базовый класс генерируемых объектов * - * @package YooKassa\Common + * @package YooKassa */ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable { @@ -177,7 +177,7 @@ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable /** * Устанавливает значения свойств текущего объекта из массива - * @param array|\Traversable $sourceArray Ассоциативный массив с найтройками + * @param array|\Traversable $sourceArray Ассоциативный массив с настройками */ public function fromArray($sourceArray) { @@ -186,6 +186,16 @@ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable } } + /** + * Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации + * Является алиасом метода AbstractObject::jsonSerialize() + * @return array Ассоциативный массив со свойствами текущего объекта + */ + public function toArray() + { + return $this->jsonSerialize(); + } + /** * Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации * @return array Ассоциативный массив со свойствами текущего объекта @@ -246,6 +256,6 @@ abstract class AbstractObject implements \ArrayAccess, \JsonSerializable */ private static function matchPropertyName($property) { - return preg_replace('/\_(\w)/', '\1', $property); + return preg_replace('/_(\w)/', '\1', $property); } } diff --git a/lib/Common/AbstractPaymentRequest.php b/lib/Common/AbstractPaymentRequest.php index a36369a0..14900e36 100644 --- a/lib/Common/AbstractPaymentRequest.php +++ b/lib/Common/AbstractPaymentRequest.php @@ -47,17 +47,17 @@ class AbstractPaymentRequest extends AbstractRequest /** * @var AmountInterface Сумма оплаты */ - protected $_amount; + private $_amount; /** * @var Receipt Данные фискального чека 54-ФЗ */ - protected $_receipt; + private $_receipt; /** * @var TransferInterface[] */ - protected $_transfers = array(); + private $_transfers = array(); /** * Возвращает сумму оплаты @@ -126,32 +126,55 @@ class AbstractPaymentRequest extends AbstractRequest $this->_receipt = null; } + /** + * Проверяет наличие данных о распределении денег + * @return bool + */ + public function hasTransfers() + { + return !empty($this->_transfers); + } + + /** + * Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + * Присутствует, если вы используете решение ЮKassa для платформ. + * (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + * + * @return TransferInterface[] Данные о распределении денег + */ + public function getTransfers() + { + return $this->_transfers; + } + /** * Устанавливает transfers (массив распределения денег между магазинами) - * @param TransferInterface[]|array $value + * @param TransferInterface[]|array|null $value */ public function setTransfers($value) { - if (!is_array($value)) { + if ($value === null || is_array($value)) { + if (is_array($value)) { + $transfers = array(); + foreach ($value as $item) { + if (is_array($item)) { + $item = new Transfer($item); + } + if (!($item instanceof TransferInterface)) { + $message = 'Transfers must be an array of TransferInterface'; + throw new InvalidPropertyValueTypeException($message, 0, 'Payment.transfers', $value); + } + + $transfers[] = $item; + } + $this->_transfers = $transfers; + } else { + $this->_transfers = $value; + } + } else { $message = 'Transfers must be an array of TransferInterface'; throw new InvalidPropertyValueTypeException($message, 0, 'Payment.transfers', $value); } - - $transfers = array(); - foreach ($value as $item) { - if (is_array($item)) { - $item = new Transfer($item); - } - - if (!($item instanceof TransferInterface)) { - $message = 'Transfers must be an array of TransferInterface'; - throw new InvalidPropertyValueTypeException($message, 0, 'Payment.transfers', $value); - } - - $transfers[] = $item; - } - - $this->_transfers = $transfers; } /** @@ -211,13 +234,4 @@ class AbstractPaymentRequest extends AbstractRequest return true; } - public function hasTransfers() - { - return !empty($this->_transfers); - } - - public function getTransfers() - { - return $this->_transfers; - } } \ No newline at end of file diff --git a/lib/Common/AbstractPaymentRequestBuilder.php b/lib/Common/AbstractPaymentRequestBuilder.php index 6f17d5e7..a7637287 100644 --- a/lib/Common/AbstractPaymentRequestBuilder.php +++ b/lib/Common/AbstractPaymentRequestBuilder.php @@ -42,24 +42,27 @@ use YooKassa\Model\TransferInterface; /** * Базовый класс объекта платежного запроса, передаваемого в методы клиента API * - * @package YooKassa\Common + * @package YooKassa * * @since 1.0.18 */ abstract class AbstractPaymentRequestBuilder extends AbstractRequestBuilder { /** - * @var MonetaryAmount Сумма + * Сумма + * @var MonetaryAmount */ protected $amount; /** - * @var Receipt Объект с информацией о чеке + * Объект с информацией о чеке + * @var Receipt */ protected $receipt; /** - * @var TransferInterface[] Массив платежей в пользу разных мерчантов + * Массив платежей в пользу разных мерчантов + * @var TransferInterface[] */ protected $transfers; @@ -109,29 +112,23 @@ abstract class AbstractPaymentRequestBuilder extends AbstractRequestBuilder /** * Устанавливает трансферы * - * @param array|string $value Массив трансферов + * @param TransferInterface[]|array|null $value Массив трансферов * * @return self Инстанс билдера запросов */ public function setTransfers($value) { - $value = (array)$value; - $this->transfers = array(); - - foreach ($value as $item) { - $transfer = new Transfer(); - - if ($item instanceof TransferInterface) { - $transfer->setAmount($item->getAmount()); - $transfer->setAccountId($item->getAccountId()); - if ($item->hasPlatformFeeAmount()) { - $transfer->setPlatformFeeAmount($item->getPlatformFeeAmount()); + if (is_array($value)) { + $this->transfers = array(); + foreach ($value as $item) { + if ($item instanceof TransferInterface) { + $this->transfers[] = $item; + } elseif (is_array($item)) { + $this->transfers[] = new Transfer($item); } - } elseif (is_array($item)) { - $transfer->fromArray($item); } - - $this->transfers[] = $transfer; + } else { + $this->transfers = array(); } return $this; diff --git a/lib/Common/AbstractRefundRequest.php b/lib/Common/AbstractRefundRequest.php new file mode 100644 index 00000000..ade998b5 --- /dev/null +++ b/lib/Common/AbstractRefundRequest.php @@ -0,0 +1,163 @@ +_paymentId; + } + + /** + * Устанавливает идентификатор платежа для которого создаётся возврат + * @param string $value Идентификатор платежа + * + * @throws EmptyPropertyValueException Выбрасывается если передано пустое значение идентификатора платежа + * @throws InvalidPropertyValueException Выбрасывается если переданное значение является строкой, но не является + * валидным значением идентификатора платежа + * @throws InvalidPropertyValueTypeException Выбрасывается если передано значение не валидного типа + */ + public function setPaymentId($value) + { + if ($value === null || $value === '') { + throw new EmptyPropertyValueException( + 'Empty payment id value in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId' + ); + } elseif (TypeCast::canCastToString($value)) { + $length = mb_strlen($value, 'utf-8'); + if ($length != 36) { + throw new InvalidPropertyValueException( + 'Invalid payment id value in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId', $value + ); + } + $this->_paymentId = (string)$value; + } else { + throw new InvalidPropertyValueException( + 'Invalid payment id value type in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId', $value + ); + } + } + + /** + * Возвращает сумму возврата + * @return AmountInterface Сумма возврата + */ + public function getAmount() + { + return $this->_amount; + } + + /** + * Проверяет была ли установлена сумма возврата + * @return bool True если сумма возврата была установлена, false если нет + */ + public function hasAmount() + { + return !empty($this->_amount); + } + + /** + * Устанавливает сумму + * + * @param AmountInterface|array|string $value Сумма возврата + * + * @return self Инстанс билдера запросов + */ + public function setAmount($value) + { + $this->_amount = new MonetaryAmount(); + if ($value === null || $value === '') { + $this->_amount = new MonetaryAmount(); + } elseif ($value instanceof AmountInterface) { + $this->_amount = $value; + } elseif (is_array($value)) { + $this->_amount->fromArray($value); + } else { + $this->_amount->setValue($value); + } + + return $this; + } + + /** + * Валидирует объект запроса + * @return bool True если запрос валиден и его можно отправить в API, false если нет + */ + public function validate() + { + if (empty($this->_paymentId)) { + $this->setValidationError('Payment id not specified'); + return false; + } + + if ($this->_amount === null) { + $this->setValidationError('Payment amount not specified'); + return false; + } + + $value = $this->_amount->getValue(); + if (empty($value) || $value <= 0.0) { + $this->setValidationError('Invalid payment amount value: ' . $value); + + return false; + } + + return true; + } + +} \ No newline at end of file diff --git a/lib/Common/AbstractRequest.php b/lib/Common/AbstractRequest.php index de642bb4..38528d1b 100644 --- a/lib/Common/AbstractRequest.php +++ b/lib/Common/AbstractRequest.php @@ -29,7 +29,7 @@ namespace YooKassa\Common; /** * Базовый класс объекта запроса, передаваемого в методы клиента API * - * @package YooKassa\Common + * @package YooKassa */ abstract class AbstractRequest extends AbstractObject { diff --git a/lib/Common/AbstractRequestBuilder.php b/lib/Common/AbstractRequestBuilder.php index d669fa3d..675587f5 100644 --- a/lib/Common/AbstractRequestBuilder.php +++ b/lib/Common/AbstractRequestBuilder.php @@ -32,12 +32,13 @@ use YooKassa\Common\Exceptions\InvalidRequestException; /** * Базовый класс билдера запросов * - * @package YooKassa\Common + * @package YooKassa */ abstract class AbstractRequestBuilder { /** - * @var AbstractRequest Инстанс собираемого запроса + * Инстанс собираемого запроса + * @var AbstractRequest */ protected $currentObject; diff --git a/lib/Common/ResponseObject.php b/lib/Common/ResponseObject.php index f062468a..75dafbb3 100644 --- a/lib/Common/ResponseObject.php +++ b/lib/Common/ResponseObject.php @@ -26,10 +26,27 @@ namespace YooKassa\Common; +/** + * Класс HTTP ответа + * + * @package YooKassa + */ class ResponseObject { + /** + * HTTP код ответа + * @var int|string + */ protected $code; + /** + * Массив заголовков ответа + * @var array + */ protected $headers; + /** + * Тело ответа + * @var mixed + */ protected $body; public function __construct($config = null) @@ -48,7 +65,9 @@ class ResponseObject } /** - * @return mixed + * Возвращает массив заголовков ответа + * + * @return array Массив заголовков ответа */ public function getHeaders() { @@ -56,7 +75,9 @@ class ResponseObject } /** - * @return mixed + * Возвращает тело ответа + * + * @return mixed Тело ответа */ public function getBody() { @@ -64,7 +85,9 @@ class ResponseObject } /** - * @return mixed + * Возвращает HTTP код ответа + * + * @return int|string HTTP код ответа */ public function getCode() { diff --git a/lib/Helpers/ProductCode.php b/lib/Helpers/ProductCode.php index c4dba477..ea50d2ec 100644 --- a/lib/Helpers/ProductCode.php +++ b/lib/Helpers/ProductCode.php @@ -29,16 +29,16 @@ namespace YooKassa\Helpers; /** * Класс для формирования тега 1162 на основе кода в формате Data Matrix * - * @example $receiptItem->setProductCode(new \YooKassa\Helpers\ProductCode('010463003759131691sgEKKPPcS25y592FLduM/=')); - * @example array(... 'product_code' => (string)(new \YooKassa\Helpers\ProductCode('010463003759131691sgEKKPPcS25y5') ...); + * @example 04-product-code.php 6 6 Вариант через метод + * @example 04-product-code.php 14 6 Вариант через массив * * @link https://github.com/yoomoney/yookassa-sdk-php/blob/master/lib/Helpers/ProductCode.php * - * Class ProductCode - * @package YooKassa\Helpers + * @package YooKassa */ class ProductCode { + /** Код типа маркировки DataMatrix */ const PREFIX_DATA_MATRIX = '444D'; /** @var string Код типа маркировки */ @@ -121,7 +121,7 @@ class ProductCode /** * Устанавливает Глобальный номер товарной продукции - * @param string$gtin Глобальный номер товарной продукции + * @param string $gtin Глобальный номер товарной продукции * @return ProductCode */ public function setGtin($gtin) diff --git a/lib/Helpers/Random.php b/lib/Helpers/Random.php index b0d80d3f..4074a585 100644 --- a/lib/Helpers/Random.php +++ b/lib/Helpers/Random.php @@ -29,7 +29,7 @@ namespace YooKassa\Helpers; /** * Класс хэлпера для генерации случайных значений, используется в тестах * - * @package YooKassa\Helpers + * @package YooKassa */ class Random { diff --git a/lib/Helpers/StringObject.php b/lib/Helpers/StringObject.php index 1c1a080e..f8eee15c 100644 --- a/lib/Helpers/StringObject.php +++ b/lib/Helpers/StringObject.php @@ -29,7 +29,7 @@ namespace YooKassa\Helpers; /** * Класс объекта, кастящегося в строку, используется только в тестах * - * @package YooKassa\Helpers + * @package YooKassa */ class StringObject { diff --git a/lib/Helpers/TypeCast.php b/lib/Helpers/TypeCast.php index 8cc4367a..a5dea4c4 100644 --- a/lib/Helpers/TypeCast.php +++ b/lib/Helpers/TypeCast.php @@ -32,7 +32,7 @@ use Exception; /** * Класс хэлпер для преобразования типов значений * - * @package YooKassa\Helpers + * @package YooKassa */ class TypeCast { diff --git a/lib/Model/Airline.php b/lib/Model/Airline.php index b75cfe8f..e9e03ffc 100644 --- a/lib/Model/Airline.php +++ b/lib/Model/Airline.php @@ -34,12 +34,21 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Helpers\TypeCast; /** - * Class Airline + * Класс описывающий авиабилет + * + * @package YooKassa + * + * @property string $bookingReference Номер бронирования. Обязателен на этапе создания платежа + * @property string $booking_reference Номер бронирования. Обязателен на этапе создания платежа + * @property string $ticketNumber Уникальный номер билета. Обязателен на этапе подтверждения платежа + * @property string $ticket_number Уникальный номер билета. Обязателен на этапе подтверждения платежа + * @property PassengerInterface[] $passengers Список пассажиров + * @property Leg[] $legs Список маршрутов */ class Airline extends AbstractObject implements AirlineInterface { /** - * @var string Номер бронирования. Обязателен на этапе создания платежа. + * @var string Номер бронирования. Обязателен на этапе создания платежа */ private $_bookingReference; @@ -49,12 +58,12 @@ class Airline extends AbstractObject implements AirlineInterface private $_ticketNumber; /** - * @var PassengerInterface[] + * @var PassengerInterface[] Список пассажиров */ private $_passengers; /** - * @var LegInterface[] + * @var LegInterface[] Список маршрутов */ private $_legs; @@ -67,7 +76,8 @@ class Airline extends AbstractObject implements AirlineInterface } /** - * @param string $value + * Устанавливает номер бронирования. Обязателен на этапе создания платежа. + * @param string $value Номер бронирования */ public function setBookingReference($value) { @@ -93,7 +103,8 @@ class Airline extends AbstractObject implements AirlineInterface } /** - * @param string $value + * Устанавливает уникальный номер билета. Обязателен на этапе подтверждения платежа + * @param string $value Уникальный номер билета */ public function setTicketNumber($value) { @@ -119,7 +130,8 @@ class Airline extends AbstractObject implements AirlineInterface } /** - * @param array|PassengerInterface[] $value + * Устанавливает список объектов-контейнеров с данными пассажиров + * @param array|PassengerInterface[] $value Список объектов-контейнеров с данными пассажиров */ public function setPassengers($value) { @@ -144,7 +156,8 @@ class Airline extends AbstractObject implements AirlineInterface } /** - * @param array|PassengerInterface $value + * Добавляет объект-контейнер с данными пассажиров + * @param array|PassengerInterface $value Объект-контейнер с данными пассажиров */ public function addPassenger($value) { @@ -170,7 +183,8 @@ class Airline extends AbstractObject implements AirlineInterface } /** - * @param array|LegInterface[] $value + * Устанавливает список объектов-контейнеров с данными о маршруте + * @param array|LegInterface[] $value Список объектов-контейнеров с данными о маршруте */ public function setLegs($value) { @@ -195,7 +209,8 @@ class Airline extends AbstractObject implements AirlineInterface } /** - * @param array|LegInterface $value + * Добавляет объект-контейнер с данными о маршруте + * @param array|LegInterface $value Объект-контейнер с данными о маршруте */ public function addLeg($value) { diff --git a/lib/Model/AmountInterface.php b/lib/Model/AmountInterface.php index 130c4faa..992d5a51 100644 --- a/lib/Model/AmountInterface.php +++ b/lib/Model/AmountInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface AmountInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $value Сумма * @property-read string $currency Код валюты @@ -43,7 +43,8 @@ interface AmountInterface public function getValue(); /** - * @param $value + * Устанавливает значение суммы + * @param numeric $value Сумма */ public function setValue($value); diff --git a/lib/Model/AuthorizationDetailsInterface.php b/lib/Model/AuthorizationDetailsInterface.php index 72d0b6ce..02230a1c 100644 --- a/lib/Model/AuthorizationDetailsInterface.php +++ b/lib/Model/AuthorizationDetailsInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface AuthorizationDetailsInterface - Данные об авторизации платежа * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $rrn Retrieval Reference Number — уникальный идентификатор транзакции в системе эмитента * @property-read string $authCode Код авторизации банковской карты diff --git a/lib/Model/CancellationDetailsInterface.php b/lib/Model/CancellationDetailsInterface.php index 1f149e60..6e9c1356 100644 --- a/lib/Model/CancellationDetailsInterface.php +++ b/lib/Model/CancellationDetailsInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface CancellationDetailsInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $party Участник процесса платежа, который принял решение об отмене транзакции. * @property-read string $reason Причина отмены платежа. diff --git a/lib/Model/Confirmation/AbstractConfirmation.php b/lib/Model/Confirmation/AbstractConfirmation.php index ac1dc98e..d78e6912 100644 --- a/lib/Model/Confirmation/AbstractConfirmation.php +++ b/lib/Model/Confirmation/AbstractConfirmation.php @@ -38,18 +38,20 @@ use YooKassa\Model\ConfirmationType; * * @property-read string $type * - * @method getConfirmationUrl - * @method getConfirmationToken - * @method getConfirmationData + * @method string getConfirmationUrl() Для ConfirmationRedirect + * @method string getConfirmationToken() Для ConfirmationEmbedded + * @method string getConfirmationData() Для ConfirmationQr */ abstract class AbstractConfirmation extends AbstractObject { /** + * Тип подтверждения платежа * @var string */ private $_type; /** + * Возвращает тип подтверждения платежа * @return string */ public function getType() @@ -58,9 +60,10 @@ abstract class AbstractConfirmation extends AbstractObject } /** + * Устанавливает тип подтверждения платежа * @param string $value */ - protected function _setType($value) + protected function setType($value) { if ($value === null || $value === '') { throw new EmptyPropertyValueException( diff --git a/lib/Model/Confirmation/ConfirmationCodeVerification.php b/lib/Model/Confirmation/ConfirmationCodeVerification.php index 9b4afac3..a5e49ab6 100644 --- a/lib/Model/Confirmation/ConfirmationCodeVerification.php +++ b/lib/Model/Confirmation/ConfirmationCodeVerification.php @@ -31,12 +31,12 @@ use YooKassa\Model\ConfirmationType; /** * Сценарий при котором необходимо получить одноразовый код от плательщика для подтверждения платежа * - * @package YooKassa\Model\Confirmation + * @package YooKassa */ class ConfirmationCodeVerification extends AbstractConfirmation { public function __construct() { - $this->_setType(ConfirmationType::CODE_VERIFICATION); + $this->setType(ConfirmationType::CODE_VERIFICATION); } } \ No newline at end of file diff --git a/lib/Model/Confirmation/ConfirmationDeepLink.php b/lib/Model/Confirmation/ConfirmationDeepLink.php index 4cf5e28a..5a2957ae 100644 --- a/lib/Model/Confirmation/ConfirmationDeepLink.php +++ b/lib/Model/Confirmation/ConfirmationDeepLink.php @@ -31,12 +31,12 @@ use YooKassa\Model\ConfirmationType; /** * Сценарий при котором необходимо направить плательщика в приложение партнера * - * @package YooKassa\Model\Confirmation + * @package YooKassa */ class ConfirmationDeepLink extends AbstractConfirmation { public function __construct() { - $this->_setType(ConfirmationType::DEEPLINK); + $this->setType(ConfirmationType::DEEPLINK); } } \ No newline at end of file diff --git a/lib/Model/Confirmation/ConfirmationEmbedded.php b/lib/Model/Confirmation/ConfirmationEmbedded.php index 3cfa3942..4195dda5 100644 --- a/lib/Model/Confirmation/ConfirmationEmbedded.php +++ b/lib/Model/Confirmation/ConfirmationEmbedded.php @@ -39,7 +39,7 @@ class ConfirmationEmbedded extends AbstractConfirmation public function __construct() { - $this->_setType(ConfirmationType::EMBEDDED); + $this->setType(ConfirmationType::EMBEDDED); } /** diff --git a/lib/Model/Confirmation/ConfirmationExternal.php b/lib/Model/Confirmation/ConfirmationExternal.php index 54cb8952..c786a0b0 100644 --- a/lib/Model/Confirmation/ConfirmationExternal.php +++ b/lib/Model/Confirmation/ConfirmationExternal.php @@ -32,12 +32,12 @@ use YooKassa\Model\ConfirmationType; * Сценарий при котором необходимо ожидать пока пользователь самостоятельно подтвердит платеж. Например, * пользователь подтверждает платеж ответом на SMS или в приложении партнера * - * @package YooKassa\Model\Confirmation + * @package YooKassa */ class ConfirmationExternal extends AbstractConfirmation { public function __construct() { - $this->_setType(ConfirmationType::EXTERNAL); + $this->setType(ConfirmationType::EXTERNAL); } } diff --git a/lib/Model/Confirmation/ConfirmationFactory.php b/lib/Model/Confirmation/ConfirmationFactory.php index faf4dc64..7d1c6425 100644 --- a/lib/Model/Confirmation/ConfirmationFactory.php +++ b/lib/Model/Confirmation/ConfirmationFactory.php @@ -31,7 +31,7 @@ use YooKassa\Model\ConfirmationType; /** * Class ConfirmationFactory * - * @package YooKassa\Model\Confirmation + * @package YooKassa */ class ConfirmationFactory { @@ -45,7 +45,9 @@ class ConfirmationFactory ); /** - * @param string $type + * Возвращает объект, соответствующий типу подтверждения платежа + * + * @param string $type Тип подтверждения платежа * * @return AbstractConfirmation */ @@ -63,8 +65,10 @@ class ConfirmationFactory } /** - * @param array $data - * @param string|null $type + * Возвращает объект, соответствующий типу подтверждения платежа, из массива данных + * + * @param array $data Массив данных подтверждения платежа + * @param string|null $type Тип подтверждения платежа * * @return AbstractConfirmation */ diff --git a/lib/Model/Confirmation/ConfirmationQr.php b/lib/Model/Confirmation/ConfirmationQr.php index 9310f12e..fd2d1629 100644 --- a/lib/Model/Confirmation/ConfirmationQr.php +++ b/lib/Model/Confirmation/ConfirmationQr.php @@ -40,7 +40,7 @@ class ConfirmationQr extends AbstractConfirmation public function __construct() { - $this->_setType(ConfirmationType::QR); + $this->setType(ConfirmationType::QR); } /** diff --git a/lib/Model/Confirmation/ConfirmationRedirect.php b/lib/Model/Confirmation/ConfirmationRedirect.php index b041d5d2..74e88cec 100644 --- a/lib/Model/Confirmation/ConfirmationRedirect.php +++ b/lib/Model/Confirmation/ConfirmationRedirect.php @@ -63,7 +63,7 @@ class ConfirmationRedirect extends AbstractConfirmation public function __construct() { - $this->_setType(ConfirmationType::REDIRECT); + $this->setType(ConfirmationType::REDIRECT); } /** diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php index d63942a6..89acf5e2 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesCodeVerification.php @@ -31,7 +31,7 @@ use YooKassa\Model\ConfirmationType; /** * Сценарий при котором необходимо получить одноразовый код от плательщика для подтверждения платежа * - * @package YooKassa\Model\ConfirmationAttributes + * @package YooKassa */ class ConfirmationAttributesCodeVerification extends AbstractConfirmationAttributes { diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesDeepLink.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesDeepLink.php index 36b1ddd7..5fb86738 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesDeepLink.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesDeepLink.php @@ -31,7 +31,7 @@ use YooKassa\Model\ConfirmationType; /** * Сценарий при котором необходимо направить плательщика в приложение партнера * - * @package YooKassa\Model\ConfirmationAttributes + * @package YooKassa */ class ConfirmationAttributesDeepLink extends AbstractConfirmationAttributes { diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php index 14cddf08..cfe68d80 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesExternal.php @@ -31,7 +31,8 @@ use YooKassa\Model\ConfirmationType; /** * Сценарий при котором необходимо ожидать пока пользователь самостоятельно подтвердит платеж. Например, * пользователь подтверждает платеж ответом на SMS или в приложении партнера - * @package YooKassa\Model\ConfirmationAttributes + * + * @package YooKassa */ class ConfirmationAttributesExternal extends AbstractConfirmationAttributes { diff --git a/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php b/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php index e1ae4290..5e799586 100644 --- a/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php +++ b/lib/Model/ConfirmationAttributes/ConfirmationAttributesFactory.php @@ -31,7 +31,7 @@ use YooKassa\Model\ConfirmationType; /** * Class ConfirmationAttributesFactory * - * @package YooKassa\Model\ConfirmationAttributes + * @package YooKassa */ class ConfirmationAttributesFactory { diff --git a/lib/Model/CurrencyCode.php b/lib/Model/CurrencyCode.php index 6b183106..5cdf7ebd 100644 --- a/lib/Model/CurrencyCode.php +++ b/lib/Model/CurrencyCode.php @@ -33,12 +33,19 @@ use YooKassa\Common\AbstractEnum; */ class CurrencyCode extends AbstractEnum { + /** Российский рубль */ const RUB = 'RUB'; + /** Доллар США */ const USD = 'USD'; + /** Евро */ const EUR = 'EUR'; + /** Белорусский рубль */ const BYN = 'BYN'; + /** Китайская йена */ const CNY = 'CNY'; + /** Казахский тенге */ const KZT = 'KZT'; + /** Украинская гривна */ const UAH = 'UAH'; protected static $validValues = array( diff --git a/lib/Model/Leg.php b/lib/Model/Leg.php index 92250ebe..529f2dd0 100644 --- a/lib/Model/Leg.php +++ b/lib/Model/Leg.php @@ -32,9 +32,25 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Helpers\TypeCast; +/** + * Класс, описывающий маршрут + * + * @package YooKassa + * + * @property string $departureAirport Трёхбуквенный IATA-код аэропорта вылета + * @property string $departure_airport Трёхбуквенный IATA-код аэропорта вылета + * @property string $destinationAirport Трёхбуквенный IATA-код аэропорта прилёта + * @property string $destination_airport Трёхбуквенный IATA-код аэропорта прилёта + * @property string $departureDate Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + * @property string $departure_date Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + */ class Leg extends AbstractObject implements LegInterface { + /** + * Формат даты + */ const ISO8601 = 'Y-m-d'; + /** * @var string Трёхбуквенный IATA-код аэропорта вылета */ @@ -59,6 +75,7 @@ class Leg extends AbstractObject implements LegInterface } /** + * @inheritdoc * @param string $value */ public function setDepartureAirport($value) @@ -83,6 +100,7 @@ class Leg extends AbstractObject implements LegInterface } /** + * @inheritdoc * @param string $value */ public function setDestinationAirport($value) @@ -107,6 +125,7 @@ class Leg extends AbstractObject implements LegInterface } /** + * @inheritdoc * @param \DateTime|string $value * @throws \Exception */ diff --git a/lib/Model/LegInterface.php b/lib/Model/LegInterface.php index 417cb7b0..fc24d6f9 100644 --- a/lib/Model/LegInterface.php +++ b/lib/Model/LegInterface.php @@ -29,17 +29,38 @@ namespace YooKassa\Model; interface LegInterface { /** + * Возвращает трёхбуквенный IATA-код аэропорта вылета * @return string Трёхбуквенный IATA-код аэропорта вылета */ public function getDepartureAirport(); /** + * Возвращает трёхбуквенный IATA-код аэропорта прилёта * @return string Трёхбуквенный IATA-код аэропорта прилёта */ public function getDestinationAirport(); /** + * Возвращает дату вылета в формате YYYY-MM-DD ISO 8601:2004 * @return string Дата вылета в формате YYYY-MM-DD ISO 8601:2004 */ public function getDepartureDate(); + + /** + * Устанавливает трёхбуквенный IATA-код аэропорта вылета + * @param string $value Трёхбуквенный IATA-код аэропорта вылета + */ + public function setDepartureAirport($value); + + /** + * Устанавливает трёхбуквенный IATA-код аэропорта прилёта + * @param string $value Трёхбуквенный IATA-код аэропорта прилёта + */ + public function setDestinationAirport($value); + + /** + * Устанавливает дату вылета в формате YYYY-MM-DD ISO 8601:2004 + * @param \DateTime|string $value Дата вылета в формате YYYY-MM-DD ISO 8601:2004 + */ + public function setDepartureDate($value); } \ No newline at end of file diff --git a/lib/Model/Metadata.php b/lib/Model/Metadata.php index 94d0dcb2..c13a084d 100644 --- a/lib/Model/Metadata.php +++ b/lib/Model/Metadata.php @@ -36,12 +36,18 @@ use YooKassa\Common\AbstractObject; */ class Metadata extends AbstractObject implements \IteratorAggregate, \Countable { + /** + * @inheritdoc + * + * @return array + */ public function toArray() { return $this->getUnknownProperties(); } /** + * Возвращает объект ArrayIterator для метаданных * @return \Iterator */ public function getIterator() @@ -50,6 +56,7 @@ class Metadata extends AbstractObject implements \IteratorAggregate, \Countable } /** + * Возвращает количество метаданных * @return int */ public function count() diff --git a/lib/Model/MonetaryAmount.php b/lib/Model/MonetaryAmount.php index fb169307..834a8b4b 100644 --- a/lib/Model/MonetaryAmount.php +++ b/lib/Model/MonetaryAmount.php @@ -52,7 +52,7 @@ class MonetaryAmount extends AbstractObject implements AmountInterface /** * MonetaryAmount constructor. - * @param string|null $value Сумма + * @param numeric|null $value Сумма * @param string|null $currency Код валюты */ public function __construct($value = null, $currency = null) diff --git a/lib/Model/Notification/AbstractNotification.php b/lib/Model/Notification/AbstractNotification.php index 30b7ecb1..10209100 100644 --- a/lib/Model/Notification/AbstractNotification.php +++ b/lib/Model/Notification/AbstractNotification.php @@ -33,16 +33,20 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Helpers\TypeCast; use YooKassa\Model\NotificationEventType; use YooKassa\Model\NotificationType; +use YooKassa\Model\PaymentInterface; +use YooKassa\Model\RefundInterface; /** * Базовый класс уведомлений * - * @package YooKassa\Model\Notification + * @example 03-notification.php 3 Пример скрипта обработки уведомления + * + * @package YooKassa * * @property-read string $type Тип уведомления в виде строки * @property-read string $event Тип события */ -abstract class AbstractNotification extends AbstractObject +abstract class AbstractNotification extends AbstractObject implements NotificationInterface { /** * @var string Тип уведомления @@ -135,4 +139,18 @@ abstract class AbstractNotification extends AbstractObject ); } } + + /** + * Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте + * + * Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет + * получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о + * платеже у API. + * + * @return PaymentInterface|RefundInterface Объект с информацией о платеже + */ + public function getObject() + { + return null; + } } \ No newline at end of file diff --git a/lib/Model/Notification/NotificationCanceled.php b/lib/Model/Notification/NotificationCanceled.php index 57bdad08..5f64868c 100644 --- a/lib/Model/Notification/NotificationCanceled.php +++ b/lib/Model/Notification/NotificationCanceled.php @@ -35,6 +35,15 @@ use YooKassa\Model\Payment; use YooKassa\Model\PaymentInterface; use YooKassa\Request\Payments\PaymentResponse; +/** + * Класс объекта, присылаемого API при изменении статуса платежа на "canceled" + * + * @example 03-notification.php 3 Пример скрипта обработки уведомления + * + * @package YooKassa + * + * @property-read PaymentInterface $object Объект с информацией о платеже + */ class NotificationCanceled extends AbstractNotification { /** diff --git a/lib/Model/Notification/NotificationFactory.php b/lib/Model/Notification/NotificationFactory.php index 7146109a..4e8bf859 100644 --- a/lib/Model/Notification/NotificationFactory.php +++ b/lib/Model/Notification/NotificationFactory.php @@ -29,6 +29,13 @@ namespace YooKassa\Model\Notification; use YooKassa\Model\Notification\AbstractNotification; use YooKassa\Model\NotificationEventType; +/** + * Фабрика для получения конкретного объекта уведомления. + * + * @example 03-notification.php 3 Пример скрипта обработки уведомления + * + * @package YooKassa + */ class NotificationFactory { private $typeClassMap = array( diff --git a/lib/Model/Notification/NotificationInterface.php b/lib/Model/Notification/NotificationInterface.php new file mode 100644 index 00000000..dc81e7a2 --- /dev/null +++ b/lib/Model/Notification/NotificationInterface.php @@ -0,0 +1,63 @@ +_transfers = $value; } + /** + * Возвращает массив распределения денег между магазинами + * @return TransferInterface[] + */ public function getTransfers() { return $this->_transfers; } /** + * Устанавливает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa * @param MonetaryAmount $amount */ public function setIncomeAmount(MonetaryAmount $amount) @@ -649,13 +662,18 @@ class Payment extends AbstractObject implements PaymentInterface $this->_incomeAmount = $amount; } + /** + * Возвращает сумму платежа, которую получит магазин, значение `amount` за вычетом комиссии ЮKassa + * @return MonetaryAmount Сумма платежа, которую получит магазин + */ public function getIncomeAmount() { return $this->_incomeAmount; } /** - * @param $value + * Устанавливает инициатора платежа + * @param RequestorInterface|array $value */ public function setRequestor($value) { @@ -671,6 +689,7 @@ class Payment extends AbstractObject implements PaymentInterface } /** + * Возвращает инициатора платежа * @return RequestorInterface */ public function getRequestor() @@ -679,7 +698,8 @@ class Payment extends AbstractObject implements PaymentInterface } /** - * @return bool + * Возвращает признак тестовой операции + * @return bool Признак тестовой операции */ public function getTest() { @@ -687,7 +707,8 @@ class Payment extends AbstractObject implements PaymentInterface } /** - * @param bool $test + * Устанавливает признак тестовой операции + * @param bool $test Признак тестовой операции */ public function setTest($test) { diff --git a/lib/Model/PaymentData/AbstractPaymentData.php b/lib/Model/PaymentData/AbstractPaymentData.php index bb91a547..6426a7ec 100644 --- a/lib/Model/PaymentData/AbstractPaymentData.php +++ b/lib/Model/PaymentData/AbstractPaymentData.php @@ -35,7 +35,7 @@ use YooKassa\Model\PaymentMethodType; /** * Данные используемые для создания метода оплаты. - * @property string $type + * @property string $type Тип метода оплаты */ abstract class AbstractPaymentData extends AbstractObject { @@ -45,7 +45,8 @@ abstract class AbstractPaymentData extends AbstractObject private $_type; /** - * @return string + * Возвращает тип метода оплаты + * @return string Тип метода оплаты */ public function getType() { @@ -53,7 +54,8 @@ abstract class AbstractPaymentData extends AbstractObject } /** - * @param string $value + * Устанавливает тип метода оплаты + * @param string $value Тип метода оплаты */ protected function _setType($value) { diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatData.php b/lib/Model/PaymentData/B2b/Sberbank/VatData.php index 7e94f4a3..f463dfe0 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatData.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatData.php @@ -76,6 +76,7 @@ class VatData extends AbstractObject implements VatDataInterface } /** + * Возвращает способ расчёта НДС * @return string Способ расчёта НДС */ public function getType() @@ -106,6 +107,7 @@ class VatData extends AbstractObject implements VatDataInterface } /** + * Возвращает налоговую ставку НДС * @return string Налоговая ставка НДС */ public function getRate() diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php b/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php index 74ddbe6a..9d5ef282 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatDataInterface.php @@ -31,7 +31,7 @@ use YooKassa\Model\AmountInterface; /** * Interface VatDataInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $type Способ расчёта НДС * @property-read string $rate Данные об НДС в случае, если сумма НДС включена в сумму платежа diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php b/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php index de5d8c94..3121b548 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatDataRate.php @@ -39,9 +39,13 @@ use YooKassa\Common\AbstractEnum; */ class VatDataRate extends AbstractEnum { + /** 7% */ const RATE_7 = '7'; + /** 10% */ const RATE_10 = '10'; + /** 18% */ const RATE_18 = '18'; + /** 20% */ const RATE_20 = '20'; protected static $validValues = array( diff --git a/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php b/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php index edc3575e..bbd43dcf 100644 --- a/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php +++ b/lib/Model/PaymentData/B2b/Sberbank/VatDataType.php @@ -38,8 +38,11 @@ use YooKassa\Common\AbstractEnum; */ class VatDataType extends AbstractEnum { + /** Сумма НДС включена в сумму платежа */ const CALCULATED = 'calculated'; + /** Разные ставки НДС для разных товаров */ const MIXED = 'mixed'; + /** Сумма платежа НДС не облагается */ const UNTAXED = 'untaxed'; protected static $validValues = array( diff --git a/lib/Model/PaymentData/PaymentDataAlfabank.php b/lib/Model/PaymentData/PaymentDataAlfabank.php index 655ed305..66e373ac 100644 --- a/lib/Model/PaymentData/PaymentDataAlfabank.php +++ b/lib/Model/PaymentData/PaymentDataAlfabank.php @@ -49,6 +49,7 @@ class PaymentDataAlfabank extends AbstractPaymentData } /** + * Возвращает имя пользователя в Альфа-Клике * @return string Имя пользователя в Альфа-Клике */ public function getLogin() @@ -57,6 +58,7 @@ class PaymentDataAlfabank extends AbstractPaymentData } /** + * Устанавливает имя пользователя в Альфа-Клике * @param string $value Имя пользователя в Альфа-Клике */ public function setLogin($value) diff --git a/lib/Model/PaymentData/PaymentDataApplePay.php b/lib/Model/PaymentData/PaymentDataApplePay.php index fc60948c..640fde56 100644 --- a/lib/Model/PaymentData/PaymentDataApplePay.php +++ b/lib/Model/PaymentData/PaymentDataApplePay.php @@ -51,6 +51,7 @@ class PaymentDataApplePay extends AbstractPaymentData } /** + * Возвращает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 * @return string содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 */ public function getPaymentData() @@ -59,6 +60,7 @@ class PaymentDataApplePay extends AbstractPaymentData } /** + * Устанавливает содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 * @param string $value содержимое поля paymentData объекта PKPaymentToken, закодированное в Base64 */ public function setPaymentData($value) diff --git a/lib/Model/PaymentData/PaymentDataB2bSberbank.php b/lib/Model/PaymentData/PaymentDataB2bSberbank.php index b55caf79..bbd4166d 100644 --- a/lib/Model/PaymentData/PaymentDataB2bSberbank.php +++ b/lib/Model/PaymentData/PaymentDataB2bSberbank.php @@ -57,6 +57,7 @@ class PaymentDataB2bSberbank extends AbstractPaymentData } /** + * Возвращает назначение платежа * @return string Назначение платежа */ public function getPaymentPurpose() @@ -65,6 +66,7 @@ class PaymentDataB2bSberbank extends AbstractPaymentData } /** + * Устанавливает назначение платежа * @param string $value Назначение платежа */ public function setPaymentPurpose($value) @@ -88,6 +90,7 @@ class PaymentDataB2bSberbank extends AbstractPaymentData } /** + * Возвращает назначение платежа * @return VatData Данные об НДС */ public function getVatData() @@ -96,6 +99,7 @@ class PaymentDataB2bSberbank extends AbstractPaymentData } /** + * Устанавливает назначение платежа * @param VatData|array|null $value Данные об НДС */ public function setVatData($value) diff --git a/lib/Model/PaymentData/PaymentDataBankCard.php b/lib/Model/PaymentData/PaymentDataBankCard.php index 597b8606..145f19f0 100644 --- a/lib/Model/PaymentData/PaymentDataBankCard.php +++ b/lib/Model/PaymentData/PaymentDataBankCard.php @@ -49,6 +49,7 @@ class PaymentDataBankCard extends AbstractPaymentData } /** + * Возвращает данные банковской карты * @return PaymentDataBankCardCard Данные банковской карты */ public function getCard() @@ -57,6 +58,7 @@ class PaymentDataBankCard extends AbstractPaymentData } /** + * Устанавливает данные банковской карты * @param PaymentDataBankCardCard|array $value Данные банковской карты */ public function setCard($value) diff --git a/lib/Model/PaymentData/PaymentDataBankCardCard.php b/lib/Model/PaymentData/PaymentDataBankCardCard.php index b5898cb0..f6503b7c 100644 --- a/lib/Model/PaymentData/PaymentDataBankCardCard.php +++ b/lib/Model/PaymentData/PaymentDataBankCardCard.php @@ -71,6 +71,7 @@ class PaymentDataBankCardCard extends AbstractObject private $_cardholder; /** + * Возвращает номер банковской карты * @return string Номер банковской карты */ public function getNumber() @@ -79,6 +80,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Устанавливает номер банковской карты * @param string $value Номер банковской карты */ public function setNumber($value) @@ -101,6 +103,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Возвращает год срока действия карты * @return string Срок действия, год, YYYY */ public function getExpiryYear() @@ -109,6 +112,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Устанавливает год срока действия карты * @param string $value Срок действия, год, YYYY */ public function setExpiryYear($value) @@ -132,6 +136,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Возвращает месяц срока действия карты * @return string Срок действия, месяц, MM */ public function getExpiryMonth() @@ -140,6 +145,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Устанавливает месяц срока действия карты * @param string $value Срок действия, месяц, MM */ public function setExpiryMonth($value) @@ -174,6 +180,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Возвращает CVV2/CVC2 код * @return string CVV2/CVC2 код */ public function getCsc() @@ -182,6 +189,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Устанавливает CVV2/CVC2 код * @param string $value CVV2/CVC2 код */ public function setCsc($value) @@ -206,6 +214,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Возвращает имя держателя карты * @return string Имя держателя карты */ public function getCardholder() @@ -214,6 +223,7 @@ class PaymentDataBankCardCard extends AbstractObject } /** + * Устанавливает имя держателя карты * @param string $value Имя держателя карты */ public function setCardholder($value) diff --git a/lib/Model/PaymentData/PaymentDataCash.php b/lib/Model/PaymentData/PaymentDataCash.php index 86c06bec..26310bd1 100644 --- a/lib/Model/PaymentData/PaymentDataCash.php +++ b/lib/Model/PaymentData/PaymentDataCash.php @@ -34,7 +34,7 @@ use YooKassa\Model\PaymentMethodType; /** * PaymentDataCash * Платежные данные для проведения оплаты Qiwi. - * @property string $phone + * @property string $phone Номер телефона в формате ITU-T E.164 */ class PaymentDataCash extends AbstractPaymentData { @@ -50,7 +50,8 @@ class PaymentDataCash extends AbstractPaymentData } /** - * @return string + * Возвращает номер телефона в формате ITU-T E.164 + * @return string Номер телефона в формате ITU-T E.164 */ public function getPhone() { @@ -58,7 +59,8 @@ class PaymentDataCash extends AbstractPaymentData } /** - * @param string $value + * Устанавливает номер телефона в формате ITU-T E.164 + * @param string $value Номер телефона в формате ITU-T E.164 */ public function setPhone($value) { diff --git a/lib/Model/PaymentData/PaymentDataFactory.php b/lib/Model/PaymentData/PaymentDataFactory.php index f309d8d4..04cf051f 100644 --- a/lib/Model/PaymentData/PaymentDataFactory.php +++ b/lib/Model/PaymentData/PaymentDataFactory.php @@ -28,6 +28,11 @@ namespace YooKassa\Model\PaymentData; use YooKassa\Model\PaymentMethodType; +/** + * Фабрика создания объекта платежных данных из массива + * + * @package YooKassa + */ class PaymentDataFactory { private $typeClassMap = array( @@ -48,7 +53,8 @@ class PaymentDataFactory ); /** - * @param string $type + * Фабричный метод создания объекта платежных данных по типу + * @param string $type Тип платежных данных * * @return AbstractPaymentData */ @@ -66,8 +72,10 @@ class PaymentDataFactory } /** - * @param array $data - * @param string|null $type + * Фабричный метод создания объекта платежных данных из массива + * + * @param array $data Массив платежных данных + * @param string|null $type Тип платежных данных * * @return AbstractPaymentData */ diff --git a/lib/Model/PaymentData/PaymentDataGooglePay.php b/lib/Model/PaymentData/PaymentDataGooglePay.php index 6465dfd0..a4940fdd 100644 --- a/lib/Model/PaymentData/PaymentDataGooglePay.php +++ b/lib/Model/PaymentData/PaymentDataGooglePay.php @@ -55,6 +55,7 @@ class PaymentDataGooglePay extends AbstractPaymentData } /** + * Возвращает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay * @return string Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay */ public function getPaymentMethodToken() @@ -63,6 +64,7 @@ class PaymentDataGooglePay extends AbstractPaymentData } /** + * Устанавливает криптограмму Payment Token Cryptography для проведения оплаты через Google Pay * @param string $value Криптограмма Payment Token Cryptography для проведения оплаты через Google Pay */ public function setPaymentMethodToken($value) @@ -81,6 +83,7 @@ class PaymentDataGooglePay extends AbstractPaymentData } /** + * Возвращает уникальный идентификатор транзакции, выданный Google * @return string Уникальный идентификатор транзакции, выданный Google */ public function getGoogleTransactionId() @@ -89,6 +92,7 @@ class PaymentDataGooglePay extends AbstractPaymentData } /** + * Устанавливает уникальный идентификатор транзакции, выданный Google * @param string $value Уникальный идентификатор транзакции, выданный Google */ public function setGoogleTransactionId($value) diff --git a/lib/Model/PaymentData/PaymentDataMobileBalance.php b/lib/Model/PaymentData/PaymentDataMobileBalance.php index f26bff73..91d13f7b 100644 --- a/lib/Model/PaymentData/PaymentDataMobileBalance.php +++ b/lib/Model/PaymentData/PaymentDataMobileBalance.php @@ -51,6 +51,7 @@ class PaymentDataMobileBalance extends AbstractPaymentData } /** + * Возвращает номер телефона в формате ITU-T E.164 * @return string */ public function getPhone() @@ -59,6 +60,7 @@ class PaymentDataMobileBalance extends AbstractPaymentData } /** + * Устанавливает номер телефона в формате ITU-T E.164 * @param string $value */ public function setPhone($value) diff --git a/lib/Model/PaymentData/PaymentDataQiwi.php b/lib/Model/PaymentData/PaymentDataQiwi.php index 5f6542f6..bacac439 100644 --- a/lib/Model/PaymentData/PaymentDataQiwi.php +++ b/lib/Model/PaymentData/PaymentDataQiwi.php @@ -50,6 +50,7 @@ class PaymentDataQiwi extends AbstractPaymentData } /** + * Возвращает номер телефона в формате ITU-T E.164 * @return string */ public function getPhone() @@ -58,6 +59,7 @@ class PaymentDataQiwi extends AbstractPaymentData } /** + * Устанавливает номер телефона в формате ITU-T E.164 * @param string $value */ public function setPhone($value) diff --git a/lib/Model/PaymentData/PaymentDataSberbank.php b/lib/Model/PaymentData/PaymentDataSberbank.php index 57cf11a2..b41fef82 100644 --- a/lib/Model/PaymentData/PaymentDataSberbank.php +++ b/lib/Model/PaymentData/PaymentDataSberbank.php @@ -55,6 +55,7 @@ class PaymentDataSberbank extends AbstractPaymentData } /** + * Возвращает номер телефона в формате ITU-T E.164 * @return string */ public function getPhone() @@ -63,6 +64,7 @@ class PaymentDataSberbank extends AbstractPaymentData } /** + * Устанавливает номер телефона в формате ITU-T E.164 * @param string $value */ public function setPhone($value) diff --git a/lib/Model/PaymentInterface.php b/lib/Model/PaymentInterface.php index a1183d68..dc564e5b 100644 --- a/lib/Model/PaymentInterface.php +++ b/lib/Model/PaymentInterface.php @@ -31,18 +31,21 @@ use YooKassa\Model\PaymentMethod\AbstractPaymentMethod; /** * Interface PaymentInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $id Идентификатор платежа * @property-read string $status Текущее состояние платежа * @property-read RecipientInterface $recipient Получатель платежа * @property-read AmountInterface $amount Сумма заказа + * @property-read string $description Описание транзакции * @property-read AbstractPaymentMethod $paymentMethod Способ проведения платежа * @property-read AbstractPaymentMethod $payment_method Способ проведения платежа * @property-read \DateTime $createdAt Время создания заказа * @property-read \DateTime $created_at Время создания заказа * @property-read \DateTime $capturedAt Время подтверждения платежа магазином * @property-read \DateTime $captured_at Время подтверждения платежа магазином + * @property-read \DateTime $expiresAt Время, до которого можно бесплатно отменить или подтвердить платеж + * @property-read \DateTime $expires_at Время, до которого можно бесплатно отменить или подтвердить платеж * @property-read Confirmation\AbstractConfirmation $confirmation Способ подтверждения платежа * @property-read AmountInterface $refundedAmount Сумма возвращенных средств платежа * @property-read AmountInterface $refunded_amount Сумма возвращенных средств платежа @@ -51,6 +54,15 @@ use YooKassa\Model\PaymentMethod\AbstractPaymentMethod; * @property-read string $receiptRegistration Состояние регистрации фискального чека * @property-read string $receipt_registration Состояние регистрации фискального чека * @property-read Metadata $metadata Метаданные платежа указанные мерчантом + * @property-read bool $test Признак тестовой операции + * @property-read CancellationDetailsInterface $cancellationDetails Комментарий к отмене платежа + * @property-read CancellationDetailsInterface $cancellation_details Комментарий к отмене платежа + * @property-read AuthorizationDetailsInterface $authorizationDetails Данные об авторизации платежа + * @property-read AuthorizationDetailsInterface $authorization_details Данные об авторизации платежа + * @property-read TransferInterface[] $transfers Данные о распределении платежа между магазинами + * @property-read AmountInterface $incomeAmount Сумма платежа, которую получит магазин + * @property-read AmountInterface $income_amount Сумма платежа, которую получит магазин + * @property-read Requestor $requestor Инициатор платежа */ interface PaymentInterface { @@ -166,6 +178,7 @@ interface PaymentInterface public function getIncomeAmount(); /** + * Возвращает инициатора платежа * @return RequestorInterface */ public function getRequestor(); diff --git a/lib/Model/PaymentMethod/AbstractPaymentMethod.php b/lib/Model/PaymentMethod/AbstractPaymentMethod.php index d50457ef..5d125577 100644 --- a/lib/Model/PaymentMethod/AbstractPaymentMethod.php +++ b/lib/Model/PaymentMethod/AbstractPaymentMethod.php @@ -34,6 +34,8 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\PaymentMethodType; /** + * Абстрактный класс, описывающий основные свойства и методы платежных методов + * * @property string $id Идентификатор записи о сохраненных платежных данных * @property bool $saved Возможность многократного использования * @property string $title Название метода оплаты @@ -61,6 +63,7 @@ abstract class AbstractPaymentMethod extends AbstractObject private $_title; /** + * Возвращает тип объекта * @return string Тип объекта */ public function getType() @@ -69,6 +72,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Устанавливает тип объекта * @param string $value Тип объекта */ protected function _setType($value) @@ -93,6 +97,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Устанавливает идентификатор записи о сохраненных платежных данных * @return string Идентификатор записи о сохраненных платежных данных */ public function getId() @@ -101,6 +106,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Возвращает идентификатор записи о сохраненных платежных данных * @param string $value Идентификатор записи о сохраненных платежных данных */ public function setId($value) @@ -115,6 +121,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Возвращает признак возможности многократного использования * @return bool Возможность многократного использования */ public function getSaved() @@ -123,6 +130,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Устанавливает признак возможности многократного использования * @param bool $value Возможность многократного использования */ public function setSaved($value) @@ -139,6 +147,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Возвращает название метода оплаты * @return string|null Название метода оплаты */ public function getTitle() @@ -147,6 +156,7 @@ abstract class AbstractPaymentMethod extends AbstractObject } /** + * Устанавливает название метода оплаты * @param string $value Название метода оплаты */ public function setTitle($value) diff --git a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php index d75afec2..3217d8ee 100644 --- a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php +++ b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetails.php @@ -97,7 +97,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает полное наименование организации + * @param string $value Полное наименование организации */ public function setFullName($value) { @@ -114,7 +115,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает сокращенное наименование организации + * @param string $value Сокращенное наименование организации */ public function setShortName($value) { @@ -131,7 +133,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает адрес организации + * @param string $value Адрес организации */ public function setAddress($value) { @@ -148,7 +151,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает ИНН организации + * @param string $value ИНН организации */ public function setInn($value) { @@ -165,7 +169,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает КПП организации + * @param string $value КПП организации */ public function setKpp($value) { @@ -182,7 +187,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает наименование банка организации + * @param string $value Наименование банка организации */ public function setBankName($value) { @@ -199,7 +205,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает отделение банка организации + * @param string $value Отделение банка организации */ public function setBankBranch($value) { @@ -216,7 +223,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает БИК банка организации + * @param string $value БИК банка организации */ public function setBankBik($value) { @@ -233,7 +241,8 @@ class PayerBankDetails extends AbstractObject implements PayerBankDetailsInterfa } /** - * @param string $value + * Устанавливает номер счета организации + * @param string $value Номер счета организации */ public function setAccount($value) { diff --git a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php index 6e797bb3..931c047f 100644 --- a/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php +++ b/lib/Model/PaymentMethod/B2b/Sberbank/PayerBankDetailsInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model\PaymentMethod\B2b\Sberbank; /** * Interface PayerBankDetailsInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $fullName Полное наименование организации * @property-read string $shortName Сокращенное наименование организации diff --git a/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php b/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php index da78cd76..a3ae1b2d 100644 --- a/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php +++ b/lib/Model/PaymentMethod/PaymentMethodAlfaBank.php @@ -31,8 +31,8 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodAlfaBank - * Объект, описывающий метод оплаты, при оплате через Альфа Банк. + * Класс, описывающий метод оплаты, при оплате через Альфа Банк + * * @property string $type Тип объекта * @property string $login Имя пользователя в Альфа-Клике */ @@ -49,6 +49,7 @@ class PaymentMethodAlfaBank extends AbstractPaymentMethod } /** + * Возвращает имя пользователя в Альфа-Клике * @return string Имя пользователя в Альфа-Клике */ public function getLogin() @@ -57,6 +58,7 @@ class PaymentMethodAlfaBank extends AbstractPaymentMethod } /** + * Устанавливает имя пользователя в Альфа-Клике * @param string $value Имя пользователя в Альфа-Клике */ public function setLogin($value) diff --git a/lib/Model/PaymentMethod/PaymentMethodApplePay.php b/lib/Model/PaymentMethod/PaymentMethodApplePay.php index 68057e4f..436a556c 100644 --- a/lib/Model/PaymentMethod/PaymentMethodApplePay.php +++ b/lib/Model/PaymentMethod/PaymentMethodApplePay.php @@ -29,8 +29,8 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodApplePay - * Объект, описывающий метод оплаты, при оплате через Apple Pay + * Класс, описывающий метод оплаты, при оплате через Apple Pay + * * @property string $type Тип объекта */ class PaymentMethodApplePay extends AbstractPaymentMethod diff --git a/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php b/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php index eddf15df..c4f2a3f2 100644 --- a/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php +++ b/lib/Model/PaymentMethod/PaymentMethodB2bSberbank.php @@ -32,8 +32,13 @@ use YooKassa\Model\PaymentMethod\B2b\Sberbank\PayerBankDetails; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodB2bSberbank - * Объект, описывающий метод оплаты, при оплате через Сбербанк Бизнес Онлайн + * Класс, описывающий метод оплаты, при оплате через Сбербанк Бизнес Онлайн + * + * @property string $paymentPurpose Назначение платежа + * @property string $payment_purpose Назначение платежа + * @property VatData $vatData Данные об НДС + * @property PayerBankDetails $payerBankDetails Банковские реквизиты плательщика + * @property PayerBankDetails $payer_bank_details Банковские реквизиты плательщика */ class PaymentMethodB2bSberbank extends AbstractPaymentMethod { @@ -48,7 +53,7 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod private $_vatData; /** - * @var PayerBankDetails + * @var PayerBankDetails Банковские реквизиты плательщика (юридического лица или ИП). */ private $_payerBankDetails; @@ -58,7 +63,8 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod } /** - * @return string + * Возвращает назначение платежа + * @return string Назначение платежа */ public function getPaymentPurpose() { @@ -66,7 +72,8 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod } /** - * @param string $paymentPurpose + * Устанавливает назначение платежа + * @param string $paymentPurpose Назначение платежа */ public function setPaymentPurpose($paymentPurpose) { @@ -74,7 +81,8 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod } /** - * @return VatData + * Возвращает назначение платежа + * @return VatData Данные об НДС */ public function getVatData() { @@ -82,7 +90,8 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod } /** - * @param VatData $vatData + * Устанавливает назначение платежа + * @param VatData $vatData Данные об НДС */ public function setVatData($vatData) { @@ -99,7 +108,8 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod } /** - * @return PayerBankDetails + * Возвращает банковские реквизиты плательщика (юридического лица или ИП) + * @return PayerBankDetails Банковские реквизиты плательщика */ public function getPayerBankDetails() { @@ -107,7 +117,8 @@ class PaymentMethodB2bSberbank extends AbstractPaymentMethod } /** - * @param $payerBankDetails + * Устанавливает Банковские реквизиты плательщика (юридического лица или ИП). + * @param PayerBankDetails|array $payerBankDetails Банковские реквизиты плательщика */ public function setPayerBankDetails($payerBankDetails) { diff --git a/lib/Model/PaymentMethod/PaymentMethodBankCard.php b/lib/Model/PaymentMethod/PaymentMethodBankCard.php index 7c50b28c..6da16191 100644 --- a/lib/Model/PaymentMethod/PaymentMethodBankCard.php +++ b/lib/Model/PaymentMethod/PaymentMethodBankCard.php @@ -33,8 +33,8 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodBankCard - * Объект, описывающий метод оплаты банковской картой + * Класс, описывающий метод оплаты банковской картой + * * @property string $type Тип объекта * @property string $last4 Последние 4 цифры номера карты * @property string $first6 Первые 6 цифр номера карты @@ -44,9 +44,9 @@ use YooKassa\Model\PaymentMethodType; * @property string $expiry_month Срок действия, месяц * @property string $cardType Тип банковской карты * @property string $card_type Тип банковской карты - * @property string $issuerCountry Тип банковской карты - * @property string $issuer_country Тип банковской карты - * @property string issuerName Тип банковской карты + * @property string $issuerCountry Код страны, в которой выпущена карта + * @property string $issuer_country Код страны, в которой выпущена карта + * @property string $issuerName Тип банковской карты * @property string $issuer_name Тип банковской карты * @property string $source Тип банковской карты */ @@ -103,6 +103,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Возвращает последние 4 цифры номера карты * @return string Последние 4 цифры номера карты */ public function getLast4() @@ -111,6 +112,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Устанавливает последние 4 цифры номера карты * @param string $value Последние 4 цифры номера карты */ public function setLast4($value) @@ -133,7 +135,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @return string + * Возвращает первые 6 цифр номера карты + * @return string Первые 6 цифр номера карты * @since 1.0.14 */ public function getFirst6() @@ -142,7 +145,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @param $value + * Устанавливает первые 6 цифр номера карты + * @param string $value Первые 6 цифр номера карты * @since 1.0.14 */ public function setFirst6($value) @@ -165,6 +169,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Возвращает срок действия, год * @return string Срок действия, год */ public function getExpiryYear() @@ -173,6 +178,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Устанавливает срок действия, год * @param string $value Срок действия, год */ public function setExpiryYear($value) @@ -196,6 +202,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Возвращает срок действия, месяц * @return string Срок действия, месяц */ public function getExpiryMonth() @@ -204,6 +211,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Устанавливает срок действия, месяц * @param string $value Срок действия, месяц */ public function setExpiryMonth($value) @@ -238,6 +246,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Возвращает тип банковской карты * @return string Тип банковской карты */ public function getCardType() @@ -246,6 +255,7 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** + * Устанавливает тип банковской карты * @param string $value Тип банковской карты */ public function setCardType($value) @@ -262,7 +272,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @return string + * Возвращает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 + * @return string Код страны, в которой выпущена карта */ public function getIssuerCountry() { @@ -270,7 +281,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @param string $value + * Устанавливает код страны, в которой выпущена карта. Передается в формате ISO-3166 alpha-2 + * @param string $value Код страны, в которой выпущена карта */ public function setIssuerCountry($value) { @@ -290,7 +302,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @param string $value + * Устанавливает наименование банка, выпустившего карту + * @param string $value Наименование банка, выпустившего карту */ public function setIssuerName($value) { @@ -306,7 +319,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @return string + * Возвращает наименование банка, выпустившего карту + * @return string Наименование банка, выпустившего карту. */ public function getIssuerName() { @@ -314,7 +328,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @param string $value + * Устанавливает источник данных банковской карты + * @param string $value Источник данных банковской карты */ public function setSource($value) { @@ -334,7 +349,8 @@ class PaymentMethodBankCard extends AbstractPaymentMethod } /** - * @return string + * Возвращает источник данных банковской карты + * @return string Источник данных банковской карты */ public function getSource() { diff --git a/lib/Model/PaymentMethod/PaymentMethodCash.php b/lib/Model/PaymentMethod/PaymentMethodCash.php index 9f054f64..49d42c95 100644 --- a/lib/Model/PaymentMethod/PaymentMethodCash.php +++ b/lib/Model/PaymentMethod/PaymentMethodCash.php @@ -29,8 +29,8 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodCash - * Объект, описывающий метод оплаты, при оплате наличными через терминал. + * Класс, описывающий метод оплаты, при оплате наличными через терминал + * * @property string $type Тип объекта */ class PaymentMethodCash extends AbstractPaymentMethod diff --git a/lib/Model/PaymentMethod/PaymentMethodFactory.php b/lib/Model/PaymentMethod/PaymentMethodFactory.php index 3bdff079..bcc57dce 100644 --- a/lib/Model/PaymentMethod/PaymentMethodFactory.php +++ b/lib/Model/PaymentMethod/PaymentMethodFactory.php @@ -28,6 +28,11 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; +/** + * Фабрика создания объекта платежных методов из массива + * + * @package YooKassa + */ class PaymentMethodFactory { private $typeClassMap = array( @@ -56,7 +61,9 @@ class PaymentMethodFactory ); /** - * @param string $type + * Фабричный метод создания объекта платежных данных по типу + * + * @param string $type Тип платежного метода * * @return AbstractPaymentMethod */ @@ -74,8 +81,10 @@ class PaymentMethodFactory } /** - * @param array $data - * @param string|null $type + * Фабричный метод создания объекта платежных данных из массива + * + * @param array $data Массив платежных данных + * @param string|null $type Тип платежного метода * * @return AbstractPaymentMethod */ diff --git a/lib/Model/PaymentMethod/PaymentMethodGooglePay.php b/lib/Model/PaymentMethod/PaymentMethodGooglePay.php index 53db42e6..537fa07a 100644 --- a/lib/Model/PaymentMethod/PaymentMethodGooglePay.php +++ b/lib/Model/PaymentMethod/PaymentMethodGooglePay.php @@ -29,8 +29,8 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodGooglePay - * Объект, описывающий метод оплаты, при оплате через Google Pay + * Класс, описывающий метод оплаты, при оплате через Google Pay + * * @property string $type Тип объекта */ class PaymentMethodGooglePay extends AbstractPaymentMethod diff --git a/lib/Model/PaymentMethod/PaymentMethodInstallments.php b/lib/Model/PaymentMethod/PaymentMethodInstallments.php index df110079..464cc164 100644 --- a/lib/Model/PaymentMethod/PaymentMethodInstallments.php +++ b/lib/Model/PaymentMethod/PaymentMethodInstallments.php @@ -29,8 +29,8 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodInstallments - * Объект, описывающий метод оплаты при оплате по частям + * Класс, описывающий метод оплаты при оплате по частям + * * @property string $type Тип объекта */ class PaymentMethodInstallments extends AbstractPaymentMethod diff --git a/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php b/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php index 291ce376..0da6f017 100644 --- a/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php +++ b/lib/Model/PaymentMethod/PaymentMethodMobileBalance.php @@ -33,15 +33,15 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodMobileBalance - * Объект, описывающий метод оплаты, при оплате с баланса мобильного телефона. + * Класс, описывающий метод оплаты, при оплате с баланса мобильного телефона + * * @property string $type Тип объекта - * @property string $phone + * @property string $phone Номер телефона в формате ITU-T E.164 с которого плательщик собирается произвести оплату */ class PaymentMethodMobileBalance extends AbstractPaymentMethod { /** - * Номер телефона в формате ITU-T E.164 с которого плательщик собирается произвести оплату. + * Номер телефона в формате ITU-T E.164 с которого плательщик собирается произвести оплату * @var string */ private $_phone; @@ -52,6 +52,7 @@ class PaymentMethodMobileBalance extends AbstractPaymentMethod } /** + * Возвращает номер телефона в формате ITU-T E.164 * @return string */ public function getPhone() @@ -60,6 +61,7 @@ class PaymentMethodMobileBalance extends AbstractPaymentMethod } /** + * Устанавливает номер телефона в формате ITU-T E.164 * @param string $value */ public function setPhone($value) diff --git a/lib/Model/PaymentMethod/PaymentMethodQiwi.php b/lib/Model/PaymentMethod/PaymentMethodQiwi.php index b5032c5c..65100d79 100644 --- a/lib/Model/PaymentMethod/PaymentMethodQiwi.php +++ b/lib/Model/PaymentMethod/PaymentMethodQiwi.php @@ -29,8 +29,8 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodQiwi - * Объект, описывающий метод оплаты, при оплате через Qiwi. + * Класс, описывающий метод оплаты, при оплате через Qiwi + * * @property string $type Тип объекта */ class PaymentMethodQiwi extends AbstractPaymentMethod diff --git a/lib/Model/PaymentMethod/PaymentMethodSberbank.php b/lib/Model/PaymentMethod/PaymentMethodSberbank.php index b0796729..83be245c 100644 --- a/lib/Model/PaymentMethod/PaymentMethodSberbank.php +++ b/lib/Model/PaymentMethod/PaymentMethodSberbank.php @@ -33,10 +33,10 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodSberbank - * Объект, описывающий метод оплаты, при оплате через Сбербанк Онлайн + * Класс, описывающий метод оплаты, при оплате через Сбербанк Онлайн + * * @property string $type Тип объекта - * @property string $phone + * @property string $phone Телефон пользователя */ class PaymentMethodSberbank extends AbstractPaymentMethod { @@ -56,7 +56,8 @@ class PaymentMethodSberbank extends AbstractPaymentMethod } /** - * @return string + * Возвращает номер телефона в формате ITU-T E.164 + * @return string Номер телефона в формате ITU-T E.164 */ public function getPhone() { @@ -64,7 +65,8 @@ class PaymentMethodSberbank extends AbstractPaymentMethod } /** - * @param string $value + * Устанавливает номер телефона в формате ITU-T E.164 + * @param string $value Номер телефона в формате ITU-T E.164 */ public function setPhone($value) { diff --git a/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php b/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php index d4cce22b..581e77d3 100644 --- a/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php +++ b/lib/Model/PaymentMethod/PaymentMethodTinkoffBank.php @@ -27,6 +27,11 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; +/** + * Класс, описывающий метод оплаты, при оплате через Tinkoff + * + * @package YooKassa + */ class PaymentMethodTinkoffBank extends AbstractPaymentMethod { public function __construct() diff --git a/lib/Model/PaymentMethod/PaymentMethodWebmoney.php b/lib/Model/PaymentMethod/PaymentMethodWebmoney.php index 15239701..faef8ece 100644 --- a/lib/Model/PaymentMethod/PaymentMethodWebmoney.php +++ b/lib/Model/PaymentMethod/PaymentMethodWebmoney.php @@ -29,8 +29,8 @@ namespace YooKassa\Model\PaymentMethod; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodWebmoney - * Объект, описывающий метод оплаты, при оплате через Webmoney. + * Класс, описывающий метод оплаты, при оплате через Webmoney. + * * @property string $type Тип объекта */ class PaymentMethodWebmoney extends AbstractPaymentMethod diff --git a/lib/Model/PaymentMethod/PaymentMethodYooMoney.php b/lib/Model/PaymentMethod/PaymentMethodYooMoney.php index 5a808471..d74a8887 100644 --- a/lib/Model/PaymentMethod/PaymentMethodYooMoney.php +++ b/lib/Model/PaymentMethod/PaymentMethodYooMoney.php @@ -33,11 +33,11 @@ use YooKassa\Helpers\TypeCast; use YooKassa\Model\PaymentMethodType; /** - * PaymentMethodYooMoney - * Объект, описывающий метод оплаты, при оплате через ЮMoney + * Класс, описывающий метод оплаты, при оплате через ЮMoney + * * @property string $type Тип объекта - * @property string $accountNumber Номер кошелька в ЮMoney с которого была произведена оплата. - * @property string $account_number Номер кошелька в ЮMoney с которого была произведена оплата. + * @property string $accountNumber Номер кошелька в ЮMoney, с которого была произведена оплата + * @property string $account_number Номер кошелька в ЮMoney, с которого была произведена оплата */ class PaymentMethodYooMoney extends AbstractPaymentMethod { @@ -52,7 +52,8 @@ class PaymentMethodYooMoney extends AbstractPaymentMethod } /** - * @return string Номер кошелька в ЮMoney с которого была произведена оплата. + * Возвращает номер кошелька в ЮMoney, с которого была произведена оплата + * @return string Номер кошелька в ЮMoney */ public function getAccountNumber() { @@ -60,7 +61,8 @@ class PaymentMethodYooMoney extends AbstractPaymentMethod } /** - * @param string $value Номер кошелька в ЮMoney с которого была произведена оплата. + * Устанавливает номер кошелька в ЮMoney, с которого была произведена оплата + * @param string $value Номер кошелька в ЮMoney */ public function setAccountNumber($value) { diff --git a/lib/Model/PaymentMethodType.php b/lib/Model/PaymentMethodType.php index f8c82cbb..6661449a 100644 --- a/lib/Model/PaymentMethodType.php +++ b/lib/Model/PaymentMethodType.php @@ -40,33 +40,52 @@ use YooKassa\Common\AbstractEnum; * |apple_pay|Платеж ApplePay| * |google_pay|Платеж Google Pay| * |qiwi|Платеж из кошелька Qiwi| - * |installments|Заплатить по частям| + * |webmoney|Платеж из кошелька Webmoney| + * |alfabank|Платеж через Альфа-Клик| * |b2b_sberbank|Сбербанк Бизнес Онлайн| * |tinkoff_bank|Интернет-банк Тинькофф| * |psb|ПромсвязьБанк| + * |installments|Заплатить по частям| * |wechat|Платеж через WeChat| */ class PaymentMethodType extends AbstractEnum { + /** Платеж из кошелька ЮMoney */ const YOO_MONEY = 'yoo_money'; + /** Платеж с произвольной банковской карты */ const BANK_CARD = 'bank_card'; + /** Платеж СбербанкОнлайн */ const SBERBANK = 'sberbank'; + /** Платеж наличными */ const CASH = 'cash'; + /** Платеж с баланса мобильного телефона */ const MOBILE_BALANCE = 'mobile_balance'; + /** латеж ApplePay */ const APPLE_PAY = 'apple_pay'; + /** Платеж Google Pay */ const GOOGLE_PAY = 'google_pay'; + /** Платеж из кошелька Qiwi */ const QIWI = 'qiwi'; + /** Платеж из кошелька Webmoney */ const WEBMONEY = 'webmoney'; + /** Платеж через Альфа-Клик */ const ALFABANK = 'alfabank'; - const INSTALLMENTS = 'installments'; + /** Сбербанк Бизнес Онлайн */ const B2B_SBERBANK = 'b2b_sberbank'; + /** Интернет-банк Тинькофф */ const TINKOFF_BANK = 'tinkoff_bank'; + /** ПромсвязьБанк */ const PSB = 'psb'; - /** @deprecated Будет удален в следующих версиях */ + /** Заплатить по частям */ + const INSTALLMENTS = 'installments'; + /** + * Оплата через WeChat + * @deprecated Будет удален в следующих версиях + */ const WECHAT = 'wechat'; protected static $validValues = array( - self::YOO_MONEY => true, + self::YOO_MONEY => true, self::BANK_CARD => true, self::SBERBANK => true, self::CASH => true, diff --git a/lib/Model/PaymentStatus.php b/lib/Model/PaymentStatus.php index eed55098..579753e1 100644 --- a/lib/Model/PaymentStatus.php +++ b/lib/Model/PaymentStatus.php @@ -40,9 +40,13 @@ use YooKassa\Common\AbstractEnum; */ class PaymentStatus extends AbstractEnum { + /** Ожидает оплаты покупателем */ const PENDING = 'pending'; + /** Ожидает подтверждения магазином */ const WAITING_FOR_CAPTURE = 'waiting_for_capture'; + /** Успешно оплачен и подтвержден магазином */ const SUCCEEDED = 'succeeded'; + /** Неуспех оплаты или отменен магазином */ const CANCELED = 'canceled'; protected static $validValues = array( diff --git a/lib/Model/Receipt.php b/lib/Model/Receipt.php index b9427c37..006946e6 100644 --- a/lib/Model/Receipt.php +++ b/lib/Model/Receipt.php @@ -81,6 +81,7 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** + * Устанавливает информацию о плательщике * @param ReceiptCustomer $customer */ public function setCustomer($customer) @@ -148,7 +149,7 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** - * Возвращает массив оплат, обеспечивающих выдачу товара. + * Возвращает массив оплат, обеспечивающих выдачу товара * * @return SettlementInterface[] Массив оплат, обеспечивающих выдачу товара. */ @@ -158,7 +159,8 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** - * Возвращает массив оплат, обеспечивающих выдачу товара. + * Возвращает массив оплат, обеспечивающих выдачу товара + * * @param SettlementInterface[] $value */ public function setSettlements($value) @@ -261,6 +263,7 @@ class Receipt extends AbstractObject implements ReceiptInterface /** * Возвращает стоимость доставки исходя из состава чека + * * @return int Стоимость доставки из состава чека в центах/копейках */ public function getShippingAmountValue() @@ -365,9 +368,10 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** - * @deprecated 1.3.0 Устарел — данные рекомендуется брать в параметре receipt.customer.phone. * Возвращает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек * + * @deprecated 1.3.0 Устарел — данные рекомендуется брать в параметре receipt.customer.phone. + * * @return string Номер телефона плательщика */ public function getPhone() @@ -376,8 +380,9 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** + * Устанавливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек + * * @deprecated 1.3.0 Устарел — данные рекомендуется передавать в параметре receipt.customer.phone. - * Устанавливливает номер телефона плательщика в формате ITU-T E.164 на который будет выслан чек * * @param string $value Номер телефона плательщика в формате ITU-T E.164 * @@ -392,9 +397,10 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** - * @deprecated 1.3.0 Устарел — данные рекомендуется брать в параметре receipt.customer.email. * Возвращает адрес электронной почты на который будет выслан чек * + * @deprecated 1.3.0 Устарел — данные рекомендуется брать в параметре receipt.customer.email. + * * @return string E-mail адрес плательщика */ public function getEmail() @@ -403,9 +409,10 @@ class Receipt extends AbstractObject implements ReceiptInterface } /** - * @deprecated 1.3.0 Устарел — данные рекомендуется передавать в параметре receipt.customer.email. * Устанавливает адрес электронной почты на который будет выслан чек * + * @deprecated 1.3.0 Устарел — данные рекомендуется передавать в параметре receipt.customer.email. + * * @param string $value E-mail адрес плательщика * * @throws InvalidPropertyValueTypeException Выбрасывается если в качестве значения была передана не строка @@ -420,6 +427,7 @@ class Receipt extends AbstractObject implements ReceiptInterface /** * Устанавливает значения свойств текущего объекта из массива + * * @param array|\Traversable $sourceArray Ассоциативный массив с настройками */ public function fromArray($sourceArray) diff --git a/lib/Model/Receipt/ReceiptItemAmount.php b/lib/Model/Receipt/ReceiptItemAmount.php index fe043936..c688b9a0 100644 --- a/lib/Model/Receipt/ReceiptItemAmount.php +++ b/lib/Model/Receipt/ReceiptItemAmount.php @@ -36,7 +36,7 @@ use YooKassa\Model\CurrencyCode; /** * Class ReceiptItemAmount - * @package YooKassa\Model\Receipt + * @package YooKassa * * @method fromArray($sourceArray) */ @@ -54,7 +54,7 @@ class ReceiptItemAmount extends AbstractObject implements AmountInterface /** * MonetaryAmount constructor. - * @param string|null $value Сумма + * @param numeric|null $value Сумма * @param string|null $currency Код валюты */ public function __construct($value = null, $currency = null) diff --git a/lib/Model/ReceiptCustomerInterface.php b/lib/Model/ReceiptCustomerInterface.php index f33fd410..d49033d2 100644 --- a/lib/Model/ReceiptCustomerInterface.php +++ b/lib/Model/ReceiptCustomerInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface ReceiptCustomerInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $fullName Для юрлица — название организации, для ИП и физического лица — ФИО. * @property-read string $full_name Для юрлица — название организации, для ИП и физического лица — ФИО. diff --git a/lib/Model/ReceiptInterface.php b/lib/Model/ReceiptInterface.php index 0b37f67d..51f4bf28 100644 --- a/lib/Model/ReceiptInterface.php +++ b/lib/Model/ReceiptInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface ReceiptInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read ReceiptCustomerInterface $customer Информация о плательщике * @property-read ReceiptItemInterface[] $items Список товаров в заказе diff --git a/lib/Model/ReceiptItem.php b/lib/Model/ReceiptItem.php index 78ecdf38..03821335 100644 --- a/lib/Model/ReceiptItem.php +++ b/lib/Model/ReceiptItem.php @@ -111,7 +111,7 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface private $_excise; /** - * @var SupplierInterface Информация о поставщике товара или услуги + * @var Supplier Информация о поставщике товара или услуги */ private $_supplier; @@ -498,7 +498,7 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface /** * Возвращает информацию о поставщике товара или услуги. * - * @return SupplierInterface + * @return Supplier */ public function getSupplier() { @@ -532,7 +532,8 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface } /** - * @param string $value + * Устанавливает тип посредника, реализующего товар или услугу + * @param string $value Тип посредника */ public function setAgentType($value) { @@ -557,6 +558,11 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface $this->_agentType = $value; } + /** + * Возвращает тип посредника, реализующего товар или услугу + * + * @return string Тип посредника + */ public function getAgentType() { return $this->_agentType; @@ -564,7 +570,8 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface /** - * Проверяет, является ли текущий элемент чека доствкой + * Проверяет, является ли текущий элемент чека доставкой + * * @return bool True если доставка, false если обычный товар */ public function isShipping() @@ -630,6 +637,7 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface /** * Устанавливает значения свойств текущего объекта из массива + * * @param array|\Traversable $sourceArray Ассоциативный массив с настройками */ public function fromArray($sourceArray) @@ -643,6 +651,8 @@ class ReceiptItem extends AbstractObject implements ReceiptItemInterface } /** + * @inheritdoc + * * @return array */ public function jsonSerialize() diff --git a/lib/Model/ReceiptItemInterface.php b/lib/Model/ReceiptItemInterface.php index a39e770e..89127fb5 100644 --- a/lib/Model/ReceiptItemInterface.php +++ b/lib/Model/ReceiptItemInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface ReceiptItemInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $description Наименование товара * @property-read float $quantity Количество diff --git a/lib/Model/Refund.php b/lib/Model/Refund.php index 5cdec14b..ff8d0839 100644 --- a/lib/Model/Refund.php +++ b/lib/Model/Refund.php @@ -324,7 +324,7 @@ class Refund extends AbstractObject implements RefundInterface } /** - * @return SourceInterface[] + * @inheritdoc */ public function getSources() { @@ -359,7 +359,8 @@ class Refund extends AbstractObject implements RefundInterface } /** - * @return RequestorInterface + * Возвращает инициатора платежа или возврата + * @return RequestorInterface Инициатор платежа или возврата */ public function getRequestor() { @@ -367,7 +368,8 @@ class Refund extends AbstractObject implements RefundInterface } /** - * @param $value + * Устанавливает инициатора платежа или возврата + * @param RequestorInterface|array $value Инициатор платежа или возврата */ public function setRequestor($value) { diff --git a/lib/Model/RefundInterface.php b/lib/Model/RefundInterface.php index b810eb00..c2ca5f37 100644 --- a/lib/Model/RefundInterface.php +++ b/lib/Model/RefundInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface RefundInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $id Идентификатор возврата платежа * @property-read string $paymentId Идентификатор платежа diff --git a/lib/Model/Requestor.php b/lib/Model/Requestor.php index 303b529a..80d030cb 100644 --- a/lib/Model/Requestor.php +++ b/lib/Model/Requestor.php @@ -9,6 +9,22 @@ use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Helpers\TypeCast; +/** + * Инициатор платежа или возврата. + * + * Инициатором может быть магазин, подключенный к ЮKassa, `merchant` или приложение, которому владелец магазина + * [разрешил](https://yookassa.ru/developers/partners-api/basics) совершать операции от своего имени `third_party_client`. + * + * @package YooKassa + * + * @property string $type Тип инициатора + * @property string $accountId Идентификатор магазина + * @property string $account_id Идентификатор магазина + * @property string $clientId Идентификатор приложения + * @property string $client_id Идентификатор приложения + * @property string $clientName Название приложения (только для type = RequestorThirdPartyService) + * @property string $client_name Название приложения (только для type = RequestorThirdPartyService) + */ class Requestor extends AbstractObject implements RequestorInterface { /** @@ -41,7 +57,8 @@ class Requestor extends AbstractObject implements RequestorInterface } /** - * @param $value + * @inheritdoc + * @param string $value Тип инициатора */ public function setType($value) { @@ -59,6 +76,7 @@ class Requestor extends AbstractObject implements RequestorInterface } /** + * @inheritdoc * @return string */ public function getType() @@ -67,7 +85,8 @@ class Requestor extends AbstractObject implements RequestorInterface } /** - * @param $value + * @inheritdoc + * @param string $value Идентификатор магазина */ public function setAccountId($value) { @@ -83,6 +102,7 @@ class Requestor extends AbstractObject implements RequestorInterface } /** + * @inheritdoc * @return string|null */ public function getAccountId() @@ -91,7 +111,8 @@ class Requestor extends AbstractObject implements RequestorInterface } /** - * @param string $value + * @inheritdoc + * @param string $value Идентификатор приложения */ public function setClientId($value) { @@ -107,6 +128,7 @@ class Requestor extends AbstractObject implements RequestorInterface } /** + * @inheritdoc * @return string|null */ public function getClientId() @@ -115,7 +137,8 @@ class Requestor extends AbstractObject implements RequestorInterface } /** - * @param string $value + * @inheritdoc + * @param string $value Название приложения */ public function setClientName($value) { @@ -131,6 +154,7 @@ class Requestor extends AbstractObject implements RequestorInterface } /** + * @inheritdoc * @return string|null */ public function getClientName() diff --git a/lib/Model/RequestorInterface.php b/lib/Model/RequestorInterface.php index 1012be06..89d6e8c4 100644 --- a/lib/Model/RequestorInterface.php +++ b/lib/Model/RequestorInterface.php @@ -3,7 +3,16 @@ namespace YooKassa\Model; - +/** + * Interface RequestorInterface + * + * Инициатор платежа или возврата + * + * Инициатором может быть магазин, подключенный к ЮKassa, `merchant` или приложение, которому владелец магазина + * [разрешил](https://yookassa.ru/developers/partners-api/basics) совершать операции от своего имени `third_party_client`. + * + * @package YooKassa + */ interface RequestorInterface { /** @@ -13,18 +22,44 @@ interface RequestorInterface public function getType(); /** + * Устанавливает тип инициатора + * @param string $value Тип инициатора + */ + public function setType($value); + + /** + * Возвращает идентификатор магазина * @return string|null */ public function getAccountId(); + /** + * Устанавливает идентификатор магазина + * @param string $value Идентификатор магазина + */ + public function setAccountId($value); /** + * Возвращает идентификатор приложения * @return string|null */ public function getClientId(); /** + * Устанавливает идентификатор приложения + * @param string $value Идентификатор приложения + */ + public function setClientId($value); + + /** + * Возвращает название приложения * @return string|null */ public function getClientName(); + + /** + * Устанавливает название приложения + * @param string $value Название приложения + */ + public function setClientName($value); } \ No newline at end of file diff --git a/lib/Model/Settlement.php b/lib/Model/Settlement.php index 5b446ee7..6294bbf6 100644 --- a/lib/Model/Settlement.php +++ b/lib/Model/Settlement.php @@ -36,7 +36,7 @@ use YooKassa\Model\Receipt\SettlementType; /** * Class Settlement - * @package YooKassa\Model + * @package YooKassa * * @property string $type Вид оплаты в чеке * @property AmountInterface $amount Размер оплаты diff --git a/lib/Model/SettlementInterface.php b/lib/Model/SettlementInterface.php index 6b2fccf0..160ec38c 100644 --- a/lib/Model/SettlementInterface.php +++ b/lib/Model/SettlementInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Model; /** * Interface PostReceiptResponseSettlementInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $type Вид оплаты в чеке * @property-read AmountInterface $amount Размер оплаты diff --git a/lib/Model/Source.php b/lib/Model/Source.php index f02a47e9..9de8545b 100644 --- a/lib/Model/Source.php +++ b/lib/Model/Source.php @@ -33,6 +33,10 @@ use YooKassa\Helpers\TypeCast; /** * Класс объекта распределения денег в магазин + * + * @property AmountInterface $amount Сумма возврата + * @property AmountInterface $platform_fee_amount Комиссия, которую вы удержали при оплате, и хотите вернуть + * @property string $accountId Идентификатор магазина, для которого вы хотите провести возврат */ class Source extends AbstractObject implements SourceInterface { diff --git a/lib/Model/SourceInterface.php b/lib/Model/SourceInterface.php index f9e4874e..a2992228 100644 --- a/lib/Model/SourceInterface.php +++ b/lib/Model/SourceInterface.php @@ -29,11 +29,11 @@ namespace YooKassa\Model; /** * Interface TransferInterface * - * @package YooKassa\Model + * @property AmountInterface $amount Сумма возврата + * @property AmountInterface $platform_fee_amount Комиссия, которую вы удержали при оплате, и хотите вернуть + * @property string $accountId Идентификатор магазина, для которого вы хотите провести возврат * - * @property AmountInterface $amount - * @property AmountInterface $platform_fee_amount - * @property string $accountId + * @package YooKassa */ interface SourceInterface { diff --git a/lib/Model/Supplier.php b/lib/Model/Supplier.php index 055525c7..dddcfd52 100644 --- a/lib/Model/Supplier.php +++ b/lib/Model/Supplier.php @@ -35,17 +35,23 @@ use YooKassa\Helpers\TypeCast; /** * Информация о поставщике товара или услуги. * - * @package YooKassa\Model + * Можно передавать, если вы отправляете данные для формирования чека по сценарию - сначала платеж, потом чек. + * + * @property string $name Наименование поставщика + * @property string $phone Телефон пользователя. Указывается в формате ITU-T E.164 + * @property string $inn ИНН пользователя (10 или 12 цифр) + * + * @package YooKassa */ class Supplier extends AbstractObject implements SupplierInterface { - /** @var string Наименование поставщика. */ + /** @var string */ private $_name; - /** @var string Телефон пользователя. Указывается в формате ITU-T E.164 */ + /** @var string */ private $_phone; - /** @var string ИНН пользователя (10 или 12 цифр) */ + /** @var string */ private $_inn; /** diff --git a/lib/Model/SupplierInterface.php b/lib/Model/SupplierInterface.php index 96e2dccb..4951bc61 100644 --- a/lib/Model/SupplierInterface.php +++ b/lib/Model/SupplierInterface.php @@ -29,40 +29,51 @@ namespace YooKassa\Model; /** * Interface SupplierInterface * - * Информация о поставщике товара или услуги. Можно передавать, - * если вы отправляете данные для формирования чека по сценарию - сначала платеж, потом чек. + * Информация о поставщике товара или услуги. * - * @package YooKassa\Model + * Можно передавать, если вы отправляете данные для формирования чека по сценарию - сначала платеж, потом чек. + + * @property string $name Наименование поставщика + * @property string $phone Телефон пользователя. Указывается в формате ITU-T E.164 + * @property string $inn ИНН пользователя (10 или 12 цифр) + * + * @package YooKassa */ interface SupplierInterface { /** + * Возвращает наименование поставщика * @return string|null */ public function getName(); /** - * @param string|null $value + * Устанавливает наименование поставщика + * @param string|null $value Наименование поставщика */ public function setName($value); /** - * @return string|null + * Возвращает Телефон пользователя. Указывается в формате ITU-T E.164 + * @return string|null Телефон пользователя */ public function getPhone(); /** - * @param $value + * Устанавливает Телефон пользователя. Указывается в формате ITU-T E.164 + * @param string|null $value Телефон пользователя */ public function setPhone($value); /** - * @return string|null + * Возвращает ИНН пользователя (10 или 12 цифр) + * @return string|null ИНН пользователя */ public function getInn(); /** - * @param $value + * Устанавливает ИНН пользователя (10 или 12 цифр) + * @param $value ИНН пользователя */ public function setInn($value); } diff --git a/lib/Model/Transfer.php b/lib/Model/Transfer.php index a8c8f82d..06bd6026 100644 --- a/lib/Model/Transfer.php +++ b/lib/Model/Transfer.php @@ -34,6 +34,17 @@ use YooKassa\Helpers\TypeCast; /** * Класс объекта распределения денег в магазин + * + * Данные о распределении денег — сколько и в какой магазин нужно перевести. + * Присутствует, если вы используете решение ЮKassa для платформ. + * + * @property AmountInterface $amount Сумма, которую необходимо перечислить магазину + * @property AmountInterface $platform_fee_amount Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + * @property string $accountId Идентификатор магазина, в пользу которого вы принимаете оплату + * @property string $status Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` + * @property Metadata $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) + * + * @package YooKassa */ class Transfer extends AbstractObject implements TransferInterface { @@ -57,6 +68,11 @@ class Transfer extends AbstractObject implements TransferInterface */ private $_status; + /** + * @var string + */ + private $_metadata; + /** * Transfer constructor. * @param array $data @@ -203,6 +219,40 @@ class Transfer extends AbstractObject implements TransferInterface return $this->_status; } + /** + * @inheritDoc + */ + public function setMetadata($value) + { + if ($value === null || $value === '') { + $this->_metadata = null; + } elseif (is_array($value)) { + $this->_metadata = new Metadata($value); + } elseif ($value instanceof Metadata) { + $this->_metadata = $value; + } else { + throw new InvalidPropertyValueTypeException( + 'Invalid value type for "metadata" parameter in Transfer', 0, 'transfer.metadata', $value + ); + } + } + + /** + * @inheritDoc + */ + public function getMetadata() + { + return $this->_metadata; + } + + /** + * @inheritDoc + */ + public function hasMetadata() + { + return !empty($this->_metadata); + } + /** * Фабричный метод создания суммы * diff --git a/lib/Model/TransferInterface.php b/lib/Model/TransferInterface.php index 8c4dc6f0..07e81de3 100644 --- a/lib/Model/TransferInterface.php +++ b/lib/Model/TransferInterface.php @@ -29,28 +29,32 @@ namespace YooKassa\Model; /** * Interface TransferInterface * - * @package YooKassa\Model + * Данные о распределении денег — сколько и в какой магазин нужно перевести. + * Присутствует, если вы используете решение ЮKassa для платформ. * - * @property AmountInterface $amount - * @property AmountInterface $platform_fee_amount - * @property string $accountId - * @property string $status + * @property AmountInterface $amount Сумма, которую необходимо перечислить магазину + * @property AmountInterface $platform_fee_amount Комиссия за проданные товары и услуги, которая удерживается с магазина в вашу пользу + * @property string $accountId Идентификатор магазина, в пользу которого вы принимаете оплату + * @property string $status Статус распределения денег между магазинами. Возможные значения: `pending`, `waiting_for_capture`, `succeeded`, `canceled` + * @property Metadata $metadata Любые дополнительные данные, которые нужны вам для работы с платежами (например, номер заказа) + * + * @package YooKassa */ interface TransferInterface { /** - * Устаналивает id магазина-получателя средств + * Устанавливает идентификатор магазина-получателя средств * - * @param string $value + * @param string $value Идентификатор магазина-получателя средств * * @return void */ public function setAccountId($value); /** - * Возвращает id магазина-получателя средств + * Возвращает идентификатор магазина-получателя средств * - * @return string|null + * @return string|null Идентификатор магазина-получателя средств */ public function getAccountId(); @@ -95,7 +99,33 @@ interface TransferInterface public function setPlatformFeeAmount($value); /** - * @return string|null статус операции распределения средств конечному получателю + * Возвращает статус операции распределения средств конечному получателю + * @return string|null Статус операции распределения средств конечному получателю */ public function getStatus(); + + /** + * Устанавливает статус операции распределения средств конечному получателю + * @param string|null $value + */ + public function setStatus($value); + + /** + * Устанавливает метаданные + * @param Metadata|array $value Метаданные + */ + public function setMetadata($value); + + /** + * Возвращает метаданные + * @return Metadata|null Метаданные + */ + public function getMetadata(); + + /** + * Проверяет были ли установлены метаданные + * + * @return bool True если метаданные были установлены, false если нет + */ + public function hasMetadata(); } diff --git a/lib/Model/Webhook/Webhook.php b/lib/Model/Webhook/Webhook.php index f5e8ba51..770c47a3 100644 --- a/lib/Model/Webhook/Webhook.php +++ b/lib/Model/Webhook/Webhook.php @@ -31,44 +31,35 @@ use YooKassa\Common\AbstractObject; use YooKassa\Model\NotificationEventType; /** - * Class Webhook + * Класс Webhook содержит информацию о подписке на одно событие + * + * @property string $id Идентификатор webhook + * @property string $event Событие, о котором уведомляет ЮKassa + * @property string $url URL, на который ЮKassa будет отправлять уведомления + * + * @package YooKassa */ class Webhook extends AbstractObject { /** - * Идентификатор webhook * @var string */ private $id; /** - * Событие, о котором уведомляет ЮKassa - * @see NotificationEventType * @var string + * @see NotificationEventType */ private $event; /** - * URL, на который ЮKassa будет отправлять уведомления * @var string */ private $url; /** - * Webhook constructor. - * - * @param $initData - */ - public function __construct($initData = null) - { - if(!empty($initData)) { - $this->fromArray($initData); - } - } - - - /** - * @return mixed + * Возвращает идентификатор webhook + * @return string Идентификатор webhook */ public function getId() { @@ -76,7 +67,8 @@ class Webhook extends AbstractObject } /** - * @param mixed $id + * Устанавливает идентификатор webhook + * @param mixed $id Идентификатор webhook */ public function setId($id) { @@ -84,7 +76,8 @@ class Webhook extends AbstractObject } /** - * @return mixed + * Возвращает событие, о котором уведомляет ЮKassa + * @return string Событие, о котором уведомляет ЮKassa */ public function getEvent() { @@ -92,7 +85,8 @@ class Webhook extends AbstractObject } /** - * @param mixed $event + * Устанавливает событие, о котором уведомляет ЮKassa + * @param string $event Событие, о котором уведомляет ЮKassa */ public function setEvent($event) { @@ -100,7 +94,8 @@ class Webhook extends AbstractObject } /** - * @return mixed + * Возвращает URL, на который ЮKassa будет отправлять уведомления + * @return string URL, на который ЮKassa будет отправлять уведомления */ public function getUrl() { @@ -108,7 +103,8 @@ class Webhook extends AbstractObject } /** - * @param mixed $url + * Устанавливает URL, на который ЮKassa будет отправлять уведомления + * @param string $url URL, на который ЮKassa будет отправлять уведомления */ public function setUrl($url) { diff --git a/lib/Request/Payments/AbstractPaymentResponse.php b/lib/Request/Payments/AbstractPaymentResponse.php index 134f6d32..7a12726d 100644 --- a/lib/Request/Payments/AbstractPaymentResponse.php +++ b/lib/Request/Payments/AbstractPaymentResponse.php @@ -49,7 +49,7 @@ use YooKassa\Model\Transfer; /** * Абстрактный класс ответа от API, возвращающего информацию о платеже * - * @package YooKassa\Request\Payments + * @package YooKassa */ abstract class AbstractPaymentResponse extends Payment implements PaymentInterface { diff --git a/lib/Request/Payments/CreatePaymentRequest.php b/lib/Request/Payments/CreatePaymentRequest.php index 60f6dee9..703c04e3 100644 --- a/lib/Request/Payments/CreatePaymentRequest.php +++ b/lib/Request/Payments/CreatePaymentRequest.php @@ -42,7 +42,9 @@ use YooKassa\Model\RecipientInterface; /** * Класс объекта запроса к API на проведение нового платежа * - * @package YooKassa\Request\Payments + * @example 02-builder.php 11 78 Пример использования билдера + * + * @package YooKassa * * @property RecipientInterface $recipient Получатель платежа, если задан * @property AmountInterface $amount Сумма создаваемого платежа @@ -55,10 +57,8 @@ use YooKassa\Model\RecipientInterface; * @property AbstractPaymentData $paymentMethodData Данные используемые для создания метода оплаты * @property AbstractPaymentData $payment_method_data Данные используемые для создания метода оплаты * @property AbstractConfirmationAttributes $confirmation Способ подтверждения платежа - * @property bool $savePaymentMethod Сохранить платежные данные для последующего использования. Значение true - * инициирует создание многоразового payment_method. - * @property bool $save_payment_method Сохранить платежные данные для последующего использования. Значение true - * инициирует создание многоразового payment_method. + * @property bool $savePaymentMethod Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method. + * @property bool $save_payment_method Сохранить платежные данные для последующего использования. Значение true инициирует создание многоразового payment_method. * @property bool $capture Автоматически принять поступившую оплату * @property string $clientIp IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. * @property string $client_ip IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. @@ -480,24 +480,16 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme } /** - * @return AirlineInterface + * Возвращает данные авиабилетов + * @return AirlineInterface Данные авиабилетов */ public function getAirline() { return $this->_airline; } - /** - * @param AirlineInterface $value - */ - public function setAirline(AirlineInterface $value) - { - $this->_airline = $value; - } - - /** - * Проверяет были ли установлены данные длинной записи + * Проверяет были ли установлены данные авиабилетов * @return bool */ function hasAirline() @@ -505,6 +497,15 @@ class CreatePaymentRequest extends AbstractPaymentRequest implements CreatePayme return $this->_airline !== null; } + /** + * Устанавливает данные авиабилетов + * @param AirlineInterface $value Данные авиабилетов + */ + public function setAirline($value) + { + $this->_airline = $value; + } + /** * Возвращает данные оплаты установленные мерчантом * @return Metadata Метаданные, привязанные к платежу diff --git a/lib/Request/Payments/CreatePaymentRequestBuilder.php b/lib/Request/Payments/CreatePaymentRequestBuilder.php index 0b949043..a07bcda0 100644 --- a/lib/Request/Payments/CreatePaymentRequestBuilder.php +++ b/lib/Request/Payments/CreatePaymentRequestBuilder.php @@ -26,7 +26,9 @@ namespace YooKassa\Request\Payments; +use YooKassa\Common\AbstractPaymentRequest; use YooKassa\Common\AbstractPaymentRequestBuilder; +use YooKassa\Common\AbstractRequest; use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -44,12 +46,15 @@ use YooKassa\Model\RecipientInterface; /** * Класс билдера объектов запрсов к API на создание платежа * - * @package YooKassa\Request\Payments + * @example 02-builder.php 11 78 Пример использования билдера + * + * @package YooKassa */ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder { /** - * @var CreatePaymentRequest Собираемый объект запроса + * Собираемый объект запроса + * @var CreatePaymentRequest */ protected $currentObject; @@ -137,6 +142,7 @@ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder } /** + * Устанавливает информацию об авиабилетах * @param AirlineInterface|array $value объект данных длинной записи или ассоциативный массив с данными * * @return CreatePaymentRequestBuilder @@ -300,7 +306,7 @@ class CreatePaymentRequestBuilder extends AbstractPaymentRequestBuilder /** * Строит и возвращает объект запроса для отправки в API ЮKassa * @param array|null $options Массив параметров для установки в объект запроса - * @return CreatePaymentRequestInterface Инстанс объекта запроса + * @return CreatePaymentRequestInterface|AbstractPaymentRequest|AbstractRequest Инстанс объекта запроса * * @throws InvalidRequestException Выбрасывается если собрать объект запроса не удалось */ diff --git a/lib/Request/Payments/CreatePaymentRequestInterface.php b/lib/Request/Payments/CreatePaymentRequestInterface.php index e4834903..17e3f066 100644 --- a/lib/Request/Payments/CreatePaymentRequestInterface.php +++ b/lib/Request/Payments/CreatePaymentRequestInterface.php @@ -27,6 +27,7 @@ namespace YooKassa\Request\Payments; use YooKassa\Model\Airline; +use YooKassa\Model\AirlineInterface; use YooKassa\Model\AmountInterface; use YooKassa\Model\ConfirmationAttributes\AbstractConfirmationAttributes; use YooKassa\Model\Metadata; @@ -38,7 +39,7 @@ use YooKassa\Model\TransferInterface; /** * Interface CreatePaymentRequestInterface * - * @package YooKassa\Request\Payments + * @package YooKassa * * @property-read RecipientInterface|null $recipient Получатель платежа, если задан * @property-read AmountInterface $amount Сумма создаваемого платежа @@ -53,11 +54,10 @@ use YooKassa\Model\TransferInterface; * @property-read bool $savePaymentMethod Сохранить платежные данные для последующего использования * @property-read bool $save_payment_method Сохранить платежные данные для последующего использования * @property-read bool $capture Автоматически принять поступившую оплату - * @property-read string $clientIp IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес - * TCP-подключения. - * @property-read string $client_ip IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес - * TCP-подключения. + * @property-read string $clientIp IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. + * @property-read string $client_ip IPv4 или IPv6-адрес покупателя. Если не указан, используется IP-адрес TCP-подключения. * @property-read Metadata $metadata Метаданные привязанные к платежу + * @property-read TransferInterface[] $transfers Метаданные привязанные к платежу */ interface CreatePaymentRequestInterface { @@ -73,6 +73,12 @@ interface CreatePaymentRequestInterface */ function hasRecipient(); + /** + * Устанавливает объект с информацией о получателе платежа + * @param RecipientInterface|null $value Инстанс объекта информации о получателе платежа или null + */ + public function setRecipient($value); + /** * Возвращает сумму заказа * @return AmountInterface Сумма заказа @@ -91,6 +97,12 @@ interface CreatePaymentRequestInterface */ function hasDescription(); + /** + * Устанавливает описание транзакции + * @param string $value Описание транзакции + */ + public function setDescription($value); + /** * Возвращает чек, если он есть * @return ReceiptInterface|null Данные фискального чека 54-ФЗ или null если чека нет @@ -115,6 +127,12 @@ interface CreatePaymentRequestInterface */ function hasPaymentToken(); + /** + * Устанавливает одноразовый токен для проведения оплаты, сформированный YooKassa JS widget + * @param string $value Одноразовый токен для проведения оплаты + */ + public function setPaymentToken($value); + /** * Устанавливает идентификатор закиси платёжных данных покупателя * @return string Идентификатор записи о сохраненных платежных данных покупателя @@ -127,6 +145,12 @@ interface CreatePaymentRequestInterface */ function hasPaymentMethodId(); + /** + * Устанавливает идентификатор записи о сохранённых данных покупателя + * @param string $value Идентификатор записи о сохраненных платежных данных покупателя + */ + public function setPaymentMethodId($value); + /** * Возвращает данные для создания метода оплаты * @return AbstractPaymentData Данные используемые для создания метода оплаты @@ -139,6 +163,12 @@ interface CreatePaymentRequestInterface */ function hasPaymentMethodData(); + /** + * Устанавливает объект с информацией для создания метода оплаты + * @param AbstractPaymentData|null $value Объект с создания метода оплаты или null + */ + public function setPaymentMethodData($value); + /** * Возвращает способ подтверждения платежа * @return AbstractConfirmationAttributes Способ подтверждения платежа @@ -151,6 +181,12 @@ interface CreatePaymentRequestInterface */ function hasConfirmation(); + /** + * Устанавливает способ подтверждения платежа + * @param AbstractConfirmationAttributes|null $value Способ подтверждения платежа + */ + public function setConfirmation($value); + /** * Возвращает флаг сохранения платёжных данных * @return bool Флаг сохранения платёжных данных @@ -163,6 +199,12 @@ interface CreatePaymentRequestInterface */ function hasSavePaymentMethod(); + /** + * Устанавливает флаг сохранения платёжных данных. Значение true инициирует создание многоразового payment_method. + * @param bool $value Сохранить платежные данные для последующего использования + */ + public function setSavePaymentMethod($value); + /** * Возвращает флаг автоматического принятия поступившей оплаты * @return bool True если требуется автоматически принять поступившую оплату, false если нет @@ -175,6 +217,12 @@ interface CreatePaymentRequestInterface */ function hasCapture(); + /** + * Устанавливает флаг автоматического принятия поступившей оплаты + * @param bool $value Автоматически принять поступившую оплату + */ + public function setCapture($value); + /** * Возвращает IPv4 или IPv6-адрес покупателя * @return string IPv4 или IPv6-адрес покупателя @@ -187,6 +235,12 @@ interface CreatePaymentRequestInterface */ function hasClientIp(); + /** + * Устанавливает IP адрес покупателя + * @param string $value IPv4 или IPv6-адрес покупателя + */ + public function setClientIp($value); + /** * Возвращает данные оплаты установленные мерчантом * @return Metadata Метаданные привязанные к платежу @@ -200,10 +254,10 @@ interface CreatePaymentRequestInterface function hasMetadata(); /** - * Проверяет были ли установлены данные длинной записи - * @return bool + * Устанавливает метаданные, привязанные к платежу + * @param Metadata|array|null $value Метаданные платежа, устанавливаемые мерчантом */ - function hasAirline(); + public function setMetadata($value); /** * Возвращает данные длинной записи @@ -212,12 +266,38 @@ interface CreatePaymentRequestInterface function getAirline(); /** + * Проверяет были ли установлены данные длинной записи + * @return bool + */ + function hasAirline(); + + /** + * Устанавливает данные авиабилетов + * @param AirlineInterface $value Данные авиабилетов + */ + public function setAirline($value); + + /** + * Проверяет наличие данных о распределении денег * @return bool */ function hasTransfers(); /** - * @return TransferInterface[] + * Возвращает данные о распределении денег — сколько и в какой магазин нужно перевести. + * Присутствует, если вы используете решение ЮKassa для платформ. + * (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + * + * @return TransferInterface[] Данные о распределении денег */ function getTransfers(); + + /** + * Устанавливает данные о распределении денег — сколько и в какой магазин нужно перевести. + * Присутствует, если вы используете решение ЮKassa для платформ. + * (https://yookassa.ru/developers/special-solutions/checkout-for-platforms/basics) + * + * @param TransferInterface[]|array|null Данные о распределении денег + */ + function setTransfers($value); } diff --git a/lib/Request/Payments/CreatePaymentRequestSerializer.php b/lib/Request/Payments/CreatePaymentRequestSerializer.php index ddb495e3..e45a822f 100644 --- a/lib/Request/Payments/CreatePaymentRequestSerializer.php +++ b/lib/Request/Payments/CreatePaymentRequestSerializer.php @@ -47,7 +47,7 @@ use YooKassa\Model\TransferInterface; /** * Класс сериалайзера объекта запроса к API на проведение платежа * - * @package YooKassa\Request\Payments + * @package YooKassa */ class CreatePaymentRequestSerializer { @@ -75,6 +75,12 @@ class CreatePaymentRequestSerializer PaymentMethodType::WECHAT => 'serializePaymentData', ); + /** + * Формирует ассоциативный массив данных из объекта запроса + * + * @param CreatePaymentRequestInterface $request Объект запроса + * @return array Массив данных для дальнейшего кодирования в JSON + */ public function serialize(CreatePaymentRequestInterface $request) { $result = array(); diff --git a/lib/Request/Payments/CreatePaymentResponse.php b/lib/Request/Payments/CreatePaymentResponse.php index 12046035..d67a184f 100644 --- a/lib/Request/Payments/CreatePaymentResponse.php +++ b/lib/Request/Payments/CreatePaymentResponse.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Payments; /** * Класс объекта ответа возвращаемого API при запросе на создание платежа * - * @package YooKassa\Request\Payments + * @package YooKassa */ class CreatePaymentResponse extends AbstractPaymentResponse {} diff --git a/lib/Request/Payments/Payment/CancelResponse.php b/lib/Request/Payments/Payment/CancelResponse.php index 555d83d5..11b59b56 100644 --- a/lib/Request/Payments/Payment/CancelResponse.php +++ b/lib/Request/Payments/Payment/CancelResponse.php @@ -31,7 +31,7 @@ use YooKassa\Request\Payments\AbstractPaymentResponse; /** * Класс объекта ответа от API на запрос отмены платежа * - * @package YooKassa\Request\Payments\Payment + * @package YooKassa */ class CancelResponse extends AbstractPaymentResponse {} diff --git a/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php b/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php index 1c4303fd..be6cb07b 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequestBuilder.php @@ -27,12 +27,14 @@ namespace YooKassa\Request\Payments\Payment; use YooKassa\Common\AbstractPaymentRequestBuilder; +use YooKassa\Common\AbstractRequest; use YooKassa\Common\Exceptions\InvalidPropertyException; use YooKassa\Common\Exceptions\InvalidRequestException; class CreateCaptureRequestBuilder extends AbstractPaymentRequestBuilder { /** + * Собираемый объект запроса * @var CreateCaptureRequest */ protected $currentObject; @@ -50,7 +52,7 @@ class CreateCaptureRequestBuilder extends AbstractPaymentRequestBuilder /** * Осуществляет сборку объекта запроса к API * @param array|null $options Массив дополнительных настроек объекта - * @return CreateCaptureRequestInterface Иснатс объекта запроса к API + * @return CreateCaptureRequestInterface|AbstractRequest Иснатс объекта запроса к API * * @throws InvalidRequestException Выбрасывается если при валидации запроса произошла ошибка * @throws InvalidPropertyException Выбрасывается если не удалось установить один из параметров, переданных в diff --git a/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php b/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php index a5d1f11b..a2829496 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequestInterface.php @@ -26,6 +26,7 @@ namespace YooKassa\Request\Payments\Payment; +use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Model\AmountInterface; use YooKassa\Model\MonetaryAmount; use YooKassa\Model\ReceiptInterface; @@ -34,7 +35,7 @@ use YooKassa\Model\TransferInterface; /** * Interface CreateCaptureRequestInterface * - * @package YooKassa\Request\Payments\Payment + * @package YooKassa * * @property-read MonetaryAmount $amount Подтверждаемая сумма оплаты * @property-read ReceiptInterface $receipt Данные фискального чека 54-ФЗ @@ -42,7 +43,7 @@ use YooKassa\Model\TransferInterface; interface CreateCaptureRequestInterface { /** - * Возвращает подтвердаемую сумму оплаты + * Возвращает подтверждаемую сумму оплаты * @return AmountInterface Подтверждаемая сумма оплаты */ function getAmount(); @@ -53,6 +54,12 @@ interface CreateCaptureRequestInterface */ function hasAmount(); + /** + * Устанавливает сумму оплаты + * @param AmountInterface $value Сумма оплаты + */ + function setAmount(AmountInterface $value); + /** * Возвращает чек, если он есть * @return ReceiptInterface|null Данные фискального чека 54-ФЗ или null если чека нет @@ -68,12 +75,27 @@ interface CreateCaptureRequestInterface function hasReceipt(); /** + * Устанавливает чек + * @param ReceiptInterface|null $value Инстанс чека или null для удаления информации о чеке + * @throws InvalidPropertyValueTypeException Выбрасывается если передан не инстанс класса чека и не null + */ + function setReceipt($value); + + /** + * Проверяет наличие данных о распределении денег * @return bool */ function hasTransfers(); /** + * Возвращает данные о распределении денег * @return TransferInterface[] */ function getTransfers(); + + /** + * Устанавливает transfers (массив распределения денег между магазинами) + * @param TransferInterface[]|array|null $value + */ + function setTransfers($value); } diff --git a/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php b/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php index baf6cf3a..cc7f5deb 100644 --- a/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php +++ b/lib/Request/Payments/Payment/CreateCaptureRequestSerializer.php @@ -33,7 +33,7 @@ use YooKassa\Model\TransferInterface; /** * Класс объекта осуществляющего сериализацию запроса к API на подтверждение заказа * - * @package YooKassa\Request\Payments\Payment + * @package YooKassa */ class CreateCaptureRequestSerializer { diff --git a/lib/Request/Payments/Payment/CreateCaptureResponse.php b/lib/Request/Payments/Payment/CreateCaptureResponse.php index 7e4c49a2..f5c49a67 100644 --- a/lib/Request/Payments/Payment/CreateCaptureResponse.php +++ b/lib/Request/Payments/Payment/CreateCaptureResponse.php @@ -31,7 +31,7 @@ use YooKassa\Request\Payments\AbstractPaymentResponse; /** * Класс объекта ответа от API на запрос подтверждения платежа * - * @package YooKassa\Request\Payments\Payment + * @package YooKassa */ class CreateCaptureResponse extends AbstractPaymentResponse {} \ No newline at end of file diff --git a/lib/Request/Payments/PaymentResponse.php b/lib/Request/Payments/PaymentResponse.php index 37011828..f5549be6 100644 --- a/lib/Request/Payments/PaymentResponse.php +++ b/lib/Request/Payments/PaymentResponse.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Payments; /** * Класс объекта ответа, возвращаемого API при запросе конкретного платежа * - * @package YooKassa\Request\Payments + * @package YooKassa */ class PaymentResponse extends AbstractPaymentResponse {} \ No newline at end of file diff --git a/lib/Request/Payments/PaymentsRequest.php b/lib/Request/Payments/PaymentsRequest.php index 944d1421..80cc13c5 100644 --- a/lib/Request/Payments/PaymentsRequest.php +++ b/lib/Request/Payments/PaymentsRequest.php @@ -52,6 +52,7 @@ use YooKassa\Model\PaymentStatus; */ class PaymentsRequest extends AbstractRequest implements PaymentsRequestInterface { + /** Максимальное количество объектов платежа в выборке */ const MAX_LIMIT_VALUE = 100; /** diff --git a/lib/Request/Payments/PaymentsRequestBuilder.php b/lib/Request/Payments/PaymentsRequestBuilder.php index 1dbe4064..495e920f 100644 --- a/lib/Request/Payments/PaymentsRequestBuilder.php +++ b/lib/Request/Payments/PaymentsRequestBuilder.php @@ -34,9 +34,9 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; /** - * Билдер объектов запросов к API для пролучения списка платежей магазина + * Класс билдера запросов к API для получения списка платежей магазина * - * @package YooKassa\Request\Payments + * @package YooKassa */ class PaymentsRequestBuilder extends AbstractRequestBuilder { diff --git a/lib/Request/Payments/PaymentsRequestInterface.php b/lib/Request/Payments/PaymentsRequestInterface.php index f1a918c0..7ffd3250 100644 --- a/lib/Request/Payments/PaymentsRequestInterface.php +++ b/lib/Request/Payments/PaymentsRequestInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Payments; /** * Interface PaymentsRequestInterface * - * @package YooKassa\Request\Payments + * @package YooKassa * * @property-read string|null $cursor Страница выдачи результатов, которую необходимо отобразить * @property-read \DateTime|null $createdAtGte Время создания, от (включительно) diff --git a/lib/Request/Payments/PaymentsRequestSerializer.php b/lib/Request/Payments/PaymentsRequestSerializer.php index 04882b01..ce2e2a7e 100644 --- a/lib/Request/Payments/PaymentsRequestSerializer.php +++ b/lib/Request/Payments/PaymentsRequestSerializer.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Payments; /** * Класс сериализатора объектов запросов к API для получения списка платежей * - * @package YooKassa\Request\Payments + * @package YooKassa */ class PaymentsRequestSerializer { diff --git a/lib/Request/Payments/PaymentsResponse.php b/lib/Request/Payments/PaymentsResponse.php index cb0d300b..fe4c6c71 100644 --- a/lib/Request/Payments/PaymentsResponse.php +++ b/lib/Request/Payments/PaymentsResponse.php @@ -33,7 +33,7 @@ use YooKassa\Model\PaymentInterface; /** * Класс объекта ответа от API со списком платежей магазина * - * @package YooKassa\Request\Payments + * @package YooKassa */ class PaymentsResponse extends AbstractObject { diff --git a/lib/Request/Receipts/AbstractReceiptResponse.php b/lib/Request/Receipts/AbstractReceiptResponse.php index c9b4b577..f8d3ab3f 100644 --- a/lib/Request/Receipts/AbstractReceiptResponse.php +++ b/lib/Request/Receipts/AbstractReceiptResponse.php @@ -40,12 +40,14 @@ use YooKassa\Model\SettlementInterface; /** * Class AbstractReceipt * - * @package YooKassa\Model + * @package YooKassa * * @property string $id Идентификатор чека в ЮKassa. * @property string $type Тип чека в онлайн-кассе: приход "payment" или возврат "refund". * @property string $status Статус доставки данных для чека в онлайн-кассу ("pending", "succeeded" или "canceled"). * @property string $fiscalAttribute Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. + * @property string $objectId Идентификатор объекта чека. + * @property string $object_id Идентификатор объекта чека. * @property string $fiscal_attribute Фискальный признак чека. Формируется фискальным накопителем на основе данных, переданных для регистрации чека. * @property string $fiscalDocumentNumber Номер фискального документа. * @property string $fiscal_document_number Номер фискального документа. @@ -60,9 +62,11 @@ use YooKassa\Model\SettlementInterface; * @property ReceiptResponseItemInterface[] $items Список товаров в заказе * @property SettlementInterface[] $settlements Перечень совершенных расчетов. * @property string $onBehalfOf Идентификатор магазина + * @property string $on_behalf_of Идентификатор магазина */ abstract class AbstractReceiptResponse extends AbstractObject implements ReceiptResponseInterface { + /** Длина идентификатора чека */ const LENGTH_RECEIPT_ID = 39; /** @var string Идентификатор чека в ЮKassa. */ @@ -80,7 +84,7 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt /** @var string Номер фискального накопителя в кассовом аппарате. */ private $_fiscalStorageNumber; - /** @var string идентификатор объекта чека */ + /** @var string Идентификатор объекта чека */ private $_object_id; /** @@ -173,6 +177,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** + * @inheritdoc + * * @return string */ public function getId() @@ -200,6 +206,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** + * @inheritdoc + * * @return string */ public function getType() @@ -270,6 +278,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** + * @inheritdoc + * * @return string */ public function getStatus() @@ -307,7 +317,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @return string + * Возвращает номер фискального документа + * @return string Номер фискального документа */ public function getFiscalDocumentNumber() { @@ -334,7 +345,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @return string + * Возвращает номер фискального накопителя в кассовом аппарате + * @return string Номер фискального накопителя в кассовом аппарате */ public function getFiscalStorageNumber() { @@ -342,7 +354,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @param string $fiscal_storage_number + * Устанавливает номер фискального накопителя в кассовом аппарате + * @param string $fiscal_storage_number Номер фискального накопителя в кассовом аппарате */ public function setFiscalStorageNumber($fiscal_storage_number) { @@ -350,7 +363,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @return string + * Возвращает фискальный признак чека + * @return string Фискальный признак чека */ public function getFiscalAttribute() { @@ -358,7 +372,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @param string $fiscal_attribute + * Устанавливает фискальный признак чека + * @param string $fiscal_attribute Фискальный признак чека */ public function setFiscalAttribute($fiscal_attribute) { @@ -366,7 +381,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @return DateTime + * Возвращает дату и время формирования чека в фискальном накопителе + * @return DateTime Дата и время формирования чека в фискальном накопителе */ public function getRegisteredAt() { @@ -374,7 +390,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @param DateTime $registered_at + * Устанавливает дату и время формирования чека в фискальном накопителе + * @param DateTime $registered_at Дата и время формирования чека в фискальном накопителе */ public function setRegisteredAt($registered_at) { @@ -382,7 +399,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @return string + * Возвращает идентификатор чека в онлайн-кассе + * @return string Идентификатор чека в онлайн-кассе */ public function getFiscalProviderId() { @@ -390,7 +408,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @param string $fiscal_provider_id + * Устанавливает идентификатор чека в онлайн-кассе + * @param string $fiscal_provider_id Идентификатор чека в онлайн-кассе */ public function setFiscalProviderId($fiscal_provider_id) { @@ -398,7 +417,9 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @return ReceiptResponseItem[] + * @inheritdoc + * + * @return ReceiptResponseItem[]|ReceiptResponseItemInterface[] */ public function getItems() { @@ -461,6 +482,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** + * Устанавливает массив оплат, обеспечивающих выдачу товара + * * @param SettlementInterface[] $value */ public function setSettlements($value) @@ -486,6 +509,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** + * Добавляет оплату в массив + * * @param SettlementInterface $value */ public function addSettlement(SettlementInterface $value) @@ -495,6 +520,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt /** + * @inheritdoc + * * @return int */ public function getTaxSystemCode() @@ -530,6 +557,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** + * @inheritdoc + * * @return string|null */ public function getOnBehalfOf() @@ -538,7 +567,8 @@ abstract class AbstractReceiptResponse extends AbstractObject implements Receipt } /** - * @param string $value + * Возвращает идентификатор магазина, от имени которого нужно отправить чек + * @param string $value Идентификатор магазина, от имени которого нужно отправить чек */ public function setOnBehalfOf($value) { diff --git a/lib/Request/Receipts/CreatePostReceiptRequest.php b/lib/Request/Receipts/CreatePostReceiptRequest.php index 1317bfa4..311529c1 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequest.php +++ b/lib/Request/Receipts/CreatePostReceiptRequest.php @@ -41,8 +41,11 @@ use YooKassa\Model\Settlement; use YooKassa\Model\SettlementInterface; /** - * Class AbstractPostReceiptRequest - * @package YooKassa\Request\Receipts + * Класс объекта запроса к API на создание чека + * + * @example 02-builder.php 91 56 Пример использования билдера + * + * @package YooKassa */ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostReceiptRequestInterface { @@ -92,7 +95,7 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece /** * Устанавливает Id объекта чека * - * @param string $value + * @param string $value Id объекта чека */ public function setObjectId($value) { @@ -100,6 +103,8 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } /** + * Проверяет наличие данных о плательщике + * * @return bool */ public function hasCustomer() @@ -152,8 +157,9 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece * позиций. Все передаваемые значения в массиве позиций должны быть объектами класса, реализующего интерфейс * ReceiptItemInterface, в противном случае будет выброшено исключение InvalidPropertyValueTypeException. * - * @param ReceiptItemInterface[] $value Список товаров в заказе + * @param ReceiptItemInterface[]|array $value Список товаров в заказе * + * @return CreatePostReceiptRequest * @throws EmptyPropertyValueException Выбрасывается если передали пустой массив значений * @throws InvalidPropertyValueTypeException Выбрасывается если в качестве значения был передан не массив и не * итератор, либо если одно из переданных значений не реализует интерфейс ReceiptItemInterface @@ -169,27 +175,32 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece ); } $this->_items = array(); - foreach ($value as $key => $val) { - if (is_array($val)) { - $this->addItem(new ReceiptItem($val)); - } elseif (is_object($val) && $val instanceof ReceiptItemInterface) { - $this->addItem($val); + foreach ($value as $key => $item) { + if (is_array($item)) { + $this->addItem(new ReceiptItem($item)); + } elseif (is_object($item) && $item instanceof ReceiptItemInterface) { + $this->addItem($item); } else { throw new InvalidPropertyValueTypeException( - 'Invalid item value type in receipt', 0, 'Receipt.items['.$key.']', $val + 'Invalid item value type in receipt', 0, 'Receipt.items['.$key.']', $item ); } } + + return $this; } /** * Добавляет товар в чек * - * @param ReceiptItemInterface $value Объект добавляемой в чек позиции + * @param ReceiptItemInterface|array $value Объект добавляемой в чек позиции + * @return CreatePostReceiptRequest */ public function addItem($value) { $this->_items[] = $value; + + return $this; } /** @@ -333,6 +344,10 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } /** + * Возвращает идентификатор магазина, от имени которого нужно отправить чек. + * Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). + * Необходимо передавать, если вы используете решение ЮKassa для платформ. + * * @return string */ public function getOnBehalfOf() @@ -341,6 +356,10 @@ class CreatePostReceiptRequest extends AbstractRequest implements CreatePostRece } /** + * Устанавливает идентификатор магазина, от имени которого нужно отправить чек. + * Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). + * Необходимо передавать, если вы используете решение ЮKassa для платформ. + * * @param string $value */ public function setOnBehalfOf($value) diff --git a/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php b/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php index 424e4c7e..059dcf99 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php +++ b/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php @@ -27,6 +27,7 @@ namespace YooKassa\Request\Receipts; +use YooKassa\Common\AbstractRequest; use YooKassa\Common\AbstractRequestBuilder; use YooKassa\Common\Exceptions\InvalidRequestException; use YooKassa\Model\AmountInterface; @@ -36,15 +37,31 @@ use YooKassa\Model\ReceiptCustomerInterface; use YooKassa\Model\ReceiptItemInterface; use YooKassa\Model\SettlementInterface; +/** + * Класс билдера объектов запрсов к API на создание чека + * + * @example 02-builder.php 91 56 Пример использования билдера + * + * @package YooKassa + */ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder { - /** @var CreatePostReceiptRequest Собираемый объект запроса */ + /** + * Собираемый объект запроса + * @var CreatePostReceiptRequest + */ protected $currentObject; - /** @var AmountInterface */ + /** + * Сумма чека + * @var AmountInterface + */ protected $amount; - /** @var ReceiptCustomer */ + /** + * Информация о плательщике + * @var ReceiptCustomer + */ protected $customer; /** @@ -98,8 +115,10 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param ReceiptCustomerInterface|array $value - * @return CreatePostReceiptRequestBuilder + * Устанавливает информацию о пользователе + * + * @param ReceiptCustomerInterface|array $value информация о плательщике + * @return self Инстанс билдера запросов */ public function setCustomer($value) { @@ -115,7 +134,9 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param ReceiptItemInterface[] $value + * Устанавливает список товаров чека + * + * @param ReceiptItemInterface[]|array $value список товаров чека * @return CreatePostReceiptRequestBuilder */ public function setItems($value) @@ -125,7 +146,21 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param int $value + * Добавляет товар в чек + * + * @param ReceiptItemInterface|array $value Информация о товаре + * @return CreatePostReceiptRequestBuilder + */ + public function addItem($value) + { + $this->currentObject->addItem($value); + return $this; + } + + /** + * Устанавливает код системы налогообложения + * + * @param int $value Код системы налогообложения. Число 1-6. * @return CreatePostReceiptRequestBuilder */ public function setTaxSystemCode($value) @@ -135,7 +170,9 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param string $value + * Устанавливает тип чека в онлайн-кассе + * + * @param string $value Тип чека в онлайн-кассе: приход "payment" или возврат "refund". * @return CreatePostReceiptRequestBuilder */ public function setType($value) @@ -145,7 +182,9 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param bool $value + * Устанавливает признак отложенной отправки чека. + * + * @param bool $value Признак отложенной отправки чека. * @return CreatePostReceiptRequestBuilder */ public function setSend($value) @@ -155,7 +194,11 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param string $value + * Устанавливает идентификатор магазина, от имени которого нужно отправить чек. + * Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). + * Необходимо передавать, если вы используете решение ЮKassa для платформ. + * + * @param string $value Идентификатор магазина, от имени которого нужно отправить чек * @return CreatePostReceiptRequestBuilder */ public function setOnBehalfOf($value) @@ -165,7 +208,9 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param SettlementInterface[] $value + * Устанавливает массив оплат, обеспечивающих выдачу товара. + * + * @param SettlementInterface[]|array $value Массив оплат, обеспечивающих выдачу товара * @return CreatePostReceiptRequestBuilder */ public function setSettlements($value) @@ -175,7 +220,9 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder } /** - * @param string $value + * Устанавливает Id объекта чека + * + * @param string $value Id объекта чека * @return CreatePostReceiptRequestBuilder */ public function setObjectId($value) @@ -186,8 +233,9 @@ class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder /** * Строит и возвращает объект запроса для отправки в API ЮKassa + * * @param array|null $options Массив параметров для установки в объект запроса - * @return CreatePostReceiptRequest Инстанс объекта запроса + * @return CreatePostReceiptRequest|AbstractRequest Инстанс объекта запроса * * @throws InvalidRequestException Выбрасывается если собрать объект запроса не удалось */ diff --git a/lib/Request/Receipts/CreatePostReceiptRequestInterface.php b/lib/Request/Receipts/CreatePostReceiptRequestInterface.php index a8980a5d..1178a75a 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequestInterface.php +++ b/lib/Request/Receipts/CreatePostReceiptRequestInterface.php @@ -35,32 +35,32 @@ use YooKassa\Model\SupplierInterface; /** * Interface CreateReceiptRequestInterface * - * @package YooKassa\Request\Receipts + * @package YooKassa * - * @property string $objectId Идентификатор объекта ("payment" или "refund), для которого формируется чек. - * @property string $object_id Идентификатор объекта ("payment" или "refund), для которого формируется чек. - * @property string $type Тип чека в онлайн-кассе: приход "payment" или возврат "refund". - * @property bool $send Признак отложенной отправки чека. - * @property ReceiptCustomer $customer Информация о плательщике. - * @property int $taxSystemCode Код системы налогообложения. Число 1-6. - * @property int $tax_system_code Код системы налогообложения. Число 1-6. - * @property ReceiptItemInterface[] $items Список товаров в заказе. - * @property SupplierInterface $supplier Информация о поставщике товара или услуги. - * @property SettlementInterface[] $settlements Массив оплат, обеспечивающих выдачу товара. + * @property string $objectId Идентификатор объекта ("payment" или "refund), для которого формируется чек + * @property string $object_id Идентификатор объекта ("payment" или "refund), для которого формируется чек + * @property string $type Тип чека в онлайн-кассе: приход "payment" или возврат "refund" + * @property bool $send Признак отложенной отправки чека + * @property ReceiptCustomer $customer Информация о плательщике + * @property int $taxSystemCode Код системы налогообложения. Число 1-6 + * @property int $tax_system_code Код системы налогообложения. Число 1-6 + * @property ReceiptItemInterface[] $items Список товаров в заказе + * @property SupplierInterface $supplier Информация о поставщике товара или услуги + * @property SettlementInterface[] $settlements Массив оплат, обеспечивающих выдачу товара */ interface CreatePostReceiptRequestInterface { /** * Возвращает идентификатор объекта, для которого формируется чек * - * @return string Идентификатор объекта. + * @return string Идентификатор объекта */ public function getObjectId(); /** * Устанавливает идентификатор объекта, для которого формируется чек * - * @param string $value Идентификатор объекта. + * @param string $value Идентификатор объекта * @return CreatePostReceiptRequestInterface */ public function setObjectId($value); @@ -68,41 +68,44 @@ interface CreatePostReceiptRequestInterface /** * Возвращает тип чека в онлайн-кассе * - * @return string Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + * @return string Тип чека в онлайн-кассе: приход "payment" или возврат "refund" */ public function getType(); /** * Устанавливает тип чека в онлайн-кассе - * @param string $value Тип чека в онлайн-кассе: приход "payment" или возврат "refund". + * + * @param string $value Тип чека в онлайн-кассе: приход "payment" или возврат "refund" * @return CreatePostReceiptRequestInterface */ public function setType($value); /** - * Возвращает признак отложенной отправки чека. + * Возвращает признак отложенной отправки чека * - * @return bool Признак отложенной отправки чека. + * @return bool Признак отложенной отправки чека */ public function getSend(); /** - * Устанавливает признак отложенной отправки чека. + * Устанавливает признак отложенной отправки чека * - * @param bool $value Признак отложенной отправки чека. + * @param bool $value Признак отложенной отправки чека * @return CreatePostReceiptRequestInterface */ public function setSend($value); /** - * Возвращает код системы налогообложения. + * Возвращает код системы налогообложения * - * @return int Код системы налогообложения. Число 1-6. + * @return int Код системы налогообложения. Число 1-6 */ public function getTaxSystemCode(); /** - * @param int $value + * Устанавливает код системы налогообложения + * + * @param int $value Код системы налогообложения. Число 1-6 * @return CreatePostReceiptRequestInterface */ public function setTaxSystemCode($value); @@ -110,14 +113,14 @@ interface CreatePostReceiptRequestInterface /** * Возвращает информацию о плательщике. * - * @return ReceiptCustomerInterface Информация о плательщике. + * @return ReceiptCustomerInterface Информация о плательщике */ public function getCustomer(); /** - * Устанавливает информацию о пользователе. + * Устанавливает информацию о пользователе * - * @param ReceiptCustomerInterface $value информация о плательщике. + * @param ReceiptCustomerInterface $value информация о плательщике * @return CreatePostReceiptRequestInterface */ public function setCustomer($value); @@ -130,37 +133,54 @@ interface CreatePostReceiptRequestInterface public function getItems(); /** - * @param ReceiptItemInterface[] $items + * Устанавливает список товаров чека + * + * @param ReceiptItemInterface[]|array $value список товаров чека * @return CreatePostReceiptRequestInterface */ - public function setItems($items); + public function setItems($value); /** - * Возвращает Массив оплат, обеспечивающих выдачу товара. + * Добавляет товар в чек + * + * @param ReceiptItemInterface|array $value Информация о товаре + * @return CreatePostReceiptRequestInterface + */ + public function addItem($value); + + /** + * Возвращает Массив оплат, обеспечивающих выдачу товара * * @return SettlementInterface[] */ public function getSettlements(); /** - * @param SettlementInterface[] $value + * Устанавливает массив оплат, обеспечивающих выдачу товара + * + * @param SettlementInterface[]|array $value Массив оплат, обеспечивающих выдачу товара * @return CreatePostReceiptRequestInterface */ public function setSettlements($value); /** - * @return string|null + * Возвращает идентификатор магазина, от имени которого нужно отправить чек + * @return string|null Идентификатор магазина, от имени которого нужно отправить чек */ public function getOnBehalfOf(); /** - * @param string $value + * Устанавливает идентификатор магазина, от имени которого нужно отправить чек. + * Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId). + * Необходимо передавать, если вы используете решение ЮKassa для платформ. + * + * @param string $value Идентификатор магазина, от имени которого нужно отправить чек */ public function setOnBehalfOf($value); /** * Проверяет есть ли в чеке хотя бы одна позиция - * @return bool True если чек не пуст, false если в чеке нет ни одной позиции. + * @return bool True если чек не пуст, false если в чеке нет ни одной позиции */ function notEmpty(); } diff --git a/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php b/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php index e8be4964..e0dd7ab3 100644 --- a/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php +++ b/lib/Request/Receipts/CreatePostReceiptRequestSerializer.php @@ -33,13 +33,15 @@ use YooKassa\Model\Settlement; /** * Класс сериалайзера объекта запроса к API создание чека * - * @package YooKassa\Request\Receipts + * @package YooKassa */ class CreatePostReceiptRequestSerializer { /** - * @param CreatePostReceiptRequestInterface $request - * @return array + * Сериализует объект запроса к API для дальнейшей его отправки + * + * @param CreatePostReceiptRequestInterface $request Сериализуемый объект + * @return array Массив с информацией, отправляемый в дальнейшем в API */ public function serialize(CreatePostReceiptRequestInterface $request) { diff --git a/lib/Request/Receipts/PaymentReceiptResponse.php b/lib/Request/Receipts/PaymentReceiptResponse.php index efe1e1d8..5a28e762 100644 --- a/lib/Request/Receipts/PaymentReceiptResponse.php +++ b/lib/Request/Receipts/PaymentReceiptResponse.php @@ -31,14 +31,16 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Helpers\TypeCast; /** - * Class PaymentReceipt - * @package YooKassa\Model + * Класс описывающий чек, привязанный к платежу * - * @property string $payment_id Идентификатор платежа в ЮKassa. - * @property string $paymentId Идентификатор платежа в ЮKassa. + * @package YooKassa + * + * @property string $payment_id Идентификатор платежа в ЮKassa + * @property string $paymentId Идентификатор платежа в ЮKassa */ class PaymentReceiptResponse extends AbstractReceiptResponse { + /** Длина идентификатора платежа */ const LENGTH_PAYMENT_ID = 36; private $_payment_id; @@ -56,7 +58,9 @@ class PaymentReceiptResponse extends AbstractReceiptResponse } /** - * @return string + * Возвращает идентификатор платежа + * + * @return string Идентификатор платежа */ public function getPaymentId() { diff --git a/lib/Request/Receipts/ReceiptResponseFactory.php b/lib/Request/Receipts/ReceiptResponseFactory.php index 5e53f19e..86a9b20e 100644 --- a/lib/Request/Receipts/ReceiptResponseFactory.php +++ b/lib/Request/Receipts/ReceiptResponseFactory.php @@ -30,8 +30,9 @@ namespace YooKassa\Request\Receipts; use YooKassa\Model\ReceiptType; /** - * Class ReceiptResponseFactory - * @package YooKassa\Request\Receipts + * Фабричный класс для работы с чеками + * + * @package YooKassa */ class ReceiptResponseFactory { @@ -42,9 +43,11 @@ class ReceiptResponseFactory ); /** - * @param array $data + * Фабричный метод для работы с чеками * - * @return AbstractReceiptResponse + * @param array $data Массив с данными чека + * + * @return AbstractReceiptResponse|SimpleReceiptResponse|PaymentReceiptResponse|RefundReceiptResponse Объект чека определенного типа */ public function factory($data) { diff --git a/lib/Request/Receipts/ReceiptResponseInterface.php b/lib/Request/Receipts/ReceiptResponseInterface.php index 0eaec09c..44ecadc9 100644 --- a/lib/Request/Receipts/ReceiptResponseInterface.php +++ b/lib/Request/Receipts/ReceiptResponseInterface.php @@ -31,7 +31,7 @@ use YooKassa\Model\SettlementInterface; /** * Interface ReceiptInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $id Идентификатор чека в ЮKassa. * @property-read string $type Тип чека в онлайн-кассе: приход "payment" или возврат "refund". diff --git a/lib/Request/Receipts/ReceiptResponseItem.php b/lib/Request/Receipts/ReceiptResponseItem.php index d8bf46a1..90ea9da8 100644 --- a/lib/Request/Receipts/ReceiptResponseItem.php +++ b/lib/Request/Receipts/ReceiptResponseItem.php @@ -38,9 +38,9 @@ use YooKassa\Model\Supplier; use YooKassa\Model\SupplierInterface; /** - * Interface ReceiptItemInterface + * Класс, описывающий товар в чеке * - * @package YooKassa\Model + * @package YooKassa * * @property string $description Название товара (не более 128 символов). * @property float $quantity Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы. diff --git a/lib/Request/Receipts/ReceiptResponseItemInterface.php b/lib/Request/Receipts/ReceiptResponseItemInterface.php index d53572db..fb739f8e 100644 --- a/lib/Request/Receipts/ReceiptResponseItemInterface.php +++ b/lib/Request/Receipts/ReceiptResponseItemInterface.php @@ -32,7 +32,7 @@ use YooKassa\Model\SupplierInterface; /** * Interface ReceiptItemInterface * - * @package YooKassa\Model + * @package YooKassa * * @property-read string $description Название товара (не более 128 символов). * @property-read float $quantity Количество товара. Максимально возможное значение зависит от модели вашей онлайн-кассы. diff --git a/lib/Request/Receipts/ReceiptsRequest.php b/lib/Request/Receipts/ReceiptsRequest.php index fa72f9e5..ea374fe2 100644 --- a/lib/Request/Receipts/ReceiptsRequest.php +++ b/lib/Request/Receipts/ReceiptsRequest.php @@ -36,7 +36,7 @@ use YooKassa\Model\RefundStatus; /** * Класс объекта запроса к API списка возвратов магазина * - * @package YooKassa\Request\Receipts + * @package YooKassa * * @property \DateTime $createdAtGte Время создания, от (включительно) * @property \DateTime $createdAtGt Время создания, от (не включая) @@ -50,6 +50,7 @@ use YooKassa\Model\RefundStatus; */ class ReceiptsRequest extends AbstractRequest implements ReceiptsRequestInterface { + /** Максимальное количество объектов чеков в выборке */ const MAX_LIMIT_VALUE = 100; /** diff --git a/lib/Request/Receipts/ReceiptsRequestBuilder.php b/lib/Request/Receipts/ReceiptsRequestBuilder.php index ad047332..03d2900d 100644 --- a/lib/Request/Receipts/ReceiptsRequestBuilder.php +++ b/lib/Request/Receipts/ReceiptsRequestBuilder.php @@ -26,6 +26,7 @@ namespace YooKassa\Request\Receipts; +use YooKassa\Common\AbstractRequest; use YooKassa\Common\AbstractRequestBuilder; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -33,7 +34,7 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; /** * Класс билдера объектов запросов к API списка чеков * - * @package YooKassa\Request\Receipts + * @package YooKassa */ class ReceiptsRequestBuilder extends AbstractRequestBuilder { @@ -186,7 +187,7 @@ class ReceiptsRequestBuilder extends AbstractRequestBuilder /** * Собирает и возвращает объект запроса списка чеков магазина * @param array|null $options Массив с настройками запроса - * @return ReceiptsRequestInterface Инстанс объекта запроса к API для получения списка чеков магазина + * @return ReceiptsRequestInterface|AbstractRequest Инстанс объекта запроса к API для получения списка чеков магазина */ public function build(array $options = null) { diff --git a/lib/Request/Receipts/ReceiptsRequestInterface.php b/lib/Request/Receipts/ReceiptsRequestInterface.php index c0d013d7..a9a90467 100644 --- a/lib/Request/Receipts/ReceiptsRequestInterface.php +++ b/lib/Request/Receipts/ReceiptsRequestInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Receipts; /** * Интерфейс объекта запроса списка возвратов * - * @package YooKassa\Request\Refunds + * @package YooKassa * * @property-read string $paymentId Идентификатор платежа * @property-read string $refundId Идентификатор возврата diff --git a/lib/Request/Receipts/ReceiptsRequestSerializer.php b/lib/Request/Receipts/ReceiptsRequestSerializer.php index cf3ec402..d0e501bd 100644 --- a/lib/Request/Receipts/ReceiptsRequestSerializer.php +++ b/lib/Request/Receipts/ReceiptsRequestSerializer.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Receipts; /** * Класс сериализатора объектов запросов к API для получения списка возвратов * - * @package YooKassa\Request\Receipts + * @package YooKassa */ class ReceiptsRequestSerializer { @@ -50,8 +50,9 @@ class ReceiptsRequestSerializer /** * Сериализует объект запроса к API для дальнейшей его отправки + * * @param ReceiptsRequestInterface $request Сериализуемый объект - * @return array Массив с инфомрацией, отпарвляемый в дальнейшем в API + * @return array Массив с информацией, отправляемый в дальнейшем в API */ public function serialize(ReceiptsRequestInterface $request) { diff --git a/lib/Request/Receipts/ReceiptsResponse.php b/lib/Request/Receipts/ReceiptsResponse.php index cca3a9c6..f1b6d1d9 100644 --- a/lib/Request/Receipts/ReceiptsResponse.php +++ b/lib/Request/Receipts/ReceiptsResponse.php @@ -27,8 +27,9 @@ namespace YooKassa\Request\Receipts; /** - * Class ReceiptsResponse - * @package YooKassa\Request\Receipts + * Класс для работы со списком чеков + * + * @package YooKassa */ class ReceiptsResponse { diff --git a/lib/Request/Receipts/RefundReceiptResponse.php b/lib/Request/Receipts/RefundReceiptResponse.php index e3bef1ea..8b79ba63 100644 --- a/lib/Request/Receipts/RefundReceiptResponse.php +++ b/lib/Request/Receipts/RefundReceiptResponse.php @@ -31,14 +31,16 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; use YooKassa\Helpers\TypeCast; /** - * Class RefundReceipt - * @package YooKassa\Model + * Класс описывающий чек, привязанный к возврату + * + * @package YooKassa * * @property string $refund_id Идентификатор возврата в ЮKassa. * @property string $refundId Идентификатор возврата в ЮKassa. */ class RefundReceiptResponse extends AbstractReceiptResponse { + /** Длина идентификатора возврата */ const LENGTH_REFUND_ID = 36; private $_refund_id; @@ -56,7 +58,9 @@ class RefundReceiptResponse extends AbstractReceiptResponse } /** - * @return string + * Возвращает идентификатор возврата + * + * @return string Идентификатор возврата */ public function getRefundId() { diff --git a/lib/Request/Receipts/SimpleReceiptResponse.php b/lib/Request/Receipts/SimpleReceiptResponse.php index 88e11253..52401e5a 100644 --- a/lib/Request/Receipts/SimpleReceiptResponse.php +++ b/lib/Request/Receipts/SimpleReceiptResponse.php @@ -27,10 +27,9 @@ namespace YooKassa\Request\Receipts; /** - * Class SimpleReceiptResponse - * @package YooKassa\Model + * Класс описывающий чек, не привязанный ни к платежу ни к возврату * - * Чек, не привязанный ни к платежу, ни к возврату + * @package YooKassa */ class SimpleReceiptResponse extends AbstractReceiptResponse { diff --git a/lib/Request/Refunds/AbstractRefundResponse.php b/lib/Request/Refunds/AbstractRefundResponse.php index 72e3f7c9..a0c24f45 100644 --- a/lib/Request/Refunds/AbstractRefundResponse.php +++ b/lib/Request/Refunds/AbstractRefundResponse.php @@ -32,7 +32,7 @@ use YooKassa\Model\Refund; /** * Абстрактный класс ответа от API с информацией о возврате * - * @package YooKassa\Request\Refunds + * @package YooKassa */ abstract class AbstractRefundResponse extends Refund { diff --git a/lib/Request/Refunds/CreateRefundRequest.php b/lib/Request/Refunds/CreateRefundRequest.php index 3660470f..64c50df5 100644 --- a/lib/Request/Refunds/CreateRefundRequest.php +++ b/lib/Request/Refunds/CreateRefundRequest.php @@ -39,10 +39,13 @@ use YooKassa\Model\SourceInterface; /** * Класс объекта запроса для создания возврата * + * @example 02-builder.php 148 35 Пример использования билдера + * * @property string $paymentId Айди платежа для которого создаётся возврат * @property AmountInterface $amount Сумма возврата * @property string $description Комментарий к операции возврата, основание для возврата средств покупателю. * @property ReceiptInterface|null $receipt Инстанс чека или null + * @property SourceInterface[]|null $sources Информация о распределении денег — сколько и в какой магазин нужно перевести */ class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefundRequestInterface { @@ -62,8 +65,8 @@ class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefund private $_sources; /** - * Возвращает айди платежа для которого создаётся возврат средств - * @return string Айди платежа для которого создаётся возврат + * Возвращает идентификатор платежа для которого создаётся возврат средств + * @return string Идентификатор платежа для которого создаётся возврат */ public function getPaymentId() { @@ -71,12 +74,12 @@ class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefund } /** - * Устанавливает айди платежа для которого создаётся возврат - * @param string $value Айди платежа + * Устанавливает идентификатор платежа для которого создаётся возврат + * @param string $value Идентификатор платежа * - * @throws EmptyPropertyValueException Выбрасывается если передано пустое значение айди платежа + * @throws EmptyPropertyValueException Выбрасывается если передано пустое значение идентификатора платежа * @throws InvalidPropertyValueException Выбрасывается если переданное значение является строкой, но не является - * валидным значением айди платежа + * валидным значением идентификатора платежа * @throws InvalidPropertyValueTypeException Выбрасывается если передано значение не валидного типа */ public function setPaymentId($value) @@ -138,8 +141,8 @@ class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefund } /** - * Устанавливает transfers (массив распределения денег между магазинами) - * @param SourceInterface[]|array $value + * Устанавливает sources (массив распределения денег между магазинами) + * @param SourceInterface[]|array $value Массив распределения денег между магазинами */ public function setSources($value) { @@ -165,7 +168,8 @@ class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefund } /** - * @return SourceInterface[] + * Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + * @return SourceInterface[] Информация о распределении денег */ public function getSources() { @@ -173,6 +177,7 @@ class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefund } /** + * Проверяет наличие информации о распределении денег * @return bool */ public function hasSources() diff --git a/lib/Request/Refunds/CreateRefundRequestBuilder.php b/lib/Request/Refunds/CreateRefundRequestBuilder.php index cd197e21..059daf09 100644 --- a/lib/Request/Refunds/CreateRefundRequestBuilder.php +++ b/lib/Request/Refunds/CreateRefundRequestBuilder.php @@ -27,6 +27,7 @@ namespace YooKassa\Request\Refunds; use YooKassa\Common\AbstractPaymentRequestBuilder; +use YooKassa\Common\AbstractRequest; use YooKassa\Common\Exceptions\EmptyPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -35,13 +36,16 @@ use YooKassa\Model\SourceInterface; /** * Класс билдера запросов к API на создание возврата средств * - * @package YooKassa\Request\Refunds + * @example 02-builder.php 148 35 Пример использования билдера + * + * @package YooKassa */ class CreateRefundRequestBuilder extends AbstractPaymentRequestBuilder { /** - * @var CreateRefundRequest Собираемый объет запроса к API + * Собираемый объет запроса к API + * @var CreateRefundRequest */ protected $currentObject; @@ -100,7 +104,7 @@ class CreateRefundRequestBuilder extends AbstractPaymentRequestBuilder /** * Строит объект запроса к API * @param array|null $options Устаналвиваемые параметры запроса - * @return CreateRefundRequestInterface Инстанс сгенерированного объекта запроса к API + * @return CreateRefundRequestInterface|AbstractRequest Инстанс сгенерированного объекта запроса к API */ public function build(array $options = null) { diff --git a/lib/Request/Refunds/CreateRefundRequestInterface.php b/lib/Request/Refunds/CreateRefundRequestInterface.php index 9943d65a..511ef2b4 100644 --- a/lib/Request/Refunds/CreateRefundRequestInterface.php +++ b/lib/Request/Refunds/CreateRefundRequestInterface.php @@ -33,7 +33,7 @@ use YooKassa\Model\SourceInterface; /** * Интерфейс объекта запроса на возврат * - * @package YooKassa\Request\Refunds + * @package YooKassa * * @property-read string $paymentId Айди платежа для которого создаётся возврат * @property-read AmountInterface $amount Сумма возврата @@ -54,6 +54,12 @@ interface CreateRefundRequestInterface */ function getAmount(); + /** + * Устанавливает комментарий к возврату + * @param string $value Комментарий к операции возврата, основание для возврата средств покупателю + */ + function setDescription($value); + /** * Возвращает комментарий к возврату или null, если комментарий не задан * @return string Комментарий к операции возврата, основание для возврата средств покупателю. @@ -66,6 +72,12 @@ interface CreateRefundRequestInterface */ function hasDescription(); + /** + * Устанавливает чек + * @param ReceiptInterface|null $value Инстанс чека или null для удаления информации о чеке + */ + function setReceipt($value); + /** * Возвращает инстанс чека или null если чек не задан * @return ReceiptInterface|null Инстанс чека или null @@ -79,11 +91,19 @@ interface CreateRefundRequestInterface function hasReceipt(); /** - * @return SourceInterface[] + * Устанавливает информацию о распределении денег — сколько и в какой магазин нужно перевести + * @param SourceInterface[] $value Информация о распределении денег + */ + function setSources($value); + + /** + * Возвращает информацию о распределении денег — сколько и в какой магазин нужно перевести + * @return SourceInterface[] Информация о распределении денег */ function getSources(); /** + * Проверяет наличие информации о распределении денег * @return bool */ function hasSources(); diff --git a/lib/Request/Refunds/CreateRefundRequestSerializer.php b/lib/Request/Refunds/CreateRefundRequestSerializer.php index c454eaa4..a368e6fa 100644 --- a/lib/Request/Refunds/CreateRefundRequestSerializer.php +++ b/lib/Request/Refunds/CreateRefundRequestSerializer.php @@ -33,7 +33,7 @@ use YooKassa\Model\SourceInterface; /** * Класс сериалайзера запросов к API на создание нового возврата средств * - * @package YooKassa\Request\Refunds + * @package YooKassa */ class CreateRefundRequestSerializer { @@ -117,11 +117,10 @@ class CreateRefundRequestSerializer } /** - * @param SourceInterface[] $transfers - * + * @param array $sources * @return array */ - private function serializeSources(array $sources) + private function serializeSources($sources) { $result = array(); foreach ($sources as $source) { diff --git a/lib/Request/Refunds/CreateRefundResponse.php b/lib/Request/Refunds/CreateRefundResponse.php index 466c539d..805a9b3c 100644 --- a/lib/Request/Refunds/CreateRefundResponse.php +++ b/lib/Request/Refunds/CreateRefundResponse.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Refunds; /** * Класс объекта ответа от API при создании нового возврата * - * @package YooKassa\Request\Refunds + * @package YooKassa */ class CreateRefundResponse extends AbstractRefundResponse {} diff --git a/lib/Request/Refunds/RefundResponse.php b/lib/Request/Refunds/RefundResponse.php index bdd3d375..cced5c16 100644 --- a/lib/Request/Refunds/RefundResponse.php +++ b/lib/Request/Refunds/RefundResponse.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Refunds; /** * Класс объекта ответа от API при запросе одного конкретного возврата * - * @package YooKassa\Request\Refunds + * @package YooKassa */ class RefundResponse extends AbstractRefundResponse {} diff --git a/lib/Request/Refunds/RefundsRequest.php b/lib/Request/Refunds/RefundsRequest.php index cd97d7e7..48e96618 100644 --- a/lib/Request/Refunds/RefundsRequest.php +++ b/lib/Request/Refunds/RefundsRequest.php @@ -36,7 +36,7 @@ use YooKassa\Model\RefundStatus; /** * Класс объекта запроса к API списка возвратов магазина * - * @package YooKassa\Request\Refunds + * @package YooKassa * * @property \DateTime $createdAtGte Время создания, от (включительно) * @property \DateTime $createdAtGt Время создания, от (не включая) @@ -49,6 +49,7 @@ use YooKassa\Model\RefundStatus; */ class RefundsRequest extends AbstractRequest implements RefundsRequestInterface { + /** Максимальное количество объектов возвратов в выборке */ const MAX_LIMIT_VALUE = 100; /** diff --git a/lib/Request/Refunds/RefundsRequestBuilder.php b/lib/Request/Refunds/RefundsRequestBuilder.php index 8d0c4bc8..803fdc15 100644 --- a/lib/Request/Refunds/RefundsRequestBuilder.php +++ b/lib/Request/Refunds/RefundsRequestBuilder.php @@ -26,6 +26,7 @@ namespace YooKassa\Request\Refunds; +use YooKassa\Common\AbstractRequest; use YooKassa\Common\AbstractRequestBuilder; use YooKassa\Common\Exceptions\InvalidPropertyValueException; use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; @@ -33,7 +34,7 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException; /** * Класс билдера объектов запросов к API списка возвратов * - * @package YooKassa\Request\Refunds + * @package YooKassa */ class RefundsRequestBuilder extends AbstractRequestBuilder { @@ -172,7 +173,7 @@ class RefundsRequestBuilder extends AbstractRequestBuilder /** * Собирает и возвращает объект запроса списка возвратов магазина * @param array|null $options Массив с настройками запроса - * @return RefundsRequestInterface Инстанс объекта запроса к API для получения списка возвратов магазина + * @return RefundsRequestInterface|AbstractRequest Инстанс объекта запроса к API для получения списка возвратов магазина */ public function build(array $options = null) { diff --git a/lib/Request/Refunds/RefundsRequestInterface.php b/lib/Request/Refunds/RefundsRequestInterface.php index b6208876..4cfbd0fc 100644 --- a/lib/Request/Refunds/RefundsRequestInterface.php +++ b/lib/Request/Refunds/RefundsRequestInterface.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Refunds; /** * Интерфейс объекта запроса списка возвратов * - * @package YooKassa\Request\Refunds + * @package YooKassa * * @property-read string $paymentId Идентификатор платежа * @property-read \DateTime $createdAtGte Время создания, от (включительно) diff --git a/lib/Request/Refunds/RefundsRequestSerializer.php b/lib/Request/Refunds/RefundsRequestSerializer.php index abef3ab7..f8249f1a 100644 --- a/lib/Request/Refunds/RefundsRequestSerializer.php +++ b/lib/Request/Refunds/RefundsRequestSerializer.php @@ -29,7 +29,7 @@ namespace YooKassa\Request\Refunds; /** * Класс сериализатора объектов запросов к API для получения списка возвратов * - * @package YooKassa\Request\Refunds + * @package YooKassa */ class RefundsRequestSerializer { diff --git a/lib/Request/Refunds/RefundsResponse.php b/lib/Request/Refunds/RefundsResponse.php index c46ad3c1..d1da7c4a 100644 --- a/lib/Request/Refunds/RefundsResponse.php +++ b/lib/Request/Refunds/RefundsResponse.php @@ -26,12 +26,13 @@ namespace YooKassa\Request\Refunds; +use Exception; use YooKassa\Model\RefundInterface; /** * Класс объекта ответа от API со списком возвратов магазина * - * @package YooKassa\Request\Refunds + * @package YooKassa */ class RefundsResponse { @@ -48,6 +49,7 @@ class RefundsResponse /** * Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива * @param array $options Массив настроек, пришедший от API + * @throws Exception */ public function __construct(array $options) { diff --git a/lib/Request/Webhook/WebhookListResponse.php b/lib/Request/Webhook/WebhookListResponse.php index 8da52e07..b0b6e781 100644 --- a/lib/Request/Webhook/WebhookListResponse.php +++ b/lib/Request/Webhook/WebhookListResponse.php @@ -27,19 +27,27 @@ namespace YooKassa\Request\Webhook; use YooKassa\Model\Webhook\Webhook; +/** + * Актуальный список объектов webhook для переданного OAuth-токена + * + * @package YooKassa + */ class WebhookListResponse { + /** + * Тип ответа + * @var string + */ private $type; /** - * Список способов оплаты подходящих для оплаты заказа - * Если нет ни одного доступного способа оплаты, список будет пустым - * @var Webhook[] Список способов оплаты + * Список установленных webhook для переданного OAuth-токена + * @var Webhook[] Список установленных webhook */ private $items; /** - * Конструктор, устанавливает список полученныз от API способов оплаты + * Конструктор, устанавливает список полученных от API установленных webhook для переданного OAuth-токена * * @param array $response Разобранный ответ от API в виде массива */ @@ -55,9 +63,17 @@ class WebhookListResponse } /** - * Возаращает список способов оплаты подходящих для оплаты заказа - * Если нет ни одного доступного способа оплаты, список будет пустым - * @return Webhook[] Список способов оплаты + * Возвращает тип ответа. Доступен только `list` + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Возвращает список установленных webhook для переданного OAuth-токена + * @return Webhook[] Список установленных webhook */ public function getItems() { diff --git a/phpdoc.xml b/phpdoc.xml new file mode 100644 index 00000000..63aac836 --- /dev/null +++ b/phpdoc.xml @@ -0,0 +1,42 @@ + + + YooKassa API SDK + + .phpdoc + + + latest + + + lib + + api + + + php + + public + protected + + template + template-extends + template-implements + extends + implements + + YooKassa + true + + +