Compare commits
18 Commits
703c5178f5
...
v1.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| baf97cad20 | |||
| 2e8099e0a4 | |||
| d7f3c81fac | |||
| e22c1cb091 | |||
| 58bc344a86 | |||
| fdc5ab112a | |||
| 71d1f2900c | |||
| b4cc0fec53 | |||
| 573af15bac | |||
| 19653776c5 | |||
| c7d07a18f1 | |||
| 464a8f0706 | |||
| 294a3ef2f3 | |||
| b4af189292 | |||
| 6787ce3ad7 | |||
| 1d6abfd475 | |||
| 058ce5ed3d | |||
| 16d1146826 |
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@@ -6,7 +6,7 @@ on:
|
||||
push:
|
||||
branches: [ master, dev ]
|
||||
pull_request:
|
||||
branches: [ master, dev ]
|
||||
branches: [ dev ]
|
||||
|
||||
jobs:
|
||||
Tests:
|
||||
|
||||
43
README.md
43
README.md
@@ -2,30 +2,26 @@
|
||||
|
||||
[](https://packagist.org/packages/axenov/atol-online)
|
||||
[](https://packagist.org/packages/axenov/atol-online)
|
||||
[](https://packagist.org/packages/axenov/atol-online)
|
||||
[](https://packagist.org/packages/axenov/atol-online)
|
||||
[](https://packagist.org/packages/axenov/atol-online)
|
||||
[](https://packagist.org/packages/axenov/atol-online)
|
||||
[](LICENSE)
|
||||
|
||||
Библиотека для фискализации чеков по 54-ФЗ через [облачную ККТ АТОЛ](https://online.atol.ru/).
|
||||
Библиотека для фискализации чеков по 54-ФЗ через [облачные ККТ АТОЛ](https://online.atol.ru/).
|
||||
|
||||
**[Документация](/docs/readme.md)**
|
||||
|
||||
---
|
||||
|
||||
**В ветке `dev` проводится глубокий рефакторинг, стабилизация и активная подготовка к `v1.0.0`.
|
||||
Документация актуализируется постепенно.**
|
||||
|
||||
---
|
||||
|
||||
| master | [](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [](https://codecov.io/gh/anthonyaxenov/atol-online) |
|
||||
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| dev | [](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [](https://codecov.io/gh/anthonyaxenov/atol-online) |
|
||||
|
||||
Текущие поддерживаемые версии АТОЛ Онлайн:
|
||||
|
||||
| Протокол | API | ФФД | Статус |
|
||||
|----------|-----|------|-------------|
|
||||
| v4 | 5.7 | 1.05 | Рефакторинг |
|
||||
| v5 | 2.0 | 1.2 | В планах |
|
||||
| Протокол | API | ФФД | Статус |
|
||||
|----------|-----|------|----------------|
|
||||
| v4 | 5.8 | 1.05 | Поддерживается |
|
||||
| v5 | 2.0 | 1.2 | В планах |
|
||||
|
||||
Состояние веток:
|
||||
|
||||
| master | [](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [](https://codecov.io/gh/anthonyaxenov/atol-online) |
|
||||
|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| dev | [](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml) | [](https://codecov.io/gh/anthonyaxenov/atol-online) |
|
||||
|
||||
## Плюшечки
|
||||
|
||||
@@ -33,8 +29,7 @@
|
||||
* Фискализация докумнетов на облачной ККТ
|
||||
* Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
|
||||
* Расчёты денег в копейках
|
||||
* PSR-4 автозагрузка
|
||||
<!--* Фактически полное покрытие тестами-->
|
||||
* PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters
|
||||
|
||||
## Системные требования
|
||||
|
||||
@@ -50,7 +45,7 @@
|
||||
|
||||
### Подключение библиотеки
|
||||
|
||||
1. Установить библиотеку пакет к проекту:
|
||||
1. Подключить пакет к проекту:
|
||||
```bash
|
||||
composer require axenov/atol-online
|
||||
```
|
||||
@@ -69,10 +64,10 @@
|
||||
|
||||
```bash
|
||||
composer test # обычное тестирование
|
||||
composer test-cov # тестирование с покрытием
|
||||
composer coverage # тестирование с покрытием
|
||||
```
|
||||
|
||||
После тестирования с покрытием создаётся отчёт в директории `.coverage-report` в корне репозитория.
|
||||
После тестирования с покрытием создаётся отчёт в директории `.coverage` в корне репозитория.
|
||||
|
||||
## Использование библиотеки
|
||||
|
||||
@@ -89,8 +84,6 @@ composer test-cov # тестирование с покрытием
|
||||
|
||||
## Дополнительные ресурсы
|
||||
|
||||
* **[Документация к библиотеке](/docs/readme.md)**
|
||||
* Telegram-канал: [@atolonline_php](https://t.me/atolonline_php)
|
||||
* [Документация АТОЛ Онлайн](https://online.atol.ru/lib/)
|
||||
|
||||
## Лицензия
|
||||
|
||||
@@ -74,6 +74,10 @@
|
||||
},
|
||||
"scripts": {
|
||||
"test": "vendor/bin/phpunit --colors=always",
|
||||
"test-cov": "php -dxdebug.mode=coverage vendor/bin/phpunit --coverage-html .coverage-report"
|
||||
"coverage": "php -dxdebug.mode=coverage vendor/bin/phpunit --coverage-html .coverage"
|
||||
},
|
||||
"config": {
|
||||
"optimize-autoloader": true,
|
||||
"sort-packages": true
|
||||
}
|
||||
}
|
||||
|
||||
12
composer.lock
generated
12
composer.lock
generated
@@ -1935,16 +1935,16 @@
|
||||
},
|
||||
{
|
||||
"name": "phpspec/prophecy",
|
||||
"version": "1.14.0",
|
||||
"version": "v1.15.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/phpspec/prophecy.git",
|
||||
"reference": "d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e"
|
||||
"reference": "bbcd7380b0ebf3961ee21409db7b38bc31d69a13"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/phpspec/prophecy/zipball/d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e",
|
||||
"reference": "d86dfc2e2a3cd366cee475e52c6bb3bbc371aa0e",
|
||||
"url": "https://api.github.com/repos/phpspec/prophecy/zipball/bbcd7380b0ebf3961ee21409db7b38bc31d69a13",
|
||||
"reference": "bbcd7380b0ebf3961ee21409db7b38bc31d69a13",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@@ -1996,9 +1996,9 @@
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/phpspec/prophecy/issues",
|
||||
"source": "https://github.com/phpspec/prophecy/tree/1.14.0"
|
||||
"source": "https://github.com/phpspec/prophecy/tree/v1.15.0"
|
||||
},
|
||||
"time": "2021-09-10T09:02:12+00:00"
|
||||
"time": "2021-12-08T12:19:24+00:00"
|
||||
},
|
||||
{
|
||||
"name": "phpunit/php-code-coverage",
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
# Работа с клиентами (покупателями)
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
Объект покупателя инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$customer = new AtolOnline\Entities\Client();
|
||||
```
|
||||
|
||||
У объекта покупателя могут быть указаны любые из следующих атрибутов:
|
||||
* email (тег ФФД 1008);
|
||||
* ИНН (тег ФФД 1128);
|
||||
* наименование (тег ФФД 1127);
|
||||
* номер телефона (тег ФФД 1008).
|
||||
|
||||
> Все эти атрибуты являются **необязательными**.
|
||||
> Если указаны одновременно и email, и номер телефона, то ОФД отправит чек только на email.
|
||||
|
||||
Указать эти атрибуты можно двумя способами:
|
||||
|
||||
```php
|
||||
// 1 способ - через конструктор
|
||||
$customer = new AtolOnline\Entities\Client(
|
||||
'John Doe', // наименование
|
||||
'john@example.com', // email
|
||||
'+1/22/99*73s dsdas654 5s6', // номер телефона +122997365456
|
||||
'+fasd3\qe3fs_=nac990139928czc' // номер ИНН 3399013928
|
||||
);
|
||||
|
||||
// 2 способ - через сеттеры
|
||||
$customer = (new AtolOnline\Entities\Client())
|
||||
->setEmail('john@example.com')
|
||||
->setInn('+fasd3\q3fs_=nac9901 3928c-c')
|
||||
->setName('John Doe')
|
||||
->setPhone('+1/22/99*73s dsdas654 5s6');
|
||||
|
||||
// либо комбинация этих способов
|
||||
```
|
||||
|
||||
Получить установленные значения атрибутов можно через геттеры:
|
||||
|
||||
```php
|
||||
$customer->getInn();
|
||||
$customer->getEmail();
|
||||
$customer->getName();
|
||||
$customer->getPhone();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительно:
|
||||
|
||||
```php
|
||||
echo $customer;
|
||||
$json_string = (string)$customer;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $customer->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
19
docs/collection.md
Normal file
19
docs/collection.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Коллекция сущностей
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
|
||||
---
|
||||
|
||||
Коллекциями являются объекты, способные хранить в себе [сущности](entity.md). Они унаследованы
|
||||
от `Illuminate/Support/Collection` и полностью поддерживают все
|
||||
[стандартные методы коллекций Laravel](https://laravel.com/docs/master/collections).
|
||||
|
||||
Помимо этого, они валидируют количество и вид сущностей, которые могут хранить в себе, согласно схеме АТОЛ Онлайн API.
|
||||
|
||||
Коллекции ведут себя аналогично самим сущностям в части приведения к массивам и json-ификации.
|
||||
|
||||
---
|
||||
|
||||
Читай также: [Сущность](entity.md)
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
@@ -1,67 +0,0 @@
|
||||
# Работа с компанией (продавцом)
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
Объект компании инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$customer = new AtolOnline\Entities\Company();
|
||||
```
|
||||
|
||||
У объекта компании должны быть указаны все следующие атрибуты:
|
||||
* email (тег ФФД 1117);
|
||||
* ИНН (тег ФФД 1018);
|
||||
* тип системы налогообложения (тег ФФД 1055) - все типы перечислены в классе `AtolOnline\Constants\SnoTypes`;
|
||||
* адрес места расчётов (тег ФФД 1187) - для интернет-сервисов указывается URL с протоколом.
|
||||
|
||||
> Все эти атрибуты являются **обязательными**.
|
||||
> Для тестового режима используйте значения ИНН и адреса места расчётов, [указанные здесь](https://online.atol.ru/files/ffd/test_sreda.txt).
|
||||
|
||||
Указать эти атрибуты можно двумя способами:
|
||||
|
||||
```php
|
||||
// 1 способ - через конструктор (все аргументы обязательны)
|
||||
$company = new AtolOnline\Entities\Company(
|
||||
'company@example.com' // email
|
||||
AtolOnline\Constants\SnoTypes::OSN, // тип СНО
|
||||
'5544332219', // номер ИНН
|
||||
'https://v4.online.atol.ru', // адрес места расчётов
|
||||
);
|
||||
|
||||
// 2 способ - через сеттеры
|
||||
$company
|
||||
->setEmail('company@example.com')
|
||||
->setInn('5544332219')
|
||||
->setSno(AtolOnline\Constants\SnoTypes::USN_INCOME)
|
||||
->setPaymentAddress('https://v4.online.atol.ru');
|
||||
|
||||
// либо комбинация этих способов
|
||||
```
|
||||
|
||||
Получить установленные значения параметров можно через геттеры:
|
||||
|
||||
```php
|
||||
$company->getInn();
|
||||
$company->getEmail();
|
||||
$company->getPaymentAddress();
|
||||
$company->getSno();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительно:
|
||||
|
||||
```php
|
||||
echo $company;
|
||||
$json_string = (string)$company;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $company->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
@@ -1,62 +0,0 @@
|
||||
# Работа с данными коррекции
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
Объект для данных коррекции инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$info = new AtolOnline\Entities\CorrectionInfo();
|
||||
```
|
||||
|
||||
У объекта должны быть указаны все следующие обязательные атрибуты:
|
||||
* тип коррекции (тег ФФД 1173) - все типы перечислены в классе `AtolOnline\Constants\CorrectionTypes`;
|
||||
* дата документа основания для коррекции в формате `d.m.Y` (тег ФФД 1178);
|
||||
* номер документа основания для коррекции (тег ФФД 1179).
|
||||
|
||||
Указать эти атрибуты можно двумя способами:
|
||||
|
||||
```php
|
||||
use AtolOnline\{Entities\CorrectionInfo, Constants\CorrectionTypes};
|
||||
|
||||
// 1 способ - через конструктор
|
||||
$info = new CorrectionInfo(
|
||||
CorrectionTypes::SELF, // тип коррекции
|
||||
'01.01.2019', // дата документа коррекции
|
||||
'12345', // номер документа коррекции
|
||||
);
|
||||
|
||||
// 2 способ - через сеттеры
|
||||
$info = (new CorrectionInfo())
|
||||
->setType(CorrectionTypes::INSTRUCTION)
|
||||
->setDate('01.01.2019')
|
||||
->setNumber('9999');
|
||||
|
||||
// либо комбинация этих способов
|
||||
```
|
||||
|
||||
Получить установленные значения атрибутов можно через геттеры:
|
||||
|
||||
```php
|
||||
$info->getType();
|
||||
$info->getDate();
|
||||
$info->getNumber();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $customer;
|
||||
$json_string = (string)$customer;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $customer->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
@@ -1,167 +0,0 @@
|
||||
# Работа с документами
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
Объект документа инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$doc = new AtolOnline\Entities\Document();
|
||||
```
|
||||
|
||||
Для документов **прихода, возврата прихода, расхода и возврата расхода** должны быть указаны все следующие обязательные атрибуты:
|
||||
* [клиент](/docs/client.md);
|
||||
* [компания](/docs/company.md);
|
||||
* [предметы расчёта](/docs/items.md);
|
||||
* [оплаты](/docs/payments.md).
|
||||
|
||||
Для документов **коррекции прихода и коррекции расхода** должны быть указаны все следующие обязательные атрибуты:
|
||||
* [компания](/docs/company.md);
|
||||
* [оплаты](/docs/payments.md);
|
||||
* [ставки НДС](/docs/vats.md);
|
||||
* [данные коррекции](/docs/correction_info.md).
|
||||
|
||||
Для любых документов также могут быть указаны следующие необязательные атрибуты:
|
||||
* ФИО кассира (тег ФФД - 1021).
|
||||
|
||||
Установка атрибутов документа происходит через сеттеры.
|
||||
|
||||
## Работа с клиентом
|
||||
|
||||
Для этого существуют следующие методы:
|
||||
|
||||
```php
|
||||
$doc->setClient($client);
|
||||
$doc->getClient();
|
||||
```
|
||||
|
||||
> О работе с клиентами более подробно читайте [здесь](/docs/client.md).
|
||||
|
||||
## Работа с компанией
|
||||
|
||||
Для этого существуют следующие методы:
|
||||
|
||||
```php
|
||||
$doc->setCompany($company);
|
||||
$doc->getCompany();
|
||||
```
|
||||
|
||||
> О работе с компаниями более подробно читайте [здесь](/docs/company.md).
|
||||
|
||||
## Работа с предметами расчёта
|
||||
|
||||
Внутри документа существует [массив предметов расчёта](/docs/items.md#array).
|
||||
По умолчанию он пуст.
|
||||
Напрямую для манипуляций объект массива недоступен.
|
||||
Работа с ним происходит через методы документа:
|
||||
|
||||
```php
|
||||
$doc->setItems([$item1, $item2]);
|
||||
$doc->addItem($item3);
|
||||
$doc->getItems();
|
||||
```
|
||||
|
||||
Соответственно, эти методы выбрасывают те же исключения, что методы самого массива.
|
||||
|
||||
## Работа с оплатами
|
||||
|
||||
Внутри документа существует [массив оплат](/docs/payments.md#array).
|
||||
По умолчанию он пуст.
|
||||
Напрямую для манипуляций объект массива недоступен.
|
||||
Работа с ним происходит через методы документа:
|
||||
|
||||
```php
|
||||
$doc->setPayments([$payment1, $payment2]);
|
||||
$doc->addPayment($payment3);
|
||||
$doc->getPayments();
|
||||
```
|
||||
|
||||
Соответственно, эти методы выбрасывают те же исключения, что методы самого массива.
|
||||
|
||||
Следует отметить, что если при выполнении метода `addPayment()` выполняются следующие условия:
|
||||
* аргументом передан объект оплаты, у которого не задана сумма,
|
||||
* ранее документу не задавались оплаты,
|
||||
то автоматически этому объекту оплаты задаётся полная сумма чека.
|
||||
|
||||
## Работа со ставками НДС
|
||||
|
||||
Внутри документа существует [массив ставок НДС](/docs/vats.md#array).
|
||||
По умолчанию он пуст.
|
||||
Напрямую для манипуляций объект массива недоступен.
|
||||
Работа с ним происходит через методы документа:
|
||||
|
||||
```php
|
||||
$doc->setVats([$vat1, $vat2]);
|
||||
$doc->addVat($vat3);
|
||||
$doc->getVats();
|
||||
```
|
||||
|
||||
Соответственно, эти методы выбрасывают те же исключения, что методы самого массива.
|
||||
|
||||
Также существует метод `clearVats()`, который удаляет все вложенные объекты ставок НДС - из предметов расчёта и самого документа.
|
||||
|
||||
Следует отметить, что если при выполнении метода `addVat()` выполняются следующие условия:
|
||||
* аргументом передан объект ставки, у которого не задана сумма,
|
||||
* ранее документу не задавались ставки,
|
||||
то автоматически этому объекту налога задаётся полная сумма чека, от которой расчитывается итоговый размер налога.
|
||||
|
||||
## Общая сумма документа
|
||||
|
||||
Расчёт происходит автоматически в следующих случаях:
|
||||
* изменение предметов расчёта (`setItems()`, `addItem()`);
|
||||
* добавление оплат (`addPayment()` в случае, когда оплата передана без суммы);
|
||||
* изменение ставок НДС (`setVats()`, `clearVats()`, `addVat()` в случае, когда ставка передана без суммы);
|
||||
* приведение объекта документа к строке.
|
||||
|
||||
Также можно вызвать вручную метод `calcTotal()`.
|
||||
Он расчитывает полную сумму чека по предметам расчёта и пересчитывает **все** налоговые ставки.
|
||||
|
||||
Получить итог можно с помощью метода `getTotal()`.
|
||||
|
||||
Всё в рублях.
|
||||
|
||||
<a name='correction'></a>
|
||||
## Работа с данными коррекции
|
||||
|
||||
Если документ создаётся с целью коррекции прихода или расхода, то он обязательно должен содержать [данные коррекции](/docs/correction_info.md).
|
||||
|
||||
Задать и получить эти данные очень просто:
|
||||
|
||||
```php
|
||||
$doc->setCorrectionInfo(new AtolOnline\Entities\CorrectionInfo(
|
||||
AtolOnline\Constants\CorrectionTypes::SELF, // тип коррекции
|
||||
'01.01.2019', // дата документа коррекции
|
||||
'12345', // номер документа коррекции
|
||||
'test' // описание коррекции
|
||||
));
|
||||
$doc->getCorrectionInfo();
|
||||
```
|
||||
|
||||
## Работа с кассиром
|
||||
|
||||
Для этого существуют следующие методы:
|
||||
|
||||
```php
|
||||
$doc->setCashier('Иванова Лариса Васильевна');
|
||||
$doc->getCashier();
|
||||
```
|
||||
|
||||
## Прочее
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $doc;
|
||||
$json_string = (string)$doc;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $doc->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
52
docs/entity.md
Normal file
52
docs/entity.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Сущность
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
|
||||
---
|
||||
|
||||
Сущностями являются все классы, которые необходимы для взаимодействия с API. Они находятся в директори `src/Entities` и
|
||||
расширяют абстрактный класс `AtolOnline\Entities\Entity`.
|
||||
|
||||
Каждая сущность содержит в себе только те данные, которые необходимы согласно схемы АТОЛ Онлайн API.
|
||||
|
||||
Ниже перечислены возможности сущностей.
|
||||
|
||||
## Приведение к строке JSON
|
||||
|
||||
```php
|
||||
echo $entity;
|
||||
$json_string = (string)$entity;
|
||||
```
|
||||
|
||||
## Приведение к массиву
|
||||
|
||||
```php
|
||||
// результат идентичен
|
||||
$json_array1 = $entity->jsonSerialize();
|
||||
$json_array2 = $entity->toArray();
|
||||
```
|
||||
|
||||
## Чтение из массива
|
||||
|
||||
```php
|
||||
$var = new \AtolOnline\Entities\Client('Иванов Иван');
|
||||
echo $var['name']; // 'Иванов Иван'
|
||||
$var['name'] = 'Петров Пётр'; // BadMethodCallException
|
||||
```
|
||||
|
||||
## Fluent-сеттеры
|
||||
|
||||
Реализованы на уровне конкретных классов сущностей, но у некоторых могут полностью отсуствовать.
|
||||
|
||||
```php
|
||||
$entity->setFoo($value)->setBar('bar')->...
|
||||
```
|
||||
|
||||
Сеттеры валидируют и фильтруют данные согласно схеме АТОЛ Онлайн API, а в случае ошибочных значений -- выбрасывают
|
||||
исключения.
|
||||
|
||||
---
|
||||
|
||||
Читай также: [Коллекция сущностей](collection.md)
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
237
docs/fiscalizing.md
Normal file
237
docs/fiscalizing.md
Normal file
@@ -0,0 +1,237 @@
|
||||
# Фискализация документов
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
|
||||
---
|
||||
|
||||
## Доступ к ККТ
|
||||
|
||||
Для работы с облачной ККТ необходимы следующие параметры:
|
||||
|
||||
* логин;
|
||||
* пароль;
|
||||
* код группы.
|
||||
|
||||
Чтоы получить их, нужно:
|
||||
|
||||
1. авторизоваться в личном кабинете [online.atol.ru](https://online.atol.ru/lk/Account/Login);
|
||||
2. на странице [Мои компании](https://online.atol.ru/lk/Company/List) нажать кнопку **Настройки интегратора**.
|
||||
Скачается XML-файл с нужными настройками.
|
||||
|
||||
Также для работы потребуются:
|
||||
|
||||
* ИНН продавца;
|
||||
* URL места расчёта (ссылка на ваш интернет-сервис).
|
||||
|
||||
## Использование
|
||||
|
||||
Объект ККТ инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$kkt = new AtolOnline\Api\Fiscalizer();
|
||||
```
|
||||
|
||||
Установить параметры подключения можно двумя путями:
|
||||
|
||||
```php
|
||||
use AtolOnline\Api\Fiscalizer;
|
||||
|
||||
// 1 способ - через конструктор
|
||||
$kkt = new Fiscalizer(group: 'mygroup', login: 'mylogin', password: 'mypassword');
|
||||
|
||||
// 2 способ - через сеттеры
|
||||
$kkt = (new Fiscalizer())
|
||||
->setLogin($login)
|
||||
->setGroup($group)
|
||||
->setPassword($password);
|
||||
```
|
||||
|
||||
<a name="testmode"></a>
|
||||
|
||||
## Тестовый режим
|
||||
|
||||
По умолчанию фискализатор создаётся для работы в тестовом режиме. Это означает, что работа с АТОЛ Онлайн API будет
|
||||
происходить [в тестовой среде](https://online.atol.ru/files/ffd/test_sreda.txt).
|
||||
|
||||
> Под тестовым режимом работы подразумевается использование тестовых ККТ, которые принадлежат компании АТОЛ.
|
||||
|
||||
Управление тестовым режимом происходит следующим образом:
|
||||
|
||||
```php
|
||||
$kkt = new Fiscalizer(); // включен по умолчанию
|
||||
$kkt = new Fiscalizer(false); // выключен явно
|
||||
$kkt->setTestMode(); // включен явно
|
||||
$kkt->setTestMode(true); // включен явно
|
||||
$kkt->setTestMode(false); // выключен явно
|
||||
```
|
||||
|
||||
**При включенном тестовом режиме используются тестовые ККТ**, т.к. перед отправкой запроса подменяются:
|
||||
|
||||
* логин;
|
||||
* пароль;
|
||||
* группа ККТ;
|
||||
* ИНН клиента (покупателя);
|
||||
* ИНН и адрес места расчётов компании (продавца).
|
||||
|
||||
Таким образом:
|
||||
|
||||
* использовать тестовый режим -- безопасно;
|
||||
* при переключении тестового режима устанавливать заново свои параметры подключения не требуется.
|
||||
|
||||
**При выключенном тестовом режиме используются ваши ККТ.**
|
||||
|
||||
Если по каким-то причинам у вас не получится использовать тестовый режим, вы можете проводить свои тесты в боевом
|
||||
режиме (на собственной ККТ). В этом случае важно понимать следующее:
|
||||
|
||||
1. сразу после оформления документа **прихода** необходимо оформлять точно такой же документ **возврата прихода**;
|
||||
2. [вы обязательно забудете о пункте 1](http://murphy-law.net.ru/basics.html);
|
||||
3. пп. 1 и 2 в любом случае скажутся на ваших финансовых отчётах;
|
||||
4. вся ответственность за пп. 1-3 и последствия ложится только на вас.
|
||||
|
||||
## Авторизация на ККТ
|
||||
|
||||
Перед первым запросом на ККТ происходит аутентификация на сервере по логину и паролю. В ответ приходит авторизационный
|
||||
токен, срок жизни коего равен **24 часам**. После первой успешной операции возможно получить этот токен следующим
|
||||
образом:
|
||||
|
||||
```php
|
||||
$kkt->getToken(); // вернёт строку длиной 128 символа
|
||||
```
|
||||
|
||||
Этот токен можно сохранить и переиспользовать в течение всего срока его жизни, но далее следует получить новый токен.
|
||||
|
||||
Ранее полученный токен следует указывать до отправки запросов следующим образом:
|
||||
|
||||
```php
|
||||
$kkt->setToken($token_string);
|
||||
```
|
||||
|
||||
Если токен был установлен перед выполнением операции, то при выполнении операции будет использоваться именно он. Если
|
||||
операция завершится ошибочно из-за истёкшего токена, следует повторить операцию без использования метода `setToken()`,
|
||||
либо обнулив его следующим образом:
|
||||
|
||||
```php
|
||||
$kkt->setToken(null);
|
||||
```
|
||||
|
||||
Тогда будет получен новый токен.
|
||||
|
||||
## Регистрация документа
|
||||
|
||||
Для регистрации документа **прихода** необходимо вызвать метод `sell()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->sell($document);
|
||||
$result2 = $receipt->sell($kkt);
|
||||
```
|
||||
|
||||
Для регистрации документа **возврата прихода** необходимо вызвать метод `sellRefund()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->sellRefund($document);
|
||||
$result2 = $receipt->sellRefund($kkt);
|
||||
```
|
||||
|
||||
Для регистрации документа **расхода** необходимо вызвать метод `buy()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->buy($document);
|
||||
$result2 = $receipt->buy($kkt);
|
||||
```
|
||||
|
||||
Для регистрации документа **возврата расхода** необходимо вызвать метод `buyRefund()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->buyRefund($document);
|
||||
$result2 = $receipt->buyRefund($kkt);
|
||||
```
|
||||
|
||||
Для регистрации документа **коррекции прихода** необходимо вызвать метод `sellCorrection()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->sellCorrect($document);
|
||||
$result2 = $correction->sellCorrect($kkt);
|
||||
```
|
||||
|
||||
Для регистрации документа **коррекции расхода** необходимо вызвать метод `buyCorrection()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->buyCorrect($document);
|
||||
$result2 = $correction->buyCorrect($kkt);
|
||||
```
|
||||
|
||||
### Собственный идентификатор документа (`external_id`)
|
||||
|
||||
Каждый документ, переданный на ККТ для регистрации, всегда имеет свой идентификатор, абсолютно уникальный среди всех
|
||||
документов когда-либо регистрировавшихся на ККТ, даже если при регистрации были ошибки. По умолчанию это UUID версии 4.
|
||||
|
||||
Чтобы использовать собственный идентификатор, следует передать нужное строковое значение вторым параметром в любой из
|
||||
шести описанных выше методов, например:
|
||||
|
||||
```php
|
||||
$result = $kkt->sellRefund($document, 'order_' . $order->id);
|
||||
```
|
||||
|
||||
Если `external_id` не указан явно или имеет пустое значение, то будет сгенерирован новый UUID. Узнать его можно будет
|
||||
только в ответе от ККТ после регистрации документа в очереди на фискализацию.
|
||||
|
||||
### Передача `callback_url`
|
||||
|
||||
Перед регистрацией документа можно указать `callback_url`. АТОЛ отправит на указанный URL результат регистрации. По
|
||||
этому адресу должен располагаться ваш собственный обработчик статуса фискализации.
|
||||
|
||||
```php
|
||||
$kkt->setCallbackUrl('http://example.com/process-kkt-result');
|
||||
$kkt->getCallbackUrl();
|
||||
```
|
||||
|
||||
## Проверка статуса документа
|
||||
|
||||
Если перед отправкой документа на регистрацию был задан `callback_url` через метод `setCallbackUrl()`, то ответ придёт
|
||||
на указанный адрес автоматически, как только документ обработается на стороне ККТ. Ответ может быть как об успешной
|
||||
регистрации, так и ошибочной.
|
||||
|
||||
В любом случае, вам доступны два метода, с помощью которых вы можете проверять статус документа самостоятельно:
|
||||
|
||||
```php
|
||||
$kkt->getDocumentStatus(); // делает единичный запрос
|
||||
$kkt->pollDocumentStatus(); // делает запросы до получения конечного статуса (не-wait)
|
||||
```
|
||||
|
||||
Эти методы принимают на вход `uuid` кода регистрации. Этот UUID нужно взять из ответа, полученного при отправке
|
||||
документа на регистрацию:
|
||||
|
||||
```php
|
||||
$sell_result = $kkt->sell($document);
|
||||
$status = $kkt->pollDocumentStatus($sell_result->uuid);
|
||||
```
|
||||
|
||||
Метод `pollDocumentStatus()` многократно опрашивает ККТ на предмет состояния документа. Метод может принимать до трёх
|
||||
параметров:
|
||||
|
||||
* uuid;
|
||||
* количество попыток (по умолчанию — 5);
|
||||
* время между попытками в секундах (по умолчанию — 1).
|
||||
|
||||
```php
|
||||
// Проверять статус 10 раз на протяжении 20 секунд — каждые две секунды
|
||||
$kkt->pollDocumentStatus($sell_result->uuid, 10, 20);
|
||||
```
|
||||
|
||||
Учитывайте, что метод вернёт результат как только сменится статус регистрации на успешный `done` или ошибочный `error`.
|
||||
|
||||
Использовать его лучше сразу после отправки документа на регистрацию (как в примере выше).
|
||||
|
||||
> Как правило, фискализация одного документа занимает 4-6 секунд с учётом регистрации.
|
||||
|
||||
Метод `getDocumentStatus()` принимает на вход только `uuid` и запрашивает состояние документа лишь единожды.
|
||||
Использовать его целесообразнее в те моменты, когда нет необходимости знать успех регистрации сразу после отправки
|
||||
документа.
|
||||
|
||||
> Обратите внимание, что АТОЛ позволяет получать статус документа в течение 32 суток с момента его регистрации.
|
||||
|
||||
---
|
||||
|
||||
Читай также: [Обработка ответа API](response.md)
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
202
docs/items.md
202
docs/items.md
@@ -1,202 +0,0 @@
|
||||
# Работа с предметами расчёта
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
## Один объект
|
||||
|
||||
Объект предмета расчёта инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$vat = new AtolOnline\Entities\Item();
|
||||
```
|
||||
|
||||
У объекта предмета расчёта должны быть указаны все следующие обязательные атрибуты:
|
||||
* наименование (тег ФФД - 1030);
|
||||
* цена (тег ФФД - 1079);
|
||||
* количество, вес (тег ФФД - 1023).
|
||||
|
||||
У объекта предмета расчёта также могут быть указаны следующие необязательные атрибуты:
|
||||
* единица измерения количества (тег ФФД - 1197);
|
||||
* признак способа оплаты (тег ФФД - 1214) - перечислены в классе `AtolOnline\Constants\PaymentMethods`;
|
||||
* признак предмета расчёта (тег ФФД - 1212) - перечислены в классе `AtolOnline\Constants\PaymentObjects`;
|
||||
* [ставка НДС](/docs/vats.md);
|
||||
* дополнительный реквизит (тег ФФД - 1191).
|
||||
|
||||
Установить многие (но не все) атрибуты можно следующими способами:
|
||||
|
||||
```php
|
||||
use AtolOnline\{
|
||||
Constants\PaymentMethods,
|
||||
Constants\PaymentObjects,
|
||||
Constants\VatTypes,
|
||||
Entities\Item
|
||||
};
|
||||
|
||||
// 1 способ - через конструктор
|
||||
$item = new Item(
|
||||
'Банан', // наименование
|
||||
100, // цена
|
||||
1, // количество, вес
|
||||
'кг', // единица измерения
|
||||
VatTypes::VAT20, // ставка НДС
|
||||
PaymentObjects::SERVICE, // признак предмета расчёта
|
||||
PaymentMethods::FULL_PAYMENT // признак способа расчёта
|
||||
);
|
||||
|
||||
// 2 способ - через сеттеры
|
||||
$item = new Item();
|
||||
$item->setName('Банан');
|
||||
$item->setPrice(100);
|
||||
$item->setQuantity(2.41);
|
||||
//$item->setQuantity(2.41, 'кг');
|
||||
$item->setMeasurementUnit('кг');
|
||||
$item->setVatType(VatTypes::VAT20);
|
||||
$item->setPaymentObject(PaymentObjects::COMMODITY);
|
||||
$item->setPaymentMethod(PaymentMethods::FULL_PAYMENT);
|
||||
```
|
||||
|
||||
Метод `setName()` проверяет входную строку на длину (до 128 символов).
|
||||
Выбрасывает исключение `AtolNameTooLongException` (если слишком длинное наименование).
|
||||
|
||||
Метод `setPrice()` проверяет аргумент на величину (до 42949672.95) и пересчитывает общую стоимость.
|
||||
Выбрасывает исключение `AtolPriceTooHighException` (если цена слишком высока).
|
||||
|
||||
Метод `setMeasurementUnit()` проверяет входную строку на длину (до 16 символов).
|
||||
Выбрасывает исключение `AtolUnitTooLongException` (если слишком длинная строка единицы измерения).
|
||||
|
||||
Метод `setQuantity()` проверяет первый аргумент на величину (до 99999.999) и пересчитывает общую стоимость.
|
||||
Выбрасывает исключения:
|
||||
* `AtolQuantityTooHighException` (если количество слишком велико);
|
||||
* `AtolPriceTooHighException` (если общая стоимость слишком велика).
|
||||
|
||||
Также вторым аргументом может принимать единицу измерения количества.
|
||||
В этом случае дополнительно работает сеттер `setMeasurementUnit()`.
|
||||
|
||||
Метод `setVatType()` задаёт тип ставки НДС, пересчитывает размер налога и общую стоимость.
|
||||
Выбрасывает исключение `AtolPriceTooHighException` (если цена слишком высока).
|
||||
Может принимать `null` для удаления налога.
|
||||
|
||||
Дополнительный реквизит устанавливается отдельным методом `setUserData()`:
|
||||
|
||||
```php
|
||||
$item->setUserData('some data');
|
||||
```
|
||||
|
||||
Он проверяет строку на длину (до 64 символов).
|
||||
Выбрасывает исключение `AtolUserdataTooLongException` (если слишком длинный дополнительный реквизит).
|
||||
|
||||
Для установки признака предмета расчёта существует метод `setPaymentObject()`.
|
||||
На вход следует передавать одной из значений, перечисленных в классе `AtolOnline\Constants\PaymentObjects`.
|
||||
|
||||
```php
|
||||
$item->setPaymentObject(AtolOnline\Constants\PaymentObjects::JOB);
|
||||
```
|
||||
|
||||
Для установки признака способа оплаты существует метод `setPaymentMethod()`.
|
||||
На вход следует передавать одной из значений, перечисленных в классе `AtolOnline\Constants\PaymentMethods`.
|
||||
|
||||
```php
|
||||
$item->setPaymentMethod(AtolOnline\Constants\PaymentMethods::FULL_PAYMENT);
|
||||
```
|
||||
|
||||
Для получения заданных значений атрибутов реализованы соответствующие геттеры:
|
||||
|
||||
```php
|
||||
$item->getName();
|
||||
$item->getPrice();
|
||||
$item->getQuantity();
|
||||
$item->getMeasurementUnit();
|
||||
$item->getPaymentMethod();
|
||||
$item->getPaymentObject();
|
||||
$item->getVat(); // возвращает объект ставки НДС либо null
|
||||
$item->getUserData();
|
||||
```
|
||||
|
||||
Для пересчёта общей стоимости и размера налога существует метод `calcSum()`.
|
||||
|
||||
```php
|
||||
$item->calcSum();
|
||||
```
|
||||
|
||||
Этот метод отрабатывает при вызове `setPrice()`, `setQuantity()` и `setVatType()`.
|
||||
Выбрасывает исключение `AtolPriceTooHighException` (если общая сумма слишком высока).
|
||||
|
||||
Получить уже расчитанную общую сумму можно простым геттером:
|
||||
|
||||
```php
|
||||
$item->getSum();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $item;
|
||||
$json_string = (string)$item;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $item->jsonSerialize();
|
||||
```
|
||||
|
||||
<a name="array"></a>
|
||||
## Массив объектов предметов расчёта
|
||||
|
||||
> Максимальное количество объектов в массиве - 100.
|
||||
|
||||
Массив инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$item_array = new AtolOnline\Entities\ItemArray();
|
||||
```
|
||||
|
||||
Чтобы задать содержимое массива, используйте метод `set()`:
|
||||
|
||||
```php
|
||||
$item_array->set([
|
||||
$item_object1,
|
||||
$item_object2
|
||||
]);
|
||||
```
|
||||
|
||||
Очистить его можно передачей в сеттер пустого массива:
|
||||
|
||||
```php
|
||||
$item_array->set([]);
|
||||
```
|
||||
|
||||
Чтобы добавить объект к существующим элементам массива, используйте метод `add()`:
|
||||
|
||||
```php
|
||||
$item = new AtolOnline\Entities\Item('Банан', 100, 1);
|
||||
$item_array->add($item);
|
||||
```
|
||||
|
||||
Методы `set()` и `add()` проверяют количество элементов в массиве перед его обновлением.
|
||||
Выбрасывают исключение `AtolTooManyItemsException` (если в массиве уже максимальное количество объектов).
|
||||
|
||||
Чтобы получить содержимое массива, используйте метод `get()`:
|
||||
|
||||
```php
|
||||
$item_array->get();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $item_array;
|
||||
$json_string = (string)$item_array;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $item_array->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
317
docs/kkt.md
317
docs/kkt.md
@@ -1,317 +0,0 @@
|
||||
# Работа с ККТ
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
## Доступ к ККТ
|
||||
|
||||
Для работы с облачной ККТ необходимы следующие параметры:
|
||||
|
||||
* логин;
|
||||
* пароль;
|
||||
* код группы.
|
||||
|
||||
Чтоы получить их, нужно:
|
||||
|
||||
1. авторизоваться в личном кабинете [online.atol.ru](https://online.atol.ru/lk/Account/Login);
|
||||
2. на странице [Мои компании](https://online.atol.ru/lk/Company/List) нажать кнопку **Настройки интегратора**.
|
||||
Скачается XML-файл с нужными настройками.
|
||||
|
||||
Также для работы потребуются:
|
||||
|
||||
* ИНН продавца;
|
||||
* URL места расчёта (ссылка на ваш интернет-сервис).
|
||||
|
||||
## Использование
|
||||
|
||||
Объект ККТ инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$kkt = new AtolOnline\Api\Kkt();
|
||||
```
|
||||
|
||||
## Настройка ККТ
|
||||
|
||||
Для работы с облачной ККТ необходимы следующие параметры:
|
||||
* логин кассы;
|
||||
* пароль кассы;
|
||||
* код группы кассы;
|
||||
|
||||
Чтоб получить их, нужно:
|
||||
1. авторизоваться на [online.atol.ru](https://online.atol.ru/lk/Account/Login);
|
||||
2. на странице [Мои компании](https://online.atol.ru/lk/Company/List) нажать кнопку **Настройки интегратора**.
|
||||
Скачается XML-файл с нужными настройками.
|
||||
|
||||
Установить эти параметры можно двумя путями:
|
||||
|
||||
```php
|
||||
// 1 способ - через конструктор
|
||||
$kkt = new AtolOnline\Api\Kkt($group, $login, $password);
|
||||
|
||||
// 2 способ - через сеттеры
|
||||
$kkt = (new AtolOnline\Api\Kkt())
|
||||
->setLogin($login)
|
||||
->setGroup($group)
|
||||
->setPassword($password);
|
||||
```
|
||||
|
||||
Получить заданные параметры можно через соответствующие геттеры:
|
||||
|
||||
```php
|
||||
$kkt->getLogin();
|
||||
$kkt->getPassword();
|
||||
$kkt->getGroup();
|
||||
```
|
||||
|
||||
Также для работы потребуются:
|
||||
* ИНН продавца;
|
||||
* URL места расчёта (ссылка на ваш интернет-сервис).
|
||||
|
||||
Эти параметры нужно задать [объекту компании](/docs/company.md), который будет передаваться в документах через эту ККТ.
|
||||
|
||||
<a name='testmode'></a>
|
||||
## Тестовый режим
|
||||
|
||||
На самом деле, в АТОЛ Онлайн нет понятия *тестовая операция* или чего-то в этом духе.
|
||||
АТОЛ предоставляет нам отдельную тестовую среду (ККТ).
|
||||
[Её настройки](https://online.atol.ru/files/ffd/test_sreda.txt) уже указаны в коде библиотеки.
|
||||
*Под тестовым режимом работы подразумевается использование другой (тестовой) ККТ.*
|
||||
|
||||
При включенном тестовом режиме:
|
||||
* меняется логин, пароль и группа (для обращения на тестовую ККТ)
|
||||
* между авторизацией и операцией над документом, в `Company` документа переопределяется ИНН, СНО и адрес места
|
||||
расчётов на те, что указаны в [параметрах тестовой среды](https://online.atol.ru/files/ffd/test_sreda.txt).
|
||||
|
||||
В библиотеке есть переключатель настроек ККТ.
|
||||
С его помощью можете поменять вашу боевую ККТ на тестовую и наоборот.
|
||||
Это можно сделать одним из следующих способов:
|
||||
|
||||
```php
|
||||
// включить в любом месте кода:
|
||||
$kkt->setTestMode();
|
||||
$kkt->setTestMode(true);
|
||||
$kkt->setTestMode(false); // выключить
|
||||
```
|
||||
|
||||
> Если вы включили тестовый режим (как показано выше), то используются именно эта ККТ, а не ваша.
|
||||
> После выключения тестового режима настройки доступа к ККТ меняются на ваши (используется уже ваша ККТ).
|
||||
|
||||
Для включения тестового режима необязательно задавать параметры боевой ККТ.
|
||||
|
||||
Если по каким-то причинам у вас не получится использовать тестовый режим, вы можете проводить свои тесты в боевом
|
||||
режиме (на собственной ККТ).
|
||||
В этом случае важно понимать следующее:
|
||||
1. сразу после оформления документа **прихода** необходимо оформлять точно такой же документ **возврата прихода**;
|
||||
2. [вы обязательно забудете о пункте 1](http://murphy-law.net.ru/basics.html);
|
||||
3. пп. 1 и 2 в любом случае скажутся на ваших финансовых отчётах;
|
||||
4. вся ответственность за пп. 1-3 и последствия ложится только на вас.
|
||||
|
||||
## Авторизация на ККТ
|
||||
|
||||
Перед первым запросом на ККТ происходит аутентификация на сервере по логину и паролю.
|
||||
В ответ приходит авторизационный токен, срок жизни коего равен **24 часам**.
|
||||
После первой успешной операции возможно получить этот токен следующим образом:
|
||||
|
||||
```php
|
||||
$kkt->getAuthToken(); // вернёт строку длиной 128 символа
|
||||
```
|
||||
|
||||
Этот токен можно сохранить и переиспользовать в течение всего срока его жизни.
|
||||
Спустя это время следует получить новый токен.
|
||||
|
||||
Для дальнейшего использования однажды полученный токен следует указывать следующим образом:
|
||||
|
||||
```php
|
||||
$kkt->setAuthToken($token_string);
|
||||
```
|
||||
|
||||
Если токен был установлен перед выполнением операции, то при выполнении операции будет использоваться именно он, а новый
|
||||
запрашиваться не будет. Если операция завершится ошибочно из-за истёкшего токена, следует повторить операцию без
|
||||
использования метода `setAuthToken()`, либо обнулив его следующим образом:
|
||||
|
||||
```php
|
||||
$kkt->setAuthToken(null);
|
||||
```
|
||||
|
||||
## Регистрация документа
|
||||
|
||||
Для регистрации документа **прихода** необходимо вызвать метод `sell()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->sell($document);
|
||||
```
|
||||
|
||||
Для регистрации документа **возврата прихода** необходимо вызвать метод `sellRefund()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->sellRefund($document);
|
||||
```
|
||||
|
||||
Для регистрации документа **расхода** необходимо вызвать метод `buy()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->buy($document);
|
||||
```
|
||||
|
||||
Для регистрации документа **возврата расхода** необходимо вызвать метод `buyRefund()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->buyRefund($document);
|
||||
```
|
||||
|
||||
Для операций, перечисленных выше, документы не должны содержать [данных коррекции](/docs/documents.md#correction).
|
||||
Тогда как для операций коррекции, которые описаны ниже, эти данные должны присутствовать.
|
||||
|
||||
Для регистрации документа **коррекции прихода** необходимо вызвать метод `sellCorrection()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->sellCorrection($document);
|
||||
```
|
||||
|
||||
Для регистрации документа **коррекции расхода** необходимо вызвать метод `buyCorrection()`:
|
||||
|
||||
```php
|
||||
$result = $kkt->buyCorrection($document);
|
||||
```
|
||||
|
||||
Любой из перечисленных выше шести методов может выбросить исключение `AtolAuthFailedException` при ошибке
|
||||
аутентификации или авторизации.
|
||||
|
||||
### Собственный идентификатор документа
|
||||
|
||||
Каждый документ, переданный на ККТ для регистрации, всегда имеет свой идентификатор, абсолютно уникальный среди всех
|
||||
документов когда-либо регистрировавшихся на ККТ, даже если при регистрации были ошибки.
|
||||
По умолчанию это UUID версии 4.
|
||||
|
||||
Чтобы использовать собственный идентификатор, следует передать нужное строковое значение вторым параметром в любой из
|
||||
шести описанных выше методов, например:
|
||||
|
||||
```php
|
||||
$kkt->sell($document, $my_unique_id);
|
||||
$kkt->sellRefund($document, $my_unique_id);
|
||||
$kkt->buy($document, $my_unique_id);
|
||||
$kkt->buyRefund($document, $my_unique_id);
|
||||
$kkt->sellCorrection($document, $my_unique_id);
|
||||
$kkt->buyCorrection($document, $my_unique_id);
|
||||
```
|
||||
|
||||
Если `$my_unique_id` равен `null` или пустой строке, то будет сгенерирован новый UUID.
|
||||
Узнать его можно будет только в ответе от ККТ.
|
||||
|
||||
### Передача callback_url
|
||||
|
||||
Перед регистрацией документа можно указать `callback_url`.
|
||||
АТОЛ отправит на указанный URL результат регистрации.
|
||||
По этому адресу должен располагаться код, который будет обрабатывать этот результат.
|
||||
|
||||
```php
|
||||
$kkt->setCallbackUrl('http://example.com/process-kkt-result');
|
||||
$kkt->getCallbackUrl();
|
||||
```
|
||||
|
||||
Метод `setCallbackUrl()` проверяет входную строку на длину (до 256 символов) и валидность формата url по
|
||||
регулярному выражению:
|
||||
|
||||
```
|
||||
^http(s?)\:\/\/[0-9a-zA-Zа-яА-Я]([-.\w]*[0-9a-zA-Zа-яА-Я])*(:(0-9)*)*(\/?)([a-zAZ0-9а-яА-Я\-\.\?\,\'\/\\\+&=%$#_]*)?$
|
||||
```
|
||||
|
||||
Выбрасывает исключения:
|
||||
* `AtolCallbackUrlTooLongException` (если слишком длинный url);
|
||||
* `AtolInvalidCallbackUrlException` (если url невалиден).
|
||||
|
||||
## Обработка результата регистрации
|
||||
|
||||
Методы `sell()`, `sellRefund()`, `sellCorrection()`, `buy()`, `buyRefund()` и `buyCorrection()` возвращают объект `AtolOnline\Api\KktResponse`.
|
||||
|
||||
Этот же объект можно получить через геттер `getLastResponse()`.
|
||||
|
||||
Этот объект содержит в себе HTTP-код ответа, массив заголовков и JSON-декодированные данные тела ответа.
|
||||
|
||||
```php
|
||||
$result = $kkt->getLastResponse(); // вернёт последний ответ от API
|
||||
$headers = $result->getHeaders(); // вернёт заголовки
|
||||
$code = $result->getCode(); // вернёт код ответа
|
||||
$body = $result->getContent(); // вернёт JSON-декодированное тело ответа
|
||||
```
|
||||
|
||||
Обращаться к полям JSON-декодированного объекта можно опуская вызов метода `getContent()` таким образом:
|
||||
|
||||
```php
|
||||
// вернёт значение поля uuid
|
||||
$uuid = $result->getContent()->uuid;
|
||||
$uuid = $result->uuid;
|
||||
// вернёт текст ошибки
|
||||
$err_text = $result->getContent()->error->text;
|
||||
$err_text = $result->error->text;
|
||||
```
|
||||
|
||||
Проверка корректности ответа (отсутствия ошибок) работает через метод `isValid()`:
|
||||
|
||||
```php
|
||||
$kkt->getLastResponse()->isValid(); // вернёт true, если ошибок нет
|
||||
```
|
||||
|
||||
## Проверка статуса документа
|
||||
|
||||
Если перед отправкой документа на регистрацию был задан callback_url через метод `setCallbackUrl()`, то ответ придёт на указанный адрес автоматически, как только документ обработается на стороне ККТ.
|
||||
Ответ может быть как об успешной регистрации, так и ошибочной.
|
||||
|
||||
В любом случае, вам доступны два метода, с помощью которых вы можете проверять статус документа самостоятельно:
|
||||
|
||||
```php
|
||||
$kkt->getDocumentStatus();
|
||||
$kkt->pollDocumentStatus();
|
||||
```
|
||||
|
||||
Эти методы принимают на вход `uuid` кода регистрации.
|
||||
Этот UUID можно получить из ответа, полученного при отправке документа на регистрацию:
|
||||
|
||||
```php
|
||||
$sell_result = $kkt->sell($document);
|
||||
$kkt->pollDocumentStatus($sell_result->uuid);
|
||||
$kkt->getDocumentStatus($sell_result->uuid);
|
||||
```
|
||||
|
||||
Метод `pollDocumentStatus()` многократно опрашивает ККТ на предмет состояния документа.
|
||||
Метод может принимать до трёх параметров:
|
||||
* uuid;
|
||||
* количество попыток (по умолчанию — 5);
|
||||
* время между попытками в секундах (по умолчанию — 1).
|
||||
|
||||
```php
|
||||
// Проверять статус 10 раз на протяжении 20 секунд — каждые две секунды
|
||||
$kkt->pollDocumentStatus($sell_result->uuid, 10, 20);
|
||||
```
|
||||
|
||||
Учитывайте, что метод вернёт результат как только сменится статус регистрации на успешный или ошибочный.
|
||||
|
||||
Использовать его лучше сразу после отправки документа на регистрацию (как в примере выше).
|
||||
|
||||
> Как правило, полная регистрация одного документа занимает 4-5 секунд.
|
||||
|
||||
Метод `getDocumentStatus()` принимает на вход только `uuid` и запрашивает состояние документа лишь единожды.
|
||||
Использовать его целесообразнее в те моменты, когда нет необходимости знать успех регистрации сразу после отправки документа.
|
||||
|
||||
> Обратите внимание, что АТОЛ позволяет получать статус документа в течение 32 суток с момента его регистрации.
|
||||
|
||||
Методы `pollDocumentStatus()` и `getDocumentStatus()` возвращают объект `AtolOnline\Api\KktResponse`.
|
||||
Оба выбрасывают исключение `AtolUuidValidateException` (если переданная строка UUID невалидна).
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $item;
|
||||
$json_string = (string)$item;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $item->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
@@ -1,6 +1,6 @@
|
||||
# Мониторинг ККТ
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
|
||||
---
|
||||
|
||||
@@ -12,13 +12,13 @@
|
||||
|
||||
```php
|
||||
// можно передать параметры подключения в конструктор
|
||||
$monitor = new AtolOnline\Api\KktMonitor(
|
||||
$monitor = new AtolOnline\Api\Monitor(
|
||||
login: 'mylogin',
|
||||
password: 'qwerty'
|
||||
);
|
||||
|
||||
// можно - отдельными сеттерами
|
||||
$monitor = new AtolOnline\Api\KktMonitor();
|
||||
$monitor = new AtolOnline\Api\Monitor();
|
||||
->setLogin($credentials['login'])
|
||||
->setPassword($credentials['password']);
|
||||
```
|
||||
@@ -30,7 +30,7 @@ $monitor = new AtolOnline\Api\KktMonitor();
|
||||
|
||||
```php
|
||||
// передачей в конструктор `false` первым параметром:
|
||||
$monitor = new AtolOnline\Api\KktMonitor(false, /*...*/);
|
||||
$monitor = new AtolOnline\Api\Monitor(false, /*...*/);
|
||||
|
||||
// или отдельным сеттером
|
||||
$monitor->setTestMode(false);
|
||||
@@ -107,10 +107,12 @@ $kkt = $monitor->getOne($kkts->first()->serialNumber);
|
||||
|
||||
Класс `AtolOnline\Api\KktMonitor` расширяет абстрактный класс `AtolOnline\Api\AtolClient`.
|
||||
|
||||
Это значит, что последний ответ от API АТОЛ всегда сохраняется объектом класса `AtolOnline\Api\KktResponse`. К нему
|
||||
Это значит, что последний ответ от API АТОЛ всегда сохраняется объектом класса `AtolOnline\Api\AtolReponse`. К нему
|
||||
можно обратиться через метод `AtolOnline\Api\KktMonitor::getResponse()`, независимо от того, что возвращают другие
|
||||
методы монитора.
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
Читай также: [Обработка ответа API](response.md)
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
|
||||
134
docs/payments.md
134
docs/payments.md
@@ -1,134 +0,0 @@
|
||||
# Работа с оплатами
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
## Один объект
|
||||
|
||||
Объект оплаты инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$payment = new AtolOnline\Entities\Payment();
|
||||
```
|
||||
|
||||
У объекта оплаты должны быть указаны все следующие атрибуты:
|
||||
* тип оплаты (теги ФФД: 1031, 1081, 1215, 1216, 1217) - все типы перечислены в классе `AtolOnline\Constants\PaymentTypes` (по умолчанию `ELECTRON`)
|
||||
* сумма оплаты (теги ФФД: 1031, 1081, 1215, 1216, 1217; по умолчанию 0)
|
||||
|
||||
> Все эти атрибуты являются **обязательными**.
|
||||
|
||||
Установить атрибуты можно следующими способами:
|
||||
|
||||
```php
|
||||
// 1 способ - через конструктор
|
||||
$payment = new AtolOnline\Entities\Payment(
|
||||
AtolOnline\Constants\PaymentTypes::OTHER, // тип оплаты
|
||||
123.45 // сумма оплаты
|
||||
);
|
||||
|
||||
// 2 способ - через сеттер
|
||||
$payment = (new AtolOnline\Entities\Payment())
|
||||
->setType(AtolOnline\Constants\PaymentTypes::OTHER) // тип оплаты
|
||||
->setSum(123.45); // сумма оплаты
|
||||
```
|
||||
|
||||
Размер налога высчитывается автоматически из общей суммы.
|
||||
Сумму, от которой нужно расчитать размер налога, можно передать следующими способами:
|
||||
|
||||
```php
|
||||
// 1 способ - через конструктор
|
||||
$payment = new AtolOnline\Entities\Payment(
|
||||
AtolOnline\Constants\PaymentTypes::CASH, // тип оплаты
|
||||
1234.56 // сумма оплаты в рублях
|
||||
);
|
||||
|
||||
// 2 способ - через сеттер
|
||||
$payment = (new AtolOnline\Entities\Payment())
|
||||
->setType(AtolOnline\Constants\PaymentTypes::CASH) // тип оплаты
|
||||
->setSum(1234.56); // сумма оплаты в рублях
|
||||
```
|
||||
|
||||
Получить установленную сумму оплаты в рублях можно через геттер `getSum()`:
|
||||
|
||||
```php
|
||||
var_dump($payment->getSum());
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $payment;
|
||||
$json_string = (string)$payment;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $payment->jsonSerialize();
|
||||
```
|
||||
|
||||
<a name="array"></a>
|
||||
## Массив объектов оплат
|
||||
|
||||
> Максимальное количество объектов в массиве - 10.
|
||||
|
||||
Массив инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$payment_array = new AtolOnline\Entities\PaymentArray();
|
||||
```
|
||||
|
||||
Чтобы задать содержимое массива, используйте метод `set()`:
|
||||
|
||||
```php
|
||||
use AtolOnline\{Constants\PaymentTypes, Entities\Payment};
|
||||
|
||||
$payment_array->set([
|
||||
new Payment(PaymentTypes::ELECTRON, 123),
|
||||
new Payment(PaymentTypes::ELECTRON, 53.2),
|
||||
new Payment(PaymentTypes::ELECTRON, 23.99),
|
||||
new Payment(PaymentTypes::ELECTRON, 11.43)
|
||||
]);
|
||||
```
|
||||
|
||||
Очистить его можно передачей в сеттер пустого массива:
|
||||
|
||||
```php
|
||||
$payment_array->set([]);
|
||||
```
|
||||
|
||||
Чтобы добавить объект к существующим элементам массива, используйте метод `add()`:
|
||||
|
||||
```php
|
||||
use AtolOnline\{Constants\PaymentTypes, Entities\Payment};
|
||||
|
||||
$payment = new Payment(PaymentTypes::PRE_PAID, 20);
|
||||
$payment_array->add($payment);
|
||||
```
|
||||
|
||||
Методы `set()` и `add()` проверяют количество элементов в массиве перед его обновлением.
|
||||
Выбрасывают исключение `AtolTooManyPaymentsException` (если в массиве уже максимальное количество объектов).
|
||||
|
||||
Чтобы получить содержимое массива, используйте метод `get()`:
|
||||
|
||||
```php
|
||||
$payment_array->get();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $payment_array;
|
||||
$json_string = (string)$payment_array;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $payment_array->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
@@ -1,26 +1,42 @@
|
||||
# Документация к библиотеке
|
||||
|
||||
<a id="toc"></a>
|
||||
|
||||
## Содержание
|
||||
|
||||
* [Общий алгоритм](#getstarted)
|
||||
* [Сущность](entity.md)
|
||||
* [Коллекция сущностей](collection.md)
|
||||
* [Мониторинг ККТ](monitoring.md)
|
||||
* [Фискализация документа](fiscalizing.md)
|
||||
* [Обработка ответа API](response.md)
|
||||
|
||||
Если вы нашли опечатку или какое-то несоответствие — делайте pull-request.
|
||||
|
||||
<a id="getstarted"></a>
|
||||
|
||||
## Общий алгоритм
|
||||
|
||||
1. Задать настройки ККТ
|
||||
2. Собрать данные о покупателе
|
||||
3. Собрать данные о продавце
|
||||
4. Собрать данные о предметах расчёта (товары, услуги и пр.)
|
||||
5. Создать документ, добавив в него покупателя, продавца и предметы расчёта
|
||||
6. Отправить документ на регистрацию:
|
||||
6.1. *Необязательно:* задать `callback_url`, на который АТОЛ отправит HTTP POST о состоянии документа.
|
||||
7. Запомнить `uuid` из пришедшего ответа, поскольку он пригодится для последующей проверки статуса фискализации.
|
||||
> Если с документом был передан `callback_url`, то ответ придёт на этот самый URL.
|
||||
Если с документом **НЕ** был передан `callback_url` **либо** callback от АТОЛа не пришёл в течение 300 секунд (5 минут), нужно запрашивать вручную по `uuid`, пришедшему от АТОЛа в ответ на регистрацию документа.
|
||||
8. Проверить состояние документа:
|
||||
8.1. взять `uuid` ответа, полученного на запрос фискализации;
|
||||
8.2. отправить его в запросе состояния документа.
|
||||
1. Создать документ `AtolOnline\Entities\Receipt` или `AtolOnline\Entities\Correction`, добавив в него все необходимые
|
||||
данные
|
||||
2. Отправить документ на регистрацию:
|
||||
2.1. *Необязательно:* при отправке задать `callback_url`, на который АТОЛ отправит HTTP POST о состоянии документа;
|
||||
2.2. *Необязательно:* при отправке задать `external_id`, чтобы присвоить свой уникальный идентификатор документа;
|
||||
3. Запомнить `uuid` из пришедшего ответа, поскольку он пригодится для последующей проверки статуса фискализации.
|
||||
> Если с документом был передан `callback_url`, то ответ придёт на этот самый URL.
|
||||
> Он должен быть обработан вашим сервисом в соответствии с бизнес-процессом.
|
||||
|
||||
> Если с документом **не был** передан `callback_url` **либо** callback от АТОЛа не пришёл в течение 300 секунд
|
||||
> (5 минут), нужно запрашивать вручную по `uuid`, пришедшему от АТОЛа в ответ на регистрацию документа.
|
||||
4. Проверить состояние документа:
|
||||
4.1. взять `uuid` ответа, полученного на запрос фискализации;
|
||||
4.2. отправить его в запросе состояния документа.
|
||||
> Данные о документе можно получить только в течение 32 суток после успешной фискализации.
|
||||
|
||||
В зависимости от специфики бизнеса, в документах можно/нужно передавать также и другую информацию. Подробности в
|
||||
документациях и исходниках.
|
||||
В зависимости от специфики бизнеса, в документах можно/нужно передавать разную информацию. Подробности в документации
|
||||
АТОЛ Онлайн и исходниках библиотеки.
|
||||
|
||||
### Об отправке электронного чека покупателю
|
||||
## Об отправке электронного чека покупателю
|
||||
|
||||
После успешной фискализации документа покупатель автоматически получит уведомление **от ОФД**, который используется в
|
||||
связке с вашей ККТ:
|
||||
@@ -31,19 +47,3 @@
|
||||
* если на стороне ОФД необходима и подключена услуга СМС-информирования (уточняйте подробности о своего ОФД).
|
||||
|
||||
> Если заданы email и телефон, то ОФД отдаёт приоритет email.
|
||||
|
||||
## Подготовка документа
|
||||
|
||||
1. [Работа с клиентами (покупателями)](client.md)
|
||||
2. [Работа с компанией (продавцом)](company.md)
|
||||
3. [Работа с оплатами](payments.md)
|
||||
4. [Работа со ставками НДС](vats.md)
|
||||
5. [Работа с предметами расчёта](items.md)
|
||||
6. [Работа с данными коррекции](correction_info.md)
|
||||
7. [Работа с документами](documents.md)
|
||||
8. [Работа с ККТ](kkt.md)
|
||||
9. [Мониторинг ККТ](monitoring.md)
|
||||
|
||||
---
|
||||
|
||||
Если вы нашли опечатку или какое-то несоответствие — делайте pull-request.
|
||||
|
||||
57
docs/response.md
Normal file
57
docs/response.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Обработка ответа API
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
|
||||
---
|
||||
|
||||
Объект класса `AtolOnline\Api\AtolResponse` возвращается всеми методами, которые обращаются к АТОЛ Онлайн API.
|
||||
|
||||
Поскольку классы `AtolOnline\Api\Fiscalizer` и `AtolOnline\Api\KktMonitor` наследуются от
|
||||
абстрактного `AtolOnline\Api\AtolClient`, они оба предоставляют метод `getLastReponse()` для возврата последнего
|
||||
полученного ответа от API.
|
||||
|
||||
Таким образом, а общем случае необязательно сразу сохранять ответ в переменную:
|
||||
|
||||
```php
|
||||
$response = $kkt->sell($receipt);
|
||||
```
|
||||
|
||||
Достаточно обратиться к нему позднее:
|
||||
|
||||
```php
|
||||
$kkt->sell($receipt);
|
||||
// ...
|
||||
$response = $kkt->getLastResponse();
|
||||
```
|
||||
|
||||
Однако, при сложной логике и многократных запросах следует пользоваться этим с умом и осторожностью.
|
||||
|
||||
Объект `AtolResponse` содержит в себе HTTP-код ответа, массив заголовков и JSON-декодированные данные тела ответа.
|
||||
|
||||
```php
|
||||
$headers = $response->getHeaders(); // вернёт заголовки
|
||||
$code = $response->getCode(); // вернёт код ответа
|
||||
$body = $response->getContent(); // вернёт JSON-декодированный объект тела ответа
|
||||
```
|
||||
|
||||
Обращаться к полям тела ответа можно опуская вызов метода `getContent()`:
|
||||
|
||||
```php
|
||||
// вернёт значение поля uuid
|
||||
$uuid = $response->getContent()->uuid;
|
||||
$uuid = $response->uuid;
|
||||
|
||||
// вернёт текст ошибки
|
||||
$err_text = $response->getContent()->error->text;
|
||||
$err_text = $response->error->text;
|
||||
```
|
||||
|
||||
Проверка успешности операции доступна через метод `isSuccessful()`:
|
||||
|
||||
```php
|
||||
$response->isSuccessful(); // вернёт true, если ошибок нет
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md#toc)
|
||||
128
docs/vats.md
128
docs/vats.md
@@ -1,128 +0,0 @@
|
||||
# Работа со ставками НДС
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
|
||||
---
|
||||
|
||||
## Один объект
|
||||
|
||||
Объект ставки НДС инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
use AtolOnline\Entities\Vat;
|
||||
use AtolOnline\Enums\VatTypes;
|
||||
|
||||
$vat = new Vat(
|
||||
VatTypes::VAT10, // тип ставки
|
||||
123.45 // сумма в рублях, от которой считать ставку
|
||||
);
|
||||
```
|
||||
|
||||
Для типа и суммы имеются отдельные сеттеры:
|
||||
|
||||
```php
|
||||
$vat->setType(VatTypes::VAT20)
|
||||
->setSum(100.15); // 123.45 заменится на 100.15
|
||||
```
|
||||
|
||||
Общую сумму, из которой расчитывается размер налога, можно увеличить, используя метод `addSum()`. Указанная в рублях
|
||||
сумма увеличится на указанные рубли. Для уменьшения суммы следует передать отрицательное число.
|
||||
|
||||
```php
|
||||
$vat->addSum(40) // 100.15 + 40 = 140.15р
|
||||
->addSum(-15); // 140.15 - 15 = 125.15р
|
||||
```
|
||||
|
||||
Получить установленную сумму можно через геттер `getSum()`:
|
||||
|
||||
```php
|
||||
$vat->getSum(); // 125.15р
|
||||
```
|
||||
|
||||
Размер налога по ставке высчитывается из этой общей суммы. Не смотря на то, что геттер и сеттер работают с рублями, **
|
||||
расчёты производятся в копейках**. Сделать это можно через `getCalculated()`:
|
||||
|
||||
```php
|
||||
$vat->getCalculated();
|
||||
// для примера выше это 20% от 125.15р = 25.03р
|
||||
```
|
||||
|
||||
Разберём комплексный пример изменения типа ставки и расчётной суммы:
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительно:
|
||||
|
||||
```php
|
||||
echo $vat;
|
||||
$json_string = (string)$vat;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $vat->jsonSerialize();
|
||||
```
|
||||
|
||||
<a name="array"></a>
|
||||
## Массив объектов ставок НДС
|
||||
|
||||
> Максимальное количество в массиве - 6.
|
||||
|
||||
Массив инициализируется следующим образом:
|
||||
|
||||
```php
|
||||
$vat_array = new AtolOnline\Entities\VatArray();
|
||||
```
|
||||
|
||||
Чтобы задать содержимое массива, используйте метод `set()`:
|
||||
|
||||
```php
|
||||
use AtolOnline\{Constants\VatTypes, Entities\Vat};
|
||||
|
||||
$vat_array->set([
|
||||
new Vat(VatTypes::VAT10, 123),
|
||||
new Vat(VatTypes::VAT110, 53.2),
|
||||
new Vat(VatTypes::VAT20, 23.99),
|
||||
new Vat(VatTypes::VAT120, 11.43)
|
||||
]);
|
||||
```
|
||||
|
||||
Очистить его можно передачей в сеттер пустого массива:
|
||||
|
||||
```php
|
||||
$vat_array->set([]);
|
||||
```
|
||||
|
||||
Чтобы добавить объект к существующим элементам массива, используйте метод `add()`:
|
||||
|
||||
```php
|
||||
use AtolOnline\{Constants\VatTypes, Entities\Vat};
|
||||
|
||||
$vat = new Vat(VatTypes::VAT20, 20);
|
||||
$vat_array->add($vat);
|
||||
```
|
||||
|
||||
Методы `set()` и `add()` проверяют количество элементов в массиве перед его обновлением.
|
||||
Выбрасывают исключение `AtolTooManyVatsException` (если в массиве уже максимальное количество объектов).
|
||||
|
||||
Чтобы получить содержимое массива, используйте метод `get()`:
|
||||
|
||||
```php
|
||||
$vat_array->get();
|
||||
```
|
||||
|
||||
Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
|
||||
|
||||
```php
|
||||
echo $vat_array;
|
||||
$json_string = (string)$vat_array;
|
||||
```
|
||||
|
||||
Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
|
||||
|
||||
```php
|
||||
$json_array = $vat_array->jsonSerialize();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Вернуться к содержанию](readme.md)
|
||||
13
phpunit.xml
13
phpunit.xml
@@ -12,8 +12,17 @@
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true">
|
||||
<testsuites>
|
||||
<testsuite name="All">
|
||||
<directory suffix="Test.php">./tests</directory>
|
||||
<testsuite name="Helpers">
|
||||
<file>tests/AtolOnline/Tests/HelpersTest.php</file>
|
||||
</testsuite>
|
||||
<testsuite name="Entities">
|
||||
<directory>tests/AtolOnline/Tests/Entities</directory>
|
||||
</testsuite>
|
||||
<testsuite name="Collections">
|
||||
<directory>tests/AtolOnline/Tests/Collections</directory>
|
||||
</testsuite>
|
||||
<testsuite name="Api">
|
||||
<directory>tests/AtolOnline/Tests/Api</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
|
||||
|
||||
@@ -11,21 +11,34 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Api;
|
||||
|
||||
use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Exceptions\AuthFailedException,
|
||||
Exceptions\EmptyLoginException,
|
||||
Exceptions\EmptyPasswordException,
|
||||
Exceptions\TooLongLoginException,
|
||||
Exceptions\TooLongPasswordException};
|
||||
use GuzzleHttp\Client;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Exceptions\{
|
||||
AuthFailedException,
|
||||
EmptyLoginException,
|
||||
EmptyPasswordException,
|
||||
TooLongLoginException,
|
||||
TooLongPasswordException};
|
||||
use AtolOnline\TestEnvParams;
|
||||
use GuzzleHttp\{
|
||||
Client,
|
||||
Exception\GuzzleException};
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Класс для подключения АТОЛ Онлайн API
|
||||
*/
|
||||
abstract class AtolClient
|
||||
{
|
||||
/**
|
||||
* @var array Последний запрос к серверу АТОЛ
|
||||
*/
|
||||
protected array $request;
|
||||
|
||||
/**
|
||||
* @var AtolResponse|null Последний ответ сервера АТОЛ
|
||||
*/
|
||||
protected ?AtolResponse $response;
|
||||
|
||||
/**
|
||||
* @var bool Флаг тестового режима
|
||||
*/
|
||||
@@ -51,11 +64,6 @@ abstract class AtolClient
|
||||
*/
|
||||
private ?string $token = null;
|
||||
|
||||
/**
|
||||
* @var KktResponse|null Последний ответ сервера АТОЛ
|
||||
*/
|
||||
private ?KktResponse $response;
|
||||
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
@@ -75,14 +83,36 @@ abstract class AtolClient
|
||||
?string $password = null,
|
||||
array $config = []
|
||||
) {
|
||||
$this->http = new Client(array_merge($config, [
|
||||
'http_errors' => $config['http_errors'] ?? false,
|
||||
]));
|
||||
$this->http = new Client(
|
||||
array_merge($config, [
|
||||
'http_errors' => $config['http_errors'] ?? false,
|
||||
])
|
||||
);
|
||||
$this->setTestMode($test_mode);
|
||||
!is_null($login) && $this->setLogin($login);
|
||||
!is_null($password) && $this->setPassword($password);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает последний запрос к серверу
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getLastRequest(): array
|
||||
{
|
||||
return $this->request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает последний ответ сервера
|
||||
*
|
||||
* @return AtolResponse|null
|
||||
*/
|
||||
public function getLastResponse(): ?AtolResponse
|
||||
{
|
||||
return $this->response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает установленный флаг тестового режима
|
||||
*
|
||||
@@ -127,24 +157,17 @@ abstract class AtolClient
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает последний ответ сервера
|
||||
*
|
||||
* @return KktResponse|null
|
||||
*/
|
||||
public function getResponse(): ?KktResponse
|
||||
{
|
||||
return $this->response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает логин доступа к API
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
#[Pure]
|
||||
public function getLogin(): ?string
|
||||
{
|
||||
return $this->login;
|
||||
return $this->isTestMode()
|
||||
? TestEnvParams::FFD105()['login']
|
||||
: $this->login;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -172,9 +195,12 @@ abstract class AtolClient
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
#[Pure]
|
||||
public function getPassword(): ?string
|
||||
{
|
||||
return $this->password;
|
||||
return $this->isTestMode()
|
||||
? TestEnvParams::FFD105()['password']
|
||||
: $this->password;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -201,6 +227,7 @@ abstract class AtolClient
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
#[Pure]
|
||||
private function getHeaders(): array
|
||||
{
|
||||
$headers['Content-type'] = 'application/json; charset=utf-8';
|
||||
@@ -236,7 +263,7 @@ abstract class AtolClient
|
||||
'login' => $this->getLogin() ?? throw new EmptyLoginException(),
|
||||
'pass' => $this->getPassword() ?? throw new EmptyPasswordException(),
|
||||
]);
|
||||
if (!$result->isValid() || !$result->getContent()->token) {
|
||||
if (!$result->isSuccessful() || !$result->getContent()->token) {
|
||||
throw new AuthFailedException($result);
|
||||
}
|
||||
return $result->getContent()?->token;
|
||||
@@ -249,7 +276,7 @@ abstract class AtolClient
|
||||
* @param string $url URL
|
||||
* @param array|null $data Данные для передачи
|
||||
* @param array|null $options Параметры Guzzle
|
||||
* @return KktResponse
|
||||
* @return AtolResponse
|
||||
* @throws GuzzleException
|
||||
* @see https://guzzle.readthedocs.io/en/latest/request-options.html
|
||||
*/
|
||||
@@ -258,39 +285,32 @@ abstract class AtolClient
|
||||
string $url,
|
||||
?array $data = null,
|
||||
?array $options = null
|
||||
): KktResponse {
|
||||
): AtolResponse {
|
||||
$http_method = strtoupper(trim($http_method));
|
||||
$options['headers'] = array_merge($this->getHeaders(), $options['headers'] ?? []);
|
||||
if ($http_method != 'GET') {
|
||||
$options['json'] = $data;
|
||||
}
|
||||
$http_method != 'GET' && $options['json'] = $data;
|
||||
$this->request = array_merge([
|
||||
'method' => $http_method,
|
||||
'url' => $url,
|
||||
], $options);
|
||||
$response = $this->http->request($http_method, $url, $options);
|
||||
return $this->response = new KktResponse($response);
|
||||
return $this->response = new AtolResponse($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Выполняет авторизацию на сервере АТОЛ
|
||||
* Авторизация выполнится только если неизвестен токен
|
||||
*
|
||||
* Авторизация выолнится только если неизвестен токен
|
||||
*
|
||||
* @param string|null $login
|
||||
* @param string|null $password
|
||||
* @return bool
|
||||
* @throws AuthFailedException
|
||||
* @throws TooLongLoginException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongPasswordException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function auth(?string $login = null, ?string $password = null): bool
|
||||
public function auth(): bool
|
||||
{
|
||||
if (empty($this->getToken())) {
|
||||
$login && $this->setLogin($login);
|
||||
$password && $this->setPassword($password);
|
||||
if ($token = $this->doAuth()) {
|
||||
$this->setToken($token);
|
||||
}
|
||||
if (empty($this->getToken()) && $token = $this->doAuth()) {
|
||||
$this->setToken($token);
|
||||
}
|
||||
return !empty($this->getToken());
|
||||
}
|
||||
|
||||
@@ -7,13 +7,17 @@
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
/** @noinspection PhpMultipleClassDeclarationsInspection */
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Api;
|
||||
|
||||
use JetBrains\PhpStorm\{
|
||||
ArrayShape,
|
||||
Pure};
|
||||
use JsonSerializable;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use stdClass;
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
@@ -22,7 +26,7 @@ use Stringable;
|
||||
* @property mixed $error
|
||||
* @package AtolOnline\Api
|
||||
*/
|
||||
class KktResponse implements JsonSerializable, Stringable
|
||||
final class AtolResponse implements JsonSerializable, Stringable
|
||||
{
|
||||
/**
|
||||
* @var int Код ответа сервера
|
||||
@@ -30,10 +34,10 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
protected int $code;
|
||||
|
||||
/**
|
||||
* @var stdClass|array|null Содержимое ответа сервера
|
||||
* @var object|array|null Содержимое ответа сервера
|
||||
*/
|
||||
protected stdClass|array|null $content;
|
||||
|
||||
protected object|array|null $content;
|
||||
|
||||
/**
|
||||
* @var array Заголовки ответа
|
||||
*/
|
||||
@@ -50,7 +54,7 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
$this->headers = $response->getHeaders();
|
||||
$this->content = json_decode((string)$response->getBody());
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Возвращает заголовки ответа
|
||||
*
|
||||
@@ -60,18 +64,19 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
{
|
||||
return $this->headers;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Возвращает запрошенный параметр из декодированного объекта результата
|
||||
*
|
||||
* @param $name
|
||||
* @return mixed
|
||||
*/
|
||||
#[Pure]
|
||||
public function __get($name): mixed
|
||||
{
|
||||
return $this->getContent()?->$name;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Возвращает код ответа
|
||||
*
|
||||
@@ -81,7 +86,7 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
{
|
||||
return $this->code;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Возвращает объект результата запроса
|
||||
*
|
||||
@@ -91,20 +96,21 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
{
|
||||
return $this->content;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Проверяет успешность запроса по соержимому результата
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isValid(): bool
|
||||
#[Pure]
|
||||
public function isSuccessful(): bool
|
||||
{
|
||||
return !empty($this->getCode())
|
||||
&& !empty($this->getContent())
|
||||
&& empty($this->getContent()->error)
|
||||
&& $this->getCode() < 400;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Возвращает текстовое представление
|
||||
*/
|
||||
@@ -112,10 +118,16 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
{
|
||||
return json_encode($this->jsonSerialize(), JSON_UNESCAPED_UNICODE);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[ArrayShape([
|
||||
'code' => 'int',
|
||||
'headers' => 'array|\string[][]',
|
||||
'body' => 'mixed',
|
||||
]
|
||||
)]
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
return [
|
||||
@@ -124,4 +136,4 @@ class KktResponse implements JsonSerializable, Stringable
|
||||
'body' => $this->content,
|
||||
];
|
||||
}
|
||||
}
|
||||
}
|
||||
378
src/Api/Fiscalizer.php
Normal file
378
src/Api/Fiscalizer.php
Normal file
@@ -0,0 +1,378 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Api;
|
||||
|
||||
use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
TestEnvParams};
|
||||
use AtolOnline\Entities\{
|
||||
Correction,
|
||||
Receipt};
|
||||
use AtolOnline\Exceptions\{
|
||||
AuthFailedException,
|
||||
EmptyGroupException,
|
||||
EmptyLoginException,
|
||||
EmptyPasswordException,
|
||||
InvalidCallbackUrlException,
|
||||
InvalidEntityInCollectionException,
|
||||
InvalidInnLengthException,
|
||||
InvalidPaymentAddressException,
|
||||
InvalidUuidException,
|
||||
TooLongCallbackUrlException,
|
||||
TooLongLoginException,
|
||||
TooLongPasswordException,
|
||||
TooLongPaymentAddressException};
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
use Ramsey\Uuid\Uuid;
|
||||
|
||||
/**
|
||||
* Класс фискализатора для регистрации документов на ККТ
|
||||
*/
|
||||
final class Fiscalizer extends AtolClient
|
||||
{
|
||||
/**
|
||||
* @var string|null Группа ККТ
|
||||
*/
|
||||
private ?string $group = null;
|
||||
|
||||
/**
|
||||
* @var string|null URL для приёма POST-запроса от API АТОЛ с результатом регистрации документа
|
||||
*/
|
||||
private ?string $callback_url = null;
|
||||
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
* @param bool $test_mode
|
||||
* @param string|null $login
|
||||
* @param string|null $password
|
||||
* @param string|null $group
|
||||
* @param array $config
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongLoginException
|
||||
* @throws TooLongPasswordException
|
||||
* @throws EmptyGroupException
|
||||
* @see https://guzzle.readthedocs.io/en/latest/request-options.html
|
||||
*/
|
||||
public function __construct(
|
||||
bool $test_mode = true,
|
||||
?string $login = null,
|
||||
?string $password = null,
|
||||
?string $group = null,
|
||||
array $config = []
|
||||
) {
|
||||
parent::__construct($test_mode, $login, $password, $config);
|
||||
!is_null($group) && $this->setGroup($group);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает группу доступа к ККТ в соответствии с флагом тестового режима
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
#[Pure]
|
||||
public function getGroup(): ?string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
? TestEnvParams::FFD105()['group']
|
||||
: $this->group;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает группу доступа к ККТ
|
||||
*
|
||||
* @param string $group
|
||||
* @return $this
|
||||
* @throws EmptyGroupException
|
||||
*/
|
||||
public function setGroup(string $group): self
|
||||
{
|
||||
// критерии к длине строки не описаны ни в схеме, ни в документации
|
||||
empty($group = trim($group)) && throw new EmptyGroupException();
|
||||
$this->group = $group;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает URL для приёма колбеков
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getCallbackUrl(): ?string
|
||||
{
|
||||
return $this->callback_url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает URL для приёма колбеков
|
||||
*
|
||||
* @param string|null $url
|
||||
* @return $this
|
||||
* @throws TooLongCallbackUrlException
|
||||
* @throws InvalidCallbackUrlException
|
||||
*/
|
||||
public function setCallbackUrl(?string $url = null): self
|
||||
{
|
||||
$url = trim((string)$url);
|
||||
if (mb_strlen($url) > Constraints::MAX_LENGTH_CALLBACK_URL) {
|
||||
throw new TooLongCallbackUrlException($url);
|
||||
} elseif (!empty($url) && !preg_match(Constraints::PATTERN_CALLBACK_URL, $url)) {
|
||||
throw new InvalidCallbackUrlException();
|
||||
}
|
||||
$this->callback_url = $url ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ прихода
|
||||
*
|
||||
* @param Receipt $receipt Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function sell(Receipt $receipt, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $this->registerDocument('sell', $receipt, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ возврата прихода
|
||||
*
|
||||
* @param Receipt $receipt Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function sellRefund(Receipt $receipt, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $this->registerDocument('sell_refund', $receipt, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ коррекции прихода
|
||||
*
|
||||
* @param Correction $correction Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function sellCorrect(Correction $correction, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $this->registerDocument('sell_correction', $correction, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ расхода
|
||||
*
|
||||
* @param Receipt $receipt Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function buy(Receipt $receipt, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $this->registerDocument('buy', $receipt, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ возврата расхода
|
||||
*
|
||||
* @param Receipt $receipt Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function buyRefund(Receipt $receipt, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $this->registerDocument('buy_refund', $receipt, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ коррекции расхода
|
||||
*
|
||||
* @param Correction $correction Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function buyCorrect(Correction $correction, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $this->registerDocument('buy_correction', $correction, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет статус чека на ККТ один раз
|
||||
*
|
||||
* @param string $uuid UUID регистрации
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidUuidException
|
||||
*/
|
||||
public function getDocumentStatus(string $uuid): ?AtolResponse
|
||||
{
|
||||
!Uuid::isValid($uuid = trim($uuid)) && throw new InvalidUuidException($uuid);
|
||||
return $this->auth()
|
||||
? $this->sendRequest('GET', $this->getFullUrl('report/' . $uuid))
|
||||
: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет статус чека на ККТ нужное количество раз с указанным интервалом.
|
||||
* Вернёт результат как только при очередной проверке сменится статус регистрации документа.
|
||||
*
|
||||
* @param string $uuid UUID регистрации
|
||||
* @param int $retry_count Количество попыток
|
||||
* @param int $timeout Таймаут в секундах между попытками
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidUuidException
|
||||
*/
|
||||
public function pollDocumentStatus(string $uuid, int $retry_count = 5, int $timeout = 1): ?AtolResponse
|
||||
{
|
||||
$try = 0;
|
||||
do {
|
||||
$response = $this->getDocumentStatus($uuid);
|
||||
if ($response->isSuccessful() && $response->getContent()->status == 'done') {
|
||||
break;
|
||||
} else {
|
||||
sleep($timeout);
|
||||
}
|
||||
++$try;
|
||||
} while ($try < $retry_count);
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Отправляет документ на регистрацию
|
||||
*
|
||||
* @param string $api_method Метод API
|
||||
* @param Receipt|Correction $document Документ
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
protected function registerDocument(
|
||||
string $api_method,
|
||||
Receipt|Correction $document,
|
||||
?string $external_id = null
|
||||
): ?AtolResponse {
|
||||
$this->isTestMode() && $document->getCompany()
|
||||
->setInn(TestEnvParams::FFD105()['inn'])
|
||||
->setPaymentAddress(TestEnvParams::FFD105()['payment_address']);
|
||||
$this->isTestMode() && $document instanceof Receipt
|
||||
&& $document->getClient()->setInn(TestEnvParams::FFD105()['inn']);
|
||||
$this->getCallbackUrl() && $data['service'] = ['callback_url' => $this->getCallbackUrl()];
|
||||
return $this->auth()
|
||||
? $this->sendRequest(
|
||||
'POST',
|
||||
$this->getFullUrl($api_method),
|
||||
array_merge($data ?? [], [
|
||||
'timestamp' => date('d.m.Y H:i:s'),
|
||||
'external_id' => $external_id ?: Uuid::uuid4()->toString(),
|
||||
$document::DOC_TYPE => $document->jsonSerialize(),
|
||||
])
|
||||
)
|
||||
: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[Pure]
|
||||
protected function getAuthEndpoint(): string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
? 'https://testonline.atol.ru/possystem/v4/getToken'
|
||||
: 'https://online.atol.ru/possystem/v4/getToken';
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[Pure]
|
||||
protected function getMainEndpoint(): string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
? 'https://testonline.atol.ru/possystem/v4/'
|
||||
: 'https://online.atol.ru/possystem/v4/';
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает полный URL метода API
|
||||
*
|
||||
* @param string $api_method
|
||||
* @return string
|
||||
*/
|
||||
#[Pure]
|
||||
protected function getFullUrl(string $api_method): string
|
||||
{
|
||||
return $this->getMainEndpoint() . $this->getGroup() . '/' . trim($api_method);
|
||||
}
|
||||
}
|
||||
@@ -1,378 +0,0 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Api;
|
||||
|
||||
use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Entities\Company,
|
||||
Entities\Document,
|
||||
Exceptions\AuthFailedException,
|
||||
Exceptions\EmptyCorrectionInfoException,
|
||||
Exceptions\EmptyLoginException,
|
||||
Exceptions\EmptyPasswordException,
|
||||
Exceptions\InvalidCallbackUrlException,
|
||||
Exceptions\InvalidDocumentTypeException,
|
||||
Exceptions\InvalidInnLengthException,
|
||||
Exceptions\InvalidUuidException,
|
||||
Exceptions\TooLongCallbackUrlException,
|
||||
Exceptions\TooLongLoginException,
|
||||
Exceptions\TooLongPasswordException,
|
||||
Exceptions\TooLongPaymentAddressException,
|
||||
Exceptions\TooManyItemsException,
|
||||
Exceptions\TooManyVatsException,
|
||||
TestEnvParams
|
||||
};
|
||||
use Exception;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use Ramsey\Uuid\Uuid;
|
||||
|
||||
/**
|
||||
* Класс для регистрации документов на ККТ
|
||||
*/
|
||||
class KktFiscalizer extends AtolClient
|
||||
{
|
||||
/**
|
||||
* @var string|null Группа ККТ
|
||||
*/
|
||||
private ?string $group = null;
|
||||
|
||||
/**
|
||||
* @var string|null URL для приёма POST-запроса от API АТОЛ с результатом регистрации документа
|
||||
*/
|
||||
private ?string $callback_url = null;
|
||||
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
* @param bool $test_mode
|
||||
* @param string|null $login
|
||||
* @param string|null $password
|
||||
* @param string|null $group
|
||||
* @param array $config
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongLoginException
|
||||
* @throws TooLongPasswordException
|
||||
* @see https://guzzle.readthedocs.io/en/latest/request-options.html
|
||||
*/
|
||||
public function __construct(
|
||||
bool $test_mode = true,
|
||||
?string $login = null,
|
||||
?string $password = null,
|
||||
?string $group = null,
|
||||
array $config = []
|
||||
) {
|
||||
parent::__construct($test_mode, $login, $password, $config);
|
||||
!is_null($group) && $this->setGroup($group);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает группу доступа к ККТ
|
||||
*
|
||||
* @param string $group
|
||||
* @return $this
|
||||
*/
|
||||
public function setGroup(string $group): self
|
||||
{
|
||||
// критерии к длине строки не описаны ни в схеме, ни в документации
|
||||
$this->group = $group;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает группу доступа к ККТ в соответствии с флагом тестового режима
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getGroup(): ?string
|
||||
{
|
||||
return $this->group;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает URL для приёма колбеков
|
||||
*
|
||||
* @param string $url
|
||||
* @return $this
|
||||
* @throws TooLongCallbackUrlException
|
||||
* @throws InvalidCallbackUrlException
|
||||
*/
|
||||
public function setCallbackUrl(string $url): self
|
||||
{
|
||||
if (mb_strlen($url) > Constraints::MAX_LENGTH_CALLBACK_URL) {
|
||||
throw new TooLongCallbackUrlException($url, Constraints::MAX_LENGTH_CALLBACK_URL);
|
||||
} elseif (!preg_match(Constraints::PATTERN_CALLBACK_URL, $url)) {
|
||||
throw new InvalidCallbackUrlException('Callback URL not matches with pattern');
|
||||
}
|
||||
$this->callback_url = $url;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает URL для приёма колбеков
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getCallbackUrl(): string
|
||||
{
|
||||
return $this->callback_url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ прихода
|
||||
*
|
||||
* @param Document $document Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyCorrectionInfoException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws InvalidDocumentTypeException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function sell(Document $document, ?string $external_id = null): KktResponse
|
||||
{
|
||||
if ($document->getCorrectionInfo()) {
|
||||
throw new EmptyCorrectionInfoException('Некорректная операция над документом коррекции');
|
||||
}
|
||||
return $this->registerDocument('sell', 'receipt', $document, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ возврата прихода
|
||||
*
|
||||
* @param Document $document Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyCorrectionInfoException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyVatsException
|
||||
* @throws InvalidDocumentTypeException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function sellRefund(Document $document, ?string $external_id = null): KktResponse
|
||||
{
|
||||
if ($document->getCorrectionInfo()) {
|
||||
throw new EmptyCorrectionInfoException('Invalid operation on correction document');
|
||||
}
|
||||
return $this->registerDocument('sell_refund', 'receipt', $document->clearVats(), $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ коррекции прихода
|
||||
*
|
||||
* @param Document $document Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyCorrectionInfoException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyItemsException
|
||||
* @throws InvalidDocumentTypeException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function sellCorrection(Document $document, ?string $external_id = null): KktResponse
|
||||
{
|
||||
if (!$document->getCorrectionInfo()) {
|
||||
throw new EmptyCorrectionInfoException();
|
||||
}
|
||||
$document->setClient(null)->setItems([]);
|
||||
return $this->registerDocument('sell_correction', 'correction', $document, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ расхода
|
||||
*
|
||||
* @param Document $document
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyCorrectionInfoException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws InvalidDocumentTypeException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function buy(Document $document, ?string $external_id = null): KktResponse
|
||||
{
|
||||
if ($document->getCorrectionInfo()) {
|
||||
throw new EmptyCorrectionInfoException('Invalid operation on correction document');
|
||||
}
|
||||
return $this->registerDocument('buy', 'receipt', $document, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ возврата расхода
|
||||
*
|
||||
* @param Document $document
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyCorrectionInfoException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyVatsException
|
||||
* @throws InvalidDocumentTypeException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function buyRefund(Document $document, ?string $external_id = null): KktResponse
|
||||
{
|
||||
if ($document->getCorrectionInfo()) {
|
||||
throw new EmptyCorrectionInfoException('Invalid operation on correction document');
|
||||
}
|
||||
return $this->registerDocument('buy_refund', 'receipt', $document->clearVats(), $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует документ коррекции расхода
|
||||
*
|
||||
* @param Document $document
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException Ошибка авторизации
|
||||
* @throws EmptyCorrectionInfoException В документе отсутствуют данные коррекции
|
||||
* @throws InvalidInnLengthException Некорректная длтина ИНН
|
||||
* @throws TooLongPaymentAddressException Слишком длинный адрес места расчётов
|
||||
* @throws TooManyItemsException Слишком много предметов расчёта
|
||||
* @throws InvalidDocumentTypeException Некорректный тип документа
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function buyCorrection(Document $document, ?string $external_id = null): KktResponse
|
||||
{
|
||||
if (!$document->getCorrectionInfo()) {
|
||||
throw new EmptyCorrectionInfoException();
|
||||
}
|
||||
$document->setClient(null)->setItems([]);
|
||||
return $this->registerDocument('buy_correction', 'correction', $document, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет статус чека на ККТ один раз
|
||||
*
|
||||
* @param string $uuid UUID регистрации
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidUuidException
|
||||
* @throws TooLongLoginException
|
||||
* @throws TooLongPasswordException
|
||||
*/
|
||||
public function getDocumentStatus(string $uuid): KktResponse
|
||||
{
|
||||
$uuid = trim($uuid);
|
||||
if (!Uuid::isValid($uuid)) {
|
||||
throw new InvalidUuidException($uuid);
|
||||
}
|
||||
$this->auth();
|
||||
return $this->sendRequest('GET', 'report/' . $uuid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет статус чека на ККТ нужное количество раз с указанным интервалом.
|
||||
* Вернёт результат как только при очередной проверке сменится статус регистрации документа.
|
||||
*
|
||||
* @param string $uuid UUID регистрации
|
||||
* @param int $retry_count Количество попыток
|
||||
* @param int $timeout Таймаут в секундах между попытками
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidUuidException
|
||||
* @throws TooLongLoginException
|
||||
* @throws TooLongPasswordException
|
||||
*/
|
||||
public function pollDocumentStatus(string $uuid, int $retry_count = 5, int $timeout = 1): KktResponse
|
||||
{
|
||||
$try = 0;
|
||||
do {
|
||||
$response = $this->getDocumentStatus($uuid);
|
||||
if ($response->isValid() && $response->getContent()->status == 'done') {
|
||||
break;
|
||||
} else {
|
||||
sleep($timeout);
|
||||
}
|
||||
++$try;
|
||||
} while ($try < $retry_count);
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Отправляет документ на регистрацию
|
||||
*
|
||||
* @param string $api_method Метод API
|
||||
* @param string $type Тип документа: receipt, correction
|
||||
* @param Document $document Объект документа
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан UUID)
|
||||
* @return KktResponse
|
||||
* @throws AuthFailedException Ошибка авторизации
|
||||
* @throws InvalidDocumentTypeException Некорректный тип документа
|
||||
* @throws InvalidInnLengthException Некорректная длина ИНН
|
||||
* @throws TooLongPaymentAddressException Слишком длинный адрес места расчётов
|
||||
* @throws GuzzleException
|
||||
* @throws Exception
|
||||
*/
|
||||
protected function registerDocument(
|
||||
string $api_method,
|
||||
string $type,
|
||||
Document $document,
|
||||
?string $external_id = null
|
||||
): KktResponse {
|
||||
$type = trim($type);
|
||||
if (!in_array($type, ['receipt', 'correction'])) {
|
||||
throw new InvalidDocumentTypeException($type);
|
||||
}
|
||||
$this->auth();
|
||||
if ($this->isTestMode()) {
|
||||
$document->setCompany(new Company(
|
||||
'test@example.com',
|
||||
TestEnvParams::FFD105()['sno'],
|
||||
TestEnvParams::FFD105()['inn'],
|
||||
TestEnvParams::FFD105()['payment_address'],
|
||||
));
|
||||
}
|
||||
$data['timestamp'] = date('d.m.y H:i:s');
|
||||
$data['external_id'] = $external_id ?: Uuid::uuid4()->toString();
|
||||
$data[$type] = $document;
|
||||
if ($this->getCallbackUrl()) {
|
||||
$data['service'] = ['callback_url' => $this->getCallbackUrl()];
|
||||
}
|
||||
return $this->sendRequest('POST', trim($api_method), $data);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function getAuthEndpoint(): string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
? 'https://testonline.atol.ru/possystem/v1/getToken'
|
||||
: 'https://online.atol.ru/possystem/v1/getToken';
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function getMainEndpoint(): string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
? 'https://testonline.atol.ru/possystem/v4/'
|
||||
: 'https://online.atol.ru/possystem/v4/';
|
||||
}
|
||||
}
|
||||
@@ -12,21 +12,27 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Api;
|
||||
|
||||
use AtolOnline\Entities\Kkt;
|
||||
use AtolOnline\Exceptions\EmptyMonitorDataException;
|
||||
use AtolOnline\Exceptions\NotEnoughMonitorDataException;
|
||||
use AtolOnline\Exceptions\{
|
||||
AuthFailedException,
|
||||
EmptyLoginException,
|
||||
EmptyMonitorDataException,
|
||||
EmptyPasswordException,
|
||||
NotEnoughMonitorDataException};
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use Illuminate\Support\Collection;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Класс для мониторинга ККТ
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_service_information.pdf Документация
|
||||
*/
|
||||
class KktMonitor extends AtolClient
|
||||
final class Monitor extends AtolClient
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[Pure]
|
||||
protected function getAuthEndpoint(): string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
@@ -37,6 +43,7 @@ class KktMonitor extends AtolClient
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[Pure]
|
||||
protected function getMainEndpoint(): string
|
||||
{
|
||||
return $this->isTestMode()
|
||||
@@ -49,16 +56,21 @@ class KktMonitor extends AtolClient
|
||||
*
|
||||
* @param int|null $limit
|
||||
* @param int|null $offset
|
||||
* @return KktResponse
|
||||
* @return AtolResponse|null
|
||||
* @throws GuzzleException
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @see https://online.atol.ru/files/API_service_information.pdf Документация, стр 9
|
||||
*/
|
||||
protected function fetchAll(?int $limit = null, ?int $offset = null): KktResponse
|
||||
protected function fetchAll(?int $limit = null, ?int $offset = null): ?AtolResponse
|
||||
{
|
||||
$params = [];
|
||||
!is_null($limit) && $params['limit'] = $limit;
|
||||
!is_null($offset) && $params['offset'] = $offset;
|
||||
return $this->sendRequest('GET', self::getUrlToMethod('cash-registers'), $params);
|
||||
return $this->auth()
|
||||
? $this->sendRequest('GET', self::getUrlToMethod('cash-registers'), $params)
|
||||
: null;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -67,6 +79,9 @@ class KktMonitor extends AtolClient
|
||||
* @param int|null $limit
|
||||
* @param int|null $offset
|
||||
* @return Collection
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @see https://online.atol.ru/files/API_service_information.pdf Документация, стр 9
|
||||
*/
|
||||
@@ -80,11 +95,11 @@ class KktMonitor extends AtolClient
|
||||
* Получает от API информацию о конкретной ККТ по её серийному номеру
|
||||
*
|
||||
* @param string $serial_number
|
||||
* @return KktResponse
|
||||
* @return AtolResponse
|
||||
* @throws GuzzleException
|
||||
* @see https://online.atol.ru/files/API_service_information.pdf Документация, стр 11
|
||||
*/
|
||||
protected function fetchOne(string $serial_number): KktResponse
|
||||
protected function fetchOne(string $serial_number): AtolResponse
|
||||
{
|
||||
return $this->sendRequest(
|
||||
'GET',
|
||||
@@ -12,7 +12,6 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Collections;
|
||||
|
||||
use AtolOnline\Exceptions\InvalidEntityInCollectionException;
|
||||
use Exception;
|
||||
use Illuminate\Support\Collection;
|
||||
|
||||
/**
|
||||
@@ -24,57 +23,9 @@ abstract class EntityCollection extends Collection
|
||||
* @inheritDoc
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function __construct($items = [])
|
||||
{
|
||||
$this->checkCount($items);
|
||||
//TODO следует переделать EntityCollection в обёртку над Collection,
|
||||
// ибо ломает методы Collection, которые return new static
|
||||
$this->checkItemsClasses($items);
|
||||
parent::__construct($items);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function prepend($value, $key = null): self
|
||||
{
|
||||
$this->checkCount();
|
||||
return parent::prepend($value, $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function add($item): self
|
||||
{
|
||||
$this->checkCount();
|
||||
return parent::add($item);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function push(...$values): self
|
||||
{
|
||||
$this->checkCount();
|
||||
return parent::push(...$values);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function merge($items): self
|
||||
{
|
||||
$this->checkCount();
|
||||
return parent::merge($items);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws Exception
|
||||
*/
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
$this->checkCount();
|
||||
$this->checkItemsClasses();
|
||||
return parent::jsonSerialize();
|
||||
}
|
||||
@@ -82,20 +33,19 @@ abstract class EntityCollection extends Collection
|
||||
/**
|
||||
* Проверяет количество элементов коллекции
|
||||
*
|
||||
* @param array $items Массив элементов, если пустой - проверит содержимое коллекции
|
||||
* @return void
|
||||
*/
|
||||
public function checkCount(array $items = []): void
|
||||
public function checkCount(): void
|
||||
{
|
||||
//TODO проверять пустоту?
|
||||
if (count($items) > static::MAX_COUNT || $this->count() === static::MAX_COUNT) {
|
||||
throw new (static::EXCEPTION_CLASS)(static::MAX_COUNT);
|
||||
}
|
||||
$this->isEmpty() && throw new (static::EMPTY_EXCEPTION_CLASS)();
|
||||
$this->count() > static::MAX_COUNT && throw new (static::TOO_MANY_EXCEPTION_CLASS)(static::MAX_COUNT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет корректность класса элемента коллекции
|
||||
*
|
||||
* @param mixed $item
|
||||
* @return void
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function checkItemClass(mixed $item): void
|
||||
@@ -108,10 +58,11 @@ abstract class EntityCollection extends Collection
|
||||
/**
|
||||
* Проверяет корректность классов элементов коллекции
|
||||
*
|
||||
* @return $this
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function checkItemsClasses(array $items = []): void
|
||||
public function checkItemsClasses(): self
|
||||
{
|
||||
(empty($items) ? $this : collect($items))->each(fn ($item) => $this->checkItemClass($item));
|
||||
return $this->each(fn($item) => $this->checkItemClass($item));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,6 +11,7 @@ namespace AtolOnline\Collections;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Entities\Item;
|
||||
use AtolOnline\Exceptions\EmptyItemsException;
|
||||
use AtolOnline\Exceptions\TooManyItemsException;
|
||||
|
||||
/**
|
||||
@@ -28,8 +29,13 @@ final class Items extends EntityCollection
|
||||
*/
|
||||
protected const MAX_COUNT = Constraints::MAX_COUNT_DOC_ITEMS;
|
||||
|
||||
/**
|
||||
* Класс исключения для выброса при пустой коллекции
|
||||
*/
|
||||
protected const EMPTY_EXCEPTION_CLASS = EmptyItemsException::class;
|
||||
|
||||
/**
|
||||
* Класс-наследник TooManyException для выброса при превышении количества
|
||||
*/
|
||||
protected const EXCEPTION_CLASS = TooManyItemsException::class;
|
||||
protected const TOO_MANY_EXCEPTION_CLASS = TooManyItemsException::class;
|
||||
}
|
||||
|
||||
@@ -11,6 +11,7 @@ namespace AtolOnline\Collections;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Entities\Payment;
|
||||
use AtolOnline\Exceptions\EmptyPaymentsException;
|
||||
use AtolOnline\Exceptions\TooManyPaymentsException;
|
||||
|
||||
/**
|
||||
@@ -28,8 +29,13 @@ final class Payments extends EntityCollection
|
||||
*/
|
||||
protected const MAX_COUNT = Constraints::MAX_COUNT_DOC_PAYMENTS;
|
||||
|
||||
/**
|
||||
* Класс исключения для выброса при пустой коллекции
|
||||
*/
|
||||
protected const EMPTY_EXCEPTION_CLASS = EmptyPaymentsException::class;
|
||||
|
||||
/**
|
||||
* Класс-наследник TooManyException для выброса при превышении количества
|
||||
*/
|
||||
protected const EXCEPTION_CLASS = TooManyPaymentsException::class;
|
||||
protected const TOO_MANY_EXCEPTION_CLASS = TooManyPaymentsException::class;
|
||||
}
|
||||
|
||||
@@ -11,6 +11,7 @@ namespace AtolOnline\Collections;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Entities\Vat;
|
||||
use AtolOnline\Exceptions\EmptyVatsException;
|
||||
use AtolOnline\Exceptions\TooManyVatsException;
|
||||
|
||||
/**
|
||||
@@ -28,8 +29,13 @@ final class Vats extends EntityCollection
|
||||
*/
|
||||
protected const MAX_COUNT = Constraints::MAX_COUNT_DOC_VATS;
|
||||
|
||||
/**
|
||||
* Класс исключения для выброса при пустой коллекции
|
||||
*/
|
||||
protected const EMPTY_EXCEPTION_CLASS = EmptyVatsException::class;
|
||||
|
||||
/**
|
||||
* Класс-наследник TooManyException для выброса при превышении количества
|
||||
*/
|
||||
protected const EXCEPTION_CLASS = TooManyVatsException::class;
|
||||
protected const TOO_MANY_EXCEPTION_CLASS = TooManyVatsException::class;
|
||||
}
|
||||
|
||||
@@ -43,24 +43,28 @@ final class Constraints
|
||||
|
||||
/**
|
||||
* Максимальная длина наименования покупателя (1227)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 17
|
||||
*/
|
||||
const MAX_LENGTH_CLIENT_NAME = 256;
|
||||
|
||||
/**
|
||||
* Максимальная длина наименования предмета расчёта (1030)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
const MAX_LENGTH_ITEM_NAME = 128;
|
||||
|
||||
/**
|
||||
* Максимальная цена за единицу предмета расчёта (1079)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
const MAX_COUNT_ITEM_PRICE = 42949672.95;
|
||||
|
||||
/**
|
||||
* Максимальное количество (вес) единицы предмета расчёта (1023)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
const MAX_COUNT_ITEM_QUANTITY = 99999.999;
|
||||
@@ -68,36 +72,42 @@ final class Constraints
|
||||
/**
|
||||
* Максимальная стоимость всех предметов расчёта в документе прихода, расхода,
|
||||
* возврата прихода, возврата расхода (1043)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
const MAX_COUNT_ITEM_SUM = 42949672.95;
|
||||
|
||||
/**
|
||||
* Максимальная длина телефона или email покупателя (1008)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 17
|
||||
*/
|
||||
const MAX_LENGTH_CLIENT_CONTACT = 64;
|
||||
|
||||
/**
|
||||
* Длина операции для платёжного агента (1044)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 19
|
||||
*/
|
||||
const MAX_LENGTH_PAYING_AGENT_OPERATION = 24;
|
||||
|
||||
/**
|
||||
* Максимальное количество предметов расчёта в документе прихода, расхода, возврата прихода, возврата расхода
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
const MAX_COUNT_DOC_ITEMS = 100;
|
||||
|
||||
/**
|
||||
* Максимальная длина единицы измерения предмета расчётов
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 21
|
||||
*/
|
||||
const MAX_LENGTH_MEASUREMENT_UNIT = 16;
|
||||
|
||||
/**
|
||||
* Максимальная длина пользовательских данных для предмета расчётов (1191)
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 29
|
||||
*/
|
||||
const MAX_LENGTH_USER_DATA = 64;
|
||||
@@ -118,12 +128,14 @@ final class Constraints
|
||||
|
||||
/**
|
||||
* Максимальное количество платежей в любом документе
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 30 и 35
|
||||
*/
|
||||
const MAX_COUNT_DOC_PAYMENTS = 10;
|
||||
|
||||
/**
|
||||
* Максимальное количество ставок НДС в любом документе
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 31 и 36
|
||||
*/
|
||||
const MAX_COUNT_DOC_VATS = 6;
|
||||
@@ -178,26 +190,31 @@ final class Constraints
|
||||
*
|
||||
* @see https://online.atol.ru/possystem/v4/schema/sell Схема "#/receipt/client/inn"
|
||||
*/
|
||||
const PATTERN_INN = /* @lang PhpRegExp */
|
||||
const PATTERN_INN
|
||||
= /* @lang PhpRegExp */
|
||||
'/(^[\d]{10}$)|(^[\d]{12}$)/';
|
||||
|
||||
/**
|
||||
* Регулярное выражение для валидации номера телефона
|
||||
*
|
||||
* @see https://online.atol.ru/possystem/v4/schema/sell Схема "#/definitions/phone_number"
|
||||
*/
|
||||
const PATTERN_PHONE = /* @lang PhpRegExp */
|
||||
const PATTERN_PHONE
|
||||
= /* @lang PhpRegExp */
|
||||
'/^([^\s\\\]{0,17}|\+[^\s\\\]{1,18})$/';
|
||||
|
||||
/**
|
||||
* Регулярное выражение для валидации строки Callback URL
|
||||
*/
|
||||
const PATTERN_CALLBACK_URL = /* @lang PhpRegExp */
|
||||
'/^http(s?)\:\/\/[0-9a-zA-Zа-яА-Я]' .
|
||||
'([-.\w]*[0-9a-zA-Zа-яА-Я])*(:(0-9)*)*(\/?)([a-zAZ0-9а-яА-Я\-\.\?\,\'\/\\\+&=%\$#_]*)?$/';
|
||||
const PATTERN_CALLBACK_URL
|
||||
= /* @lang PhpRegExp */
|
||||
'/^http(s?):\/\/[0-9a-zA-Zа-яА-Я]' .
|
||||
'([-.\w]*[0-9a-zA-Zа-яА-Я])*(:(0-9)*)*(\/?)([a-zAZ0-9а-яА-Я\-.?,\'\/\\\+&=%\$#_]*)?$/';
|
||||
|
||||
/**
|
||||
* Регулярное выражение для валидации кода страны происхождения товара
|
||||
*/
|
||||
const PATTERN_OKSM_CODE = /* @lang PhpRegExp */
|
||||
const PATTERN_OKSM_CODE
|
||||
= /* @lang PhpRegExp */
|
||||
'/^[\d]{3}$/';
|
||||
}
|
||||
|
||||
@@ -16,8 +16,12 @@ use AtolOnline\Exceptions\{
|
||||
EmptyAddUserPropNameException,
|
||||
EmptyAddUserPropValueException,
|
||||
TooLongAddUserPropNameException,
|
||||
TooLongAddUserPropValueException};
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
TooLongAddUserPropValueException
|
||||
};
|
||||
use JetBrains\PhpStorm\{
|
||||
ArrayShape,
|
||||
Pure
|
||||
};
|
||||
|
||||
/**
|
||||
* Класс, описывающий дополнительный реквизит пользователя
|
||||
@@ -117,6 +121,7 @@ final class AdditionalUserProps extends Entity
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[Pure]
|
||||
#[ArrayShape(['name' => 'string', 'value' => 'null|string'])]
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
return [
|
||||
|
||||
@@ -17,12 +17,10 @@ use AtolOnline\Exceptions\{
|
||||
InvalidInnLengthException,
|
||||
InvalidPhoneException,
|
||||
TooLongClientNameException,
|
||||
TooLongEmailException
|
||||
};
|
||||
TooLongEmailException};
|
||||
use AtolOnline\Traits\{
|
||||
HasEmail,
|
||||
HasInn
|
||||
};
|
||||
HasInn};
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
@@ -94,7 +92,7 @@ final class Client extends Entity
|
||||
throw new TooLongClientNameException($name);
|
||||
}
|
||||
}
|
||||
$this->name = empty($name) ? null : $name;
|
||||
$this->name = $name ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
@@ -134,10 +132,10 @@ final class Client extends Entity
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
$json = [];
|
||||
$this->getName() && $json['name'] = $this->getName();
|
||||
$this->getEmail() && $json['email'] = $this->getEmail();
|
||||
$this->getPhone() && $json['phone'] = $this->getPhone();
|
||||
$this->getInn() && $json['inn'] = $this->getInn();
|
||||
!is_null($this->getName()) && $json['name'] = $this->getName();
|
||||
!is_null($this->getEmail()) && $json['email'] = $this->getEmail();
|
||||
!is_null($this->getPhone()) && $json['phone'] = $this->getPhone();
|
||||
!is_null($this->getInn()) && $json['inn'] = $this->getInn();
|
||||
return $json;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,14 +15,16 @@ use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Enums\SnoTypes,
|
||||
Traits\HasEmail,
|
||||
Traits\HasInn};
|
||||
Traits\HasInn
|
||||
};
|
||||
use AtolOnline\Exceptions\{
|
||||
InvalidEmailException,
|
||||
InvalidEnumValueException,
|
||||
InvalidInnLengthException,
|
||||
InvalidPaymentAddressException,
|
||||
TooLongEmailException,
|
||||
TooLongPaymentAddressException};
|
||||
TooLongPaymentAddressException
|
||||
};
|
||||
use JetBrains\PhpStorm\ArrayShape;
|
||||
|
||||
/**
|
||||
@@ -59,8 +61,8 @@ final class Company extends Entity
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function __construct(
|
||||
string $email,
|
||||
string $sno,
|
||||
string $email, //TODO сделать необязательным здесь
|
||||
string $sno, //TODO сделать необязательным здесь
|
||||
string $inn,
|
||||
string $payment_address,
|
||||
) {
|
||||
|
||||
273
src/Entities/Correction.php
Normal file
273
src/Entities/Correction.php
Normal file
@@ -0,0 +1,273 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
namespace AtolOnline\Entities;
|
||||
|
||||
use AtolOnline\{
|
||||
Api\AtolResponse,
|
||||
Api\Fiscalizer,
|
||||
Collections\Payments,
|
||||
Collections\Vats,
|
||||
Constants\Constraints};
|
||||
use AtolOnline\Exceptions\{
|
||||
AuthFailedException,
|
||||
EmptyLoginException,
|
||||
EmptyPasswordException,
|
||||
InvalidEntityInCollectionException,
|
||||
InvalidInnLengthException,
|
||||
InvalidPaymentAddressException,
|
||||
TooLongCashierException,
|
||||
TooLongPaymentAddressException};
|
||||
use Exception;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use JetBrains\PhpStorm\ArrayShape;
|
||||
|
||||
/**
|
||||
* Класс, описывающий документ коррекции
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 35
|
||||
*/
|
||||
final class Correction extends Entity
|
||||
{
|
||||
/**
|
||||
* Тип документа
|
||||
*/
|
||||
public const DOC_TYPE = 'correction';
|
||||
|
||||
/**
|
||||
* @var Company Продавец
|
||||
*/
|
||||
protected Company $company;
|
||||
|
||||
/**
|
||||
* @todo вынести в трейт?
|
||||
* @var string|null ФИО кассира
|
||||
*/
|
||||
protected ?string $cashier = null;
|
||||
|
||||
/**
|
||||
* @var CorrectionInfo Данные коррекции
|
||||
*/
|
||||
protected CorrectionInfo $correction_info;
|
||||
|
||||
/**
|
||||
* @var Payments Коллекция оплат
|
||||
*/
|
||||
protected Payments $payments;
|
||||
|
||||
/**
|
||||
* @var Vats Коллекция ставок НДС
|
||||
*/
|
||||
protected Vats $vats;
|
||||
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
* @param Company $company
|
||||
* @param CorrectionInfo $correction_info
|
||||
* @param Payments $payments
|
||||
* @param Vats $vats
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function __construct(
|
||||
Company $company,
|
||||
CorrectionInfo $correction_info,
|
||||
Payments $payments,
|
||||
Vats $vats,
|
||||
) {
|
||||
$this->setCompany($company)->setCorrectionInfo($correction_info)->setPayments($payments)->setVats($vats);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает установленного продавца
|
||||
*
|
||||
* @return Company
|
||||
*/
|
||||
public function getCompany(): Company
|
||||
{
|
||||
return $this->company;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанаваливает продавца
|
||||
*
|
||||
* @param Company $company
|
||||
* @return $this
|
||||
*/
|
||||
public function setCompany(Company $company): self
|
||||
{
|
||||
$this->company = $company;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает установленного кассира
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getCashier(): ?string
|
||||
{
|
||||
return $this->cashier;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанаваливает кассира
|
||||
*
|
||||
* @param string|null $cashier
|
||||
* @return $this
|
||||
* @throws TooLongCashierException
|
||||
*/
|
||||
public function setCashier(?string $cashier): self
|
||||
{
|
||||
if (is_string($cashier)) {
|
||||
$cashier = trim($cashier);
|
||||
if (mb_strlen($cashier) > Constraints::MAX_LENGTH_CASHIER_NAME) {
|
||||
throw new TooLongCashierException($cashier);
|
||||
}
|
||||
}
|
||||
$this->cashier = $cashier ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает установленные данные коррекции
|
||||
*
|
||||
* @return CorrectionInfo
|
||||
*/
|
||||
public function getCorrectionInfo(): CorrectionInfo
|
||||
{
|
||||
return $this->correction_info;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает данные коррекции
|
||||
*
|
||||
* @param CorrectionInfo $correction_info
|
||||
* @return Correction
|
||||
*/
|
||||
public function setCorrectionInfo(CorrectionInfo $correction_info): Correction
|
||||
{
|
||||
$this->correction_info = $correction_info;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает установленную коллекцию оплат
|
||||
*
|
||||
* @return Payments
|
||||
*/
|
||||
public function getPayments(): Payments
|
||||
{
|
||||
return $this->payments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанаваливает коллекцию оплат
|
||||
*
|
||||
* @param Payments $payments
|
||||
* @return $this
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function setPayments(Payments $payments): self
|
||||
{
|
||||
$payments->checkCount();
|
||||
$payments->checkItemsClasses();
|
||||
$this->payments = $payments;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает установленную коллекцию ставок НДС
|
||||
*
|
||||
* @return Vats|null
|
||||
*/
|
||||
public function getVats(): Vats
|
||||
{
|
||||
return $this->vats ?? new Vats();
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанаваливает коллекцию ставок НДС
|
||||
*
|
||||
* @param Vats|null $vats
|
||||
* @return $this
|
||||
* @throws Exception
|
||||
*/
|
||||
public function setVats(Vats $vats): self
|
||||
{
|
||||
$vats->checkCount();
|
||||
$vats->checkItemsClasses();
|
||||
$this->vats = $vats;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует коррекцию прихода по текущему документу
|
||||
*
|
||||
* @param Fiscalizer $fiscalizer Объект фискализатора
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function sellCorrect(Fiscalizer $fiscalizer, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $fiscalizer->sellCorrect($this, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует коррекцию расхода по текущему документу
|
||||
*
|
||||
* @param Fiscalizer $fiscalizer Объект фискализатора
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function buyCorrect(Fiscalizer $fiscalizer, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $fiscalizer->buyCorrect($this, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
#[ArrayShape([
|
||||
'company' => '\AtolOnline\Entities\Company',
|
||||
'correction_info' => '\AtolOnline\Entities\CorrectionInfo',
|
||||
'payments' => 'array',
|
||||
'vats' => '\AtolOnline\Collections\Vats|null',
|
||||
'cashier' => 'null|string',
|
||||
])]
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
$json = [
|
||||
'company' => $this->getCompany(),
|
||||
'correction_info' => $this->getCorrectionInfo(),
|
||||
'payments' => $this->getPayments()->jsonSerialize(),
|
||||
'vats' => $this->getVats(),
|
||||
];
|
||||
!is_null($this->getCashier()) && $json['cashier'] = $this->getCashier();
|
||||
return $json;
|
||||
}
|
||||
}
|
||||
@@ -7,12 +7,16 @@
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
/** @noinspection PhpMultipleClassDeclarationsInspection */
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Entities;
|
||||
|
||||
use ArrayAccess;
|
||||
use BadMethodCallException;
|
||||
use Illuminate\Contracts\Support\Arrayable;
|
||||
use JetBrains\PhpStorm\ArrayShape;
|
||||
use JsonSerializable;
|
||||
use Stringable;
|
||||
|
||||
@@ -29,6 +33,13 @@ abstract class Entity implements JsonSerializable, Stringable, Arrayable, ArrayA
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
#[ArrayShape([
|
||||
'company' => "\AtolOnline\Entities\Company",
|
||||
'correction_info' => "\AtolOnline\Entities\CorrectionInfo",
|
||||
'payments' => "array",
|
||||
'vats' => "\AtolOnline\Collections\Vats|null",
|
||||
'cashier' => "null|string",
|
||||
])]
|
||||
public function toArray()
|
||||
{
|
||||
return $this->jsonSerialize();
|
||||
@@ -65,7 +76,7 @@ abstract class Entity implements JsonSerializable, Stringable, Arrayable, ArrayA
|
||||
*/
|
||||
public function offsetSet(mixed $offset, mixed $value)
|
||||
{
|
||||
throw new \BadMethodCallException(
|
||||
throw new BadMethodCallException(
|
||||
'Объект ' . static::class . ' нельзя изменять как массив. Следует использовать сеттеры.'
|
||||
);
|
||||
}
|
||||
@@ -75,7 +86,7 @@ abstract class Entity implements JsonSerializable, Stringable, Arrayable, ArrayA
|
||||
*/
|
||||
public function offsetUnset(mixed $offset): void
|
||||
{
|
||||
throw new \BadMethodCallException(
|
||||
throw new BadMethodCallException(
|
||||
'Объект ' . static::class . ' нельзя изменять как массив. Следует использовать сеттеры.'
|
||||
);
|
||||
}
|
||||
|
||||
@@ -556,8 +556,8 @@ final class Item extends Entity
|
||||
if (is_string($declaration_number)) {
|
||||
$declaration_number = trim($declaration_number);
|
||||
if (
|
||||
mb_strlen($declaration_number) < Constraints::MIN_LENGTH_DECLARATION_NUMBER ||
|
||||
mb_strlen($declaration_number) > Constraints::MAX_LENGTH_DECLARATION_NUMBER
|
||||
mb_strlen($declaration_number) < Constraints::MIN_LENGTH_DECLARATION_NUMBER
|
||||
|| mb_strlen($declaration_number) > Constraints::MAX_LENGTH_DECLARATION_NUMBER
|
||||
) {
|
||||
throw new InvalidDeclarationNumberException($declaration_number);
|
||||
}
|
||||
|
||||
@@ -14,8 +14,7 @@ namespace AtolOnline\Entities;
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Exceptions\{
|
||||
InvalidPhoneException,
|
||||
TooLongPayingAgentOperationException
|
||||
};
|
||||
TooLongPayingAgentOperationException};
|
||||
use AtolOnline\Traits\HasPhones;
|
||||
use Illuminate\Support\Collection;
|
||||
|
||||
@@ -64,7 +63,7 @@ final class PayingAgent extends Entity
|
||||
throw new TooLongPayingAgentOperationException($operation);
|
||||
}
|
||||
}
|
||||
$this->operation = empty($operation) ? null : $operation;
|
||||
$this->operation = $operation ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
@@ -11,22 +11,26 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Entities;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Enums\PaymentTypes;
|
||||
use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Enums\PaymentTypes,
|
||||
};
|
||||
use AtolOnline\Exceptions\{
|
||||
InvalidEnumValueException,
|
||||
NegativePaymentSumException,
|
||||
TooHighPaymentSumException,};
|
||||
TooHighPaymentSumException,
|
||||
};
|
||||
use JetBrains\PhpStorm\{
|
||||
ArrayShape,
|
||||
Pure};
|
||||
Pure
|
||||
};
|
||||
|
||||
/**
|
||||
* Класс, описывающий оплату
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 30
|
||||
*/
|
||||
class Payment extends Entity
|
||||
final class Payment extends Entity
|
||||
{
|
||||
/**
|
||||
* @var int Тип оплаты
|
||||
|
||||
@@ -11,31 +11,44 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Entities;
|
||||
|
||||
use AtolOnline\Api\AtolResponse;
|
||||
use AtolOnline\Api\Fiscalizer;
|
||||
use AtolOnline\Collections\Items;
|
||||
use AtolOnline\Collections\Payments;
|
||||
use AtolOnline\Collections\Vats;
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Exceptions\AuthFailedException;
|
||||
use AtolOnline\Exceptions\EmptyItemsException;
|
||||
use AtolOnline\Exceptions\EmptyPaymentsException;
|
||||
use AtolOnline\Exceptions\EmptyVatsException;
|
||||
use AtolOnline\Exceptions\EmptyLoginException;
|
||||
use AtolOnline\Exceptions\EmptyPasswordException;
|
||||
use AtolOnline\Exceptions\InvalidEntityInCollectionException;
|
||||
use AtolOnline\Exceptions\InvalidInnLengthException;
|
||||
use AtolOnline\Exceptions\InvalidPaymentAddressException;
|
||||
use AtolOnline\Exceptions\TooLongAddCheckPropException;
|
||||
use AtolOnline\Exceptions\TooLongCashierException;
|
||||
use AtolOnline\Exceptions\TooLongPaymentAddressException;
|
||||
use Exception;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
/**
|
||||
* Класс, описывающий документ прихода, расхода, возврата прихода, возврата расхода
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 17
|
||||
*/
|
||||
class Receipt extends Entity
|
||||
final class Receipt extends Entity
|
||||
{
|
||||
/**
|
||||
* Тип документа
|
||||
*/
|
||||
public const DOC_TYPE = 'receipt';
|
||||
|
||||
/**
|
||||
* @var Client Покупатель
|
||||
*/
|
||||
protected Client $client;
|
||||
|
||||
/**
|
||||
* @todo вынести в трейт?
|
||||
* @var Company Продавец
|
||||
*/
|
||||
protected Company $company;
|
||||
@@ -56,6 +69,7 @@ class Receipt extends Entity
|
||||
protected Items $items;
|
||||
|
||||
/**
|
||||
* @todo вынести в трейт?
|
||||
* @var Payments Коллекция оплат
|
||||
*/
|
||||
protected Payments $payments;
|
||||
@@ -71,6 +85,7 @@ class Receipt extends Entity
|
||||
protected float $total = 0;
|
||||
|
||||
/**
|
||||
* @todo вынести в трейт?
|
||||
* @var string|null ФИО кассира
|
||||
*/
|
||||
protected ?string $cashier = null;
|
||||
@@ -93,7 +108,6 @@ class Receipt extends Entity
|
||||
* @param Items $items
|
||||
* @param Payments $payments
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function __construct(Client $client, Company $company, Items $items, Payments $payments)
|
||||
@@ -115,7 +129,7 @@ class Receipt extends Entity
|
||||
* Устанаваливает покупателя
|
||||
*
|
||||
* @param Client $client
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
*/
|
||||
public function setClient(Client $client): self
|
||||
{
|
||||
@@ -137,7 +151,7 @@ class Receipt extends Entity
|
||||
* Устанаваливает продавца
|
||||
*
|
||||
* @param Company $company
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
*/
|
||||
public function setCompany(Company $company): self
|
||||
{
|
||||
@@ -159,7 +173,7 @@ class Receipt extends Entity
|
||||
* Устанаваливает агента
|
||||
*
|
||||
* @param AgentInfo|null $agent_info
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
*/
|
||||
public function setAgentInfo(?AgentInfo $agent_info): self
|
||||
{
|
||||
@@ -181,7 +195,7 @@ class Receipt extends Entity
|
||||
* Поставщика
|
||||
*
|
||||
* @param Supplier|null $supplier
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
*/
|
||||
public function setSupplier(?Supplier $supplier): self
|
||||
{
|
||||
@@ -202,21 +216,18 @@ class Receipt extends Entity
|
||||
/**
|
||||
* Устанаваливает коллекцию предметов расчёта
|
||||
*
|
||||
* @todo исключение при пустой коллекции
|
||||
* @param Items $items
|
||||
* @return Receipt
|
||||
* @throws EmptyItemsException
|
||||
* @return $this
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws Exception
|
||||
* @throws EmptyItemsException
|
||||
*/
|
||||
public function setItems(Items $items): self
|
||||
{
|
||||
if ($items->isEmpty()) {
|
||||
throw new EmptyItemsException();
|
||||
}
|
||||
$items->checkCount();
|
||||
$items->checkItemsClasses();
|
||||
$this->items = $items;
|
||||
$this->getItems()->each(fn ($item) => $this->total += $item->getSum());
|
||||
$this->getItems()->each(fn($item) => $this->total += $item->getSum());
|
||||
$this->total = round($this->total, 2);
|
||||
return $this;
|
||||
}
|
||||
@@ -235,14 +246,13 @@ class Receipt extends Entity
|
||||
* Устанаваливает коллекцию оплат
|
||||
*
|
||||
* @param Payments $payments
|
||||
* @return Receipt
|
||||
* @throws EmptyPaymentsException
|
||||
* @return $this
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function setPayments(Payments $payments): self
|
||||
{
|
||||
if ($payments->isEmpty()) {
|
||||
throw new EmptyPaymentsException();
|
||||
}
|
||||
$payments->checkCount();
|
||||
$payments->checkItemsClasses();
|
||||
$this->payments = $payments;
|
||||
return $this;
|
||||
}
|
||||
@@ -261,18 +271,16 @@ class Receipt extends Entity
|
||||
* Устанаваливает коллекцию ставок НДС
|
||||
*
|
||||
* @param Vats|null $vats
|
||||
* @return Receipt
|
||||
* @throws EmptyVatsException
|
||||
* @return $this
|
||||
* @throws Exception
|
||||
*/
|
||||
public function setVats(?Vats $vats): self
|
||||
{
|
||||
if ($vats->isEmpty()) {
|
||||
throw new EmptyVatsException();
|
||||
}
|
||||
$vats->checkCount();
|
||||
$vats->checkItemsClasses();
|
||||
$this->vats = $vats;
|
||||
/** @var Vat $vat */
|
||||
$this->getVats()->each(fn ($vat) => $vat->setSum($this->getTotal()));
|
||||
$this->getVats()->each(fn($vat) => $vat->setSum($this->getTotal()));
|
||||
return $this;
|
||||
}
|
||||
|
||||
@@ -300,7 +308,7 @@ class Receipt extends Entity
|
||||
* Устанаваливает кассира
|
||||
*
|
||||
* @param string|null $cashier
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
* @throws TooLongCashierException
|
||||
*/
|
||||
public function setCashier(?string $cashier): self
|
||||
@@ -329,7 +337,7 @@ class Receipt extends Entity
|
||||
* Устанаваливает дополнительный реквизит чека
|
||||
*
|
||||
* @param string|null $add_check_props
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
* @throws TooLongAddCheckPropException
|
||||
*/
|
||||
public function setAddCheckProps(?string $add_check_props): self
|
||||
@@ -340,7 +348,7 @@ class Receipt extends Entity
|
||||
throw new TooLongAddCheckPropException($add_check_props);
|
||||
}
|
||||
}
|
||||
$this->add_check_props = empty($add_check_props) ? null : $add_check_props;
|
||||
$this->add_check_props = $add_check_props ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
@@ -358,7 +366,7 @@ class Receipt extends Entity
|
||||
* Устанаваливает дополнительный реквизит пользователя
|
||||
*
|
||||
* @param AdditionalUserProps|null $add_user_props
|
||||
* @return Receipt
|
||||
* @return $this
|
||||
*/
|
||||
public function setAddUserProps(?AdditionalUserProps $add_user_props): self
|
||||
{
|
||||
@@ -366,6 +374,86 @@ class Receipt extends Entity
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует приход по текущему документу
|
||||
*
|
||||
* @param Fiscalizer $fiscalizer Объект фискализатора
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function sell(Fiscalizer $fiscalizer, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $fiscalizer->sell($this, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует возврат прихода по текущему документу
|
||||
*
|
||||
* @param Fiscalizer $fiscalizer Объект фискализатора
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function sellRefund(Fiscalizer $fiscalizer, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $fiscalizer->sellRefund($this, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует расход по текущему документу
|
||||
*
|
||||
* @param Fiscalizer $fiscalizer Объект фискализатора
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function buy(Fiscalizer $fiscalizer, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $fiscalizer->buy($this, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Регистрирует возврат расхода по текущему документу
|
||||
*
|
||||
* @param Fiscalizer $fiscalizer Объект фискализатора
|
||||
* @param string|null $external_id Уникальный код документа (если не указан, то будет создан новый UUID)
|
||||
* @return AtolResponse|null
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws TooLongPaymentAddressException
|
||||
*/
|
||||
public function buyRefund(Fiscalizer $fiscalizer, ?string $external_id = null): ?AtolResponse
|
||||
{
|
||||
return $fiscalizer->buyRefund($this, $external_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает массив для кодирования в json
|
||||
*
|
||||
@@ -374,18 +462,19 @@ class Receipt extends Entity
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
$json = [
|
||||
'client' => $this->getClient(),
|
||||
'company' => $this->getCompany(),
|
||||
'items' => $this->getItems(),
|
||||
'client' => $this->getClient()->jsonSerialize(),
|
||||
'company' => $this->getCompany()->jsonSerialize(),
|
||||
'items' => $this->getItems()->jsonSerialize(),
|
||||
'total' => $this->getTotal(),
|
||||
'payments' => $this->getPayments(),
|
||||
'payments' => $this->getPayments()->jsonSerialize(),
|
||||
];
|
||||
$this->getAgentInfo()?->jsonSerialize() && $json['agent_info'] = $this->getAgentInfo();
|
||||
$this->getSupplier()?->jsonSerialize() && $json['supplier_info'] = $this->getSupplier();
|
||||
$this->getVats()?->jsonSerialize() && $json['vats'] = $this->getVats();
|
||||
$this->getAgentInfo()?->jsonSerialize() && $json['agent_info'] = $this->getAgentInfo()->jsonSerialize();
|
||||
$this->getSupplier()?->jsonSerialize() && $json['supplier_info'] = $this->getSupplier()->jsonSerialize();
|
||||
$this->getVats()?->isNotEmpty() && $json['vats'] = $this->getVats();
|
||||
!is_null($this->getAddCheckProps()) && $json['additional_check_props'] = $this->getAddCheckProps();
|
||||
!is_null($this->getCashier()) && $json['cashier'] = $this->getCashier();
|
||||
$this->getAddUserProps()?->jsonSerialize() && $json['additional_user_props'] = $this->getAddUserProps();
|
||||
$this->getAddUserProps()?->jsonSerialize() &&
|
||||
$json['additional_user_props'] = $this->getAddUserProps()->jsonSerialize();
|
||||
return $json;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -91,7 +91,7 @@ final class Vat extends Entity
|
||||
*/
|
||||
public function setSum(float $rubles): self
|
||||
{
|
||||
$this->sum = $rubles;
|
||||
$this->sum = round($rubles, 2);
|
||||
return $this;
|
||||
}
|
||||
|
||||
@@ -106,15 +106,17 @@ final class Vat extends Entity
|
||||
#[Pure]
|
||||
public function getCalculated(): float
|
||||
{
|
||||
return Helpers::toRub(match ($this->getType()) {
|
||||
VatTypes::VAT10 => Helpers::toKop($this->sum) * 10 / 100,
|
||||
VatTypes::VAT18 => Helpers::toKop($this->sum) * 18 / 100,
|
||||
VatTypes::VAT20 => Helpers::toKop($this->sum) * 20 / 100,
|
||||
VatTypes::VAT110 => Helpers::toKop($this->sum) * 10 / 110,
|
||||
VatTypes::VAT118 => Helpers::toKop($this->sum) * 18 / 118,
|
||||
VatTypes::VAT120 => Helpers::toKop($this->sum) * 20 / 120,
|
||||
default => 0,
|
||||
});
|
||||
return Helpers::toRub(
|
||||
match ($this->getType()) {
|
||||
VatTypes::VAT10 => Helpers::toKop($this->sum) * 10 / 100,
|
||||
VatTypes::VAT18 => Helpers::toKop($this->sum) * 18 / 100,
|
||||
VatTypes::VAT20 => Helpers::toKop($this->sum) * 20 / 100,
|
||||
VatTypes::VAT110 => Helpers::toKop($this->sum) * 10 / 110,
|
||||
VatTypes::VAT118 => Helpers::toKop($this->sum) * 18 / 118,
|
||||
VatTypes::VAT120 => Helpers::toKop($this->sum) * 20 / 120,
|
||||
default => 0,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Enums;
|
||||
|
||||
/**
|
||||
* Константы, определяющие типы документов
|
||||
*/
|
||||
final class DocumentTypes extends Enum
|
||||
{
|
||||
/**
|
||||
* Чек прихода, возврата прихода, расхода, возврата расхода
|
||||
*/
|
||||
const RECEIPT = 'receipt';
|
||||
|
||||
/**
|
||||
* Чек коррекции
|
||||
*/
|
||||
const CORRECTION = 'correction';
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public static function getFfdTags(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
@@ -77,6 +77,7 @@ final class PaymentObjects extends Enum
|
||||
|
||||
/**
|
||||
* Составной предмет расчёта
|
||||
*
|
||||
* @deprecated Более не используется согласно ФФД 1.05
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 25 (payment_object)
|
||||
*/
|
||||
|
||||
@@ -47,4 +47,4 @@ final class ReceiptOperationTypes extends Enum
|
||||
* Коррекция прихода (догоняем неучтённые средства)
|
||||
*/
|
||||
const BUY_CORRECTION = 'buy_correction';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use Exception;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при работе с АТОЛ Онлайн
|
||||
@@ -29,6 +30,7 @@ class AtolException extends Exception
|
||||
* @param string $message Сообщение
|
||||
* @param int[] $ffd_tags Переопредление тегов ФФД
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $message = '', array $ffd_tags = [])
|
||||
{
|
||||
$tags = implode(', ', $ffd_tags ?: $this->ffd_tags);
|
||||
|
||||
@@ -11,8 +11,9 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Api\KktResponse;
|
||||
use AtolOnline\Api\AtolResponse;
|
||||
use Exception;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при неудачной авторизации
|
||||
@@ -22,10 +23,11 @@ class AuthFailedException extends Exception
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
* @param KktResponse $response
|
||||
* @param AtolResponse $response
|
||||
* @param string $message
|
||||
*/
|
||||
public function __construct(KktResponse $response, string $message = '')
|
||||
#[Pure]
|
||||
public function __construct(AtolResponse $response, string $message = '')
|
||||
{
|
||||
parent::__construct(($message ?: 'Ошибка авторизации: ') . ': ' . $response);
|
||||
}
|
||||
|
||||
20
src/Exceptions/EmptyGroupException.php
Normal file
20
src/Exceptions/EmptyGroupException.php
Normal file
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать пустую группу ККТ
|
||||
*/
|
||||
class EmptyGroupException extends AtolException
|
||||
{
|
||||
protected $message = 'Группа ККТ должна быть указана';
|
||||
}
|
||||
@@ -13,6 +13,7 @@ namespace AtolOnline\Exceptions;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать пустой логин
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 12
|
||||
*/
|
||||
class EmptyLoginException extends AtolException
|
||||
|
||||
@@ -13,6 +13,7 @@ namespace AtolOnline\Exceptions;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать пустой пароль
|
||||
*
|
||||
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 12
|
||||
*/
|
||||
class EmptyPasswordException extends AtolException
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать некорректную дату коррекции
|
||||
@@ -26,6 +27,7 @@ class InvalidCorrectionDateException extends AtolException
|
||||
* @param string $date
|
||||
* @param string $message
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $date = '', string $message = '')
|
||||
{
|
||||
parent::__construct("Ошибка даты документа коррекции '$date': " . $message);
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при ошибке валидации кода таможенной декларации
|
||||
@@ -25,6 +26,7 @@ class InvalidDeclarationNumberException extends AtolException
|
||||
*
|
||||
* @param string $code
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $code = '')
|
||||
{
|
||||
parent::__construct("Невалидный код таможенной декларации: '$code'");
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при ошибке валидации email
|
||||
@@ -30,6 +31,7 @@ class InvalidEmailException extends AtolException
|
||||
*
|
||||
* @param string $email
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $email = '')
|
||||
{
|
||||
parent::__construct("Невалидный email: '$email'");
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать ИНН некорректной длины
|
||||
@@ -31,6 +32,7 @@ class InvalidInnLengthException extends AtolException
|
||||
* @param string $inn
|
||||
* @param string $message
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $inn = '', string $message = '')
|
||||
{
|
||||
parent::__construct(
|
||||
|
||||
@@ -11,6 +11,8 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при работе с невалидным JSON
|
||||
*/
|
||||
@@ -19,6 +21,7 @@ class InvalidJsonException extends AtolException
|
||||
/**
|
||||
* Конструктор
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct('[' . json_last_error() . '] ' . json_last_error_msg());
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при ошибке валидации кода страны происхождения товара
|
||||
@@ -27,6 +28,7 @@ class InvalidOKSMCodeException extends AtolException
|
||||
*
|
||||
* @param string $code
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $code)
|
||||
{
|
||||
parent::__construct('Невалидный код страны происхождения товара: ' . $code);
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать некорректный адрес места расчётов
|
||||
@@ -28,7 +29,8 @@ class InvalidPaymentAddressException extends AtolException
|
||||
* @param string $address
|
||||
* @param string $message
|
||||
*/
|
||||
public function __construct($address = '', $message = "")
|
||||
#[Pure]
|
||||
public function __construct(string $address = '', string $message = '')
|
||||
{
|
||||
parent::__construct($message ?: "Некорректный адрес места расчётов: '$address'");
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при ошибке валидации номера телефона
|
||||
@@ -31,6 +32,7 @@ class InvalidPhoneException extends AtolException
|
||||
*
|
||||
* @param string $phone
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $phone = '')
|
||||
{
|
||||
parent::__construct("Невалидный номер телефона: '$phone'");
|
||||
|
||||
@@ -11,6 +11,8 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при ошибке валидации UUID
|
||||
*/
|
||||
@@ -19,13 +21,11 @@ class InvalidUuidException extends AtolException
|
||||
/**
|
||||
* Конструктор
|
||||
*
|
||||
* @param $uuid
|
||||
* @param string $message
|
||||
* @param int $code
|
||||
* @param Throwable|null $previous
|
||||
* @param string $uuid
|
||||
*/
|
||||
public function __construct(?string $uuid = null)
|
||||
#[Pure]
|
||||
public function __construct(string $uuid = '')
|
||||
{
|
||||
parent::__construct('Невалидный UUID' . ($uuid ? ': ' . $uuid : ''));
|
||||
parent::__construct('Невалидный UUID: ' . $uuid);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать предмету расчёта отрицательный акциз
|
||||
@@ -26,6 +27,7 @@ class NegativeItemExciseException extends AtolException
|
||||
* @param string $name
|
||||
* @param float $excise
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, float $excise)
|
||||
{
|
||||
parent::__construct("Предмет расчёта '$name' не может иметь отрицательный акциз $excise");
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать предмету расчёта отрицательную цену
|
||||
@@ -26,6 +27,7 @@ class NegativeItemPriceException extends AtolException
|
||||
* @param string $name
|
||||
* @param float $price
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, float $price)
|
||||
{
|
||||
parent::__construct("Предмет расчёта '$name' не может иметь отрицательную цену $price");
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать предмету расчёта отрицательное количество
|
||||
@@ -26,6 +27,7 @@ class NegativeItemQuantityException extends AtolException
|
||||
* @param string $name
|
||||
* @param float $quantity
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, float $quantity)
|
||||
{
|
||||
parent::__construct("Предмет расчёта '$name' не может иметь отрицательное количество $quantity");
|
||||
|
||||
@@ -12,6 +12,7 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать оплате отрицательную сумму
|
||||
@@ -31,6 +32,7 @@ class NegativePaymentSumException extends AtolException
|
||||
*
|
||||
* @param float $sum
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(float $sum)
|
||||
{
|
||||
parent::__construct('Размер оплаты не может быть отрицательным: ' . $sum);
|
||||
|
||||
@@ -11,6 +11,8 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке создать объект ККТ с неполными данными от монитора
|
||||
*/
|
||||
@@ -27,6 +29,7 @@ class NotEnoughMonitorDataException extends AtolException
|
||||
* @param array $props_diff
|
||||
* @param string $message
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(array $props_diff, string $message = '')
|
||||
{
|
||||
parent::__construct($message ?: $this->message . implode(', ', $props_diff));
|
||||
|
||||
@@ -13,6 +13,7 @@ namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать слишком высокую цену (сумму) предмета расчёта
|
||||
@@ -28,6 +29,7 @@ class TooHighItemPriceException extends TooManyException
|
||||
* @param string $name
|
||||
* @param float $price
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, float $price)
|
||||
{
|
||||
parent::__construct($price, "Слишком высокая цена для предмета расчёта '$name'");
|
||||
|
||||
@@ -13,6 +13,7 @@ namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке добавить слишком большое количество предмета расчёта
|
||||
@@ -28,6 +29,7 @@ class TooHighItemQuantityException extends TooManyException
|
||||
* @param string $name
|
||||
* @param float $quantity
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, float $quantity)
|
||||
{
|
||||
parent::__construct($quantity, "Слишком большое количество предмета расчёта '$name'");
|
||||
|
||||
@@ -13,6 +13,7 @@ namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке получеиня слишком высокой стоимости предмета расчёта
|
||||
@@ -28,6 +29,7 @@ class TooHighItemSumException extends TooManyException
|
||||
* @param string $name
|
||||
* @param float $sum
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, float $sum)
|
||||
{
|
||||
parent::__construct($sum, "Слишком высокая стоимость предмета расчёта '$name'");
|
||||
|
||||
@@ -18,6 +18,6 @@ use AtolOnline\Constants\Constraints;
|
||||
*/
|
||||
class TooLongCallbackUrlException extends TooLongException
|
||||
{
|
||||
protected $message = 'Слишком длинный адрес колбека';
|
||||
protected $message = 'Слишком длинный callback_url';
|
||||
protected float $max = Constraints::MAX_LENGTH_CALLBACK_URL;
|
||||
}
|
||||
|
||||
@@ -11,6 +11,8 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать слишком длинное что-либо
|
||||
*/
|
||||
@@ -33,6 +35,7 @@ class TooLongException extends AtolException
|
||||
* @param string $message
|
||||
* @param float $max
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $value, string $message = '', float $max = 0)
|
||||
{
|
||||
parent::__construct(
|
||||
|
||||
@@ -13,6 +13,7 @@ namespace AtolOnline\Exceptions;
|
||||
|
||||
use AtolOnline\Constants\Constraints;
|
||||
use AtolOnline\Constants\Ffd105Tags;
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать слишком длинный код товара
|
||||
@@ -28,6 +29,7 @@ class TooLongItemCodeException extends TooLongException
|
||||
* @param string $name
|
||||
* @param string $code
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(string $name, string $code)
|
||||
{
|
||||
parent::__construct($code, "Слишком длинный код товара '$name'");
|
||||
|
||||
@@ -11,6 +11,8 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline\Exceptions;
|
||||
|
||||
use JetBrains\PhpStorm\Pure;
|
||||
|
||||
/**
|
||||
* Исключение, возникающее при попытке указать слишком большое количество чего-либо
|
||||
*/
|
||||
@@ -33,6 +35,7 @@ class TooManyException extends AtolException
|
||||
* @param string $message
|
||||
* @param float|null $max
|
||||
*/
|
||||
#[Pure]
|
||||
public function __construct(float $value, string $message = '', ?float $max = null)
|
||||
{
|
||||
parent::__construct(
|
||||
|
||||
@@ -11,6 +11,8 @@ declare(strict_types = 1);
|
||||
|
||||
namespace AtolOnline;
|
||||
|
||||
use JetBrains\PhpStorm\ArrayShape;
|
||||
|
||||
/**
|
||||
* Константы, определяющие параметры тестовых сред
|
||||
*
|
||||
@@ -23,6 +25,16 @@ final class TestEnvParams
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
#[ArrayShape([
|
||||
'endpoint' => "string",
|
||||
'company_name' => "string",
|
||||
'inn' => "string",
|
||||
'payment_address' => "string",
|
||||
'group' => "string",
|
||||
'login' => "string",
|
||||
'password' => "string",
|
||||
'endpoint_ofd' => "string",
|
||||
])]
|
||||
public static function FFD105(): array
|
||||
{
|
||||
return [
|
||||
@@ -43,6 +55,16 @@ final class TestEnvParams
|
||||
* @return string[]
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
#[ArrayShape([
|
||||
'endpoint' => "string",
|
||||
'company_name' => "string",
|
||||
'inn' => "string",
|
||||
'payment_address' => "string",
|
||||
'group' => "string",
|
||||
'login' => "string",
|
||||
'password' => "string",
|
||||
'endpoint_ofd' => "string",
|
||||
])]
|
||||
public static function FFD12(): array
|
||||
{
|
||||
return [
|
||||
|
||||
@@ -41,7 +41,7 @@ trait HasEmail
|
||||
throw new InvalidEmailException($email);
|
||||
}
|
||||
}
|
||||
$this->email = empty($email) ? null : $email;
|
||||
$this->email = $email ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ trait HasInn
|
||||
throw new InvalidInnLengthException($inn);
|
||||
}
|
||||
}
|
||||
$this->inn = empty($inn) ? null : $inn;
|
||||
$this->inn = $inn ?: null;
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
400
tests/AtolOnline/Tests/Api/FiscalizerTest.php
Normal file
400
tests/AtolOnline/Tests/Api/FiscalizerTest.php
Normal file
@@ -0,0 +1,400 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
namespace AtolOnline\Tests\Api;
|
||||
|
||||
use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Helpers,
|
||||
TestEnvParams,
|
||||
Tests\BasicTestCase};
|
||||
use AtolOnline\Api\{
|
||||
AtolClient,
|
||||
Fiscalizer};
|
||||
use AtolOnline\Exceptions\{
|
||||
AuthFailedException,
|
||||
EmptyCorrectionNumberException,
|
||||
EmptyGroupException,
|
||||
EmptyItemNameException,
|
||||
EmptyItemsException,
|
||||
EmptyLoginException,
|
||||
EmptyPasswordException,
|
||||
InvalidCallbackUrlException,
|
||||
InvalidCorrectionDateException,
|
||||
InvalidEntityInCollectionException,
|
||||
InvalidEnumValueException,
|
||||
InvalidInnLengthException,
|
||||
InvalidPaymentAddressException,
|
||||
InvalidUuidException,
|
||||
NegativeItemPriceException,
|
||||
NegativeItemQuantityException,
|
||||
NegativePaymentSumException,
|
||||
TooHighItemPriceException,
|
||||
TooHighPaymentSumException,
|
||||
TooLongCallbackUrlException,
|
||||
TooLongItemNameException,
|
||||
TooLongPaymentAddressException,
|
||||
TooManyException};
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
/**
|
||||
* Набор тестов для проверки работы фискализатора
|
||||
*/
|
||||
class FiscalizerTest extends BasicTestCase
|
||||
{
|
||||
/**
|
||||
* @var array Массив UUID-ов результатов регистрации документов для переиспользования
|
||||
* в тестах получения их статусов фискализации
|
||||
*/
|
||||
private static array $registered_uuids = [];
|
||||
|
||||
/**
|
||||
* Тестирует успешное создание объекта фискализатора без аргументов конструктора
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer
|
||||
*/
|
||||
public function testConstructorWithourArgs(): void
|
||||
{
|
||||
$fisc = new Fiscalizer();
|
||||
$this->assertIsObject($fisc);
|
||||
$this->assertIsSameClass(Fiscalizer::class, $fisc);
|
||||
$this->assertExtendsClasses([AtolClient::class], $fisc);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку и возврат группы ККТ
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getGroup
|
||||
* @covers \AtolOnline\Api\Fiscalizer::setGroup
|
||||
*/
|
||||
public function testGroup(): void
|
||||
{
|
||||
// test mode
|
||||
$this->assertEquals(
|
||||
TestEnvParams::FFD105()['group'],
|
||||
(new Fiscalizer(group: 'group'))->getGroup()
|
||||
);
|
||||
// prod mode
|
||||
$this->assertEquals('group', (new Fiscalizer(false, group: 'group'))->getGroup());
|
||||
$this->assertNull((new Fiscalizer(false))->getGroup());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при попытке передать пустую группу ККТ в конструктор
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer
|
||||
* @covers \AtolOnline\Api\Fiscalizer::setGroup
|
||||
* @covers \AtolOnline\Exceptions\EmptyGroupException
|
||||
*/
|
||||
public function testEmptyGroupException(): void
|
||||
{
|
||||
$this->expectException(EmptyGroupException::class);
|
||||
new Fiscalizer(group: "\n\r \0\t");
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при попытке установить слишком длинный адрес колбека
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer::setCallbackUrl
|
||||
* @covers \AtolOnline\Exceptions\TooLongCallbackUrlException
|
||||
* @throws InvalidCallbackUrlException
|
||||
* @throws TooLongCallbackUrlException
|
||||
*/
|
||||
public function testTooLongCallbackUrlException(): void
|
||||
{
|
||||
$this->expectException(TooLongCallbackUrlException::class);
|
||||
(new Fiscalizer())->setCallbackUrl(Helpers::randomStr(Constraints::MAX_LENGTH_CALLBACK_URL + 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при попытке установить слишком длинный адрес колбека
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer::setCallbackUrl
|
||||
* @covers \AtolOnline\Exceptions\InvalidCallbackUrlException
|
||||
* @throws InvalidCallbackUrlException
|
||||
* @throws TooLongCallbackUrlException
|
||||
*/
|
||||
public function testInvalidCallbackUrlException(): void
|
||||
{
|
||||
$this->expectException(InvalidCallbackUrlException::class);
|
||||
(new Fiscalizer())->setCallbackUrl(Helpers::randomStr());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует обнуление адреса колбека
|
||||
*
|
||||
* @param mixed $param
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer::setCallbackUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getCallbackUrl
|
||||
* @dataProvider providerNullableStrings
|
||||
* @throws InvalidCallbackUrlException
|
||||
* @throws TooLongCallbackUrlException
|
||||
*/
|
||||
public function testNullableCallbackUrl(mixed $param): void
|
||||
{
|
||||
$this->assertNull((new Fiscalizer())->setCallbackUrl($param)->getCallbackUrl());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует регистрацию документа прихода
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::sell
|
||||
* @covers \AtolOnline\Api\Fiscalizer::sell
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getFullUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::registerDocument
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function testSell(): void
|
||||
{
|
||||
$fisc_result = $this->newReceipt()->sell(new Fiscalizer());
|
||||
$this->assertTrue($fisc_result->isSuccessful());
|
||||
$this->assertEquals('wait', $fisc_result->getContent()->status);
|
||||
self::$registered_uuids[] = $fisc_result->getContent()->uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует регистрацию документа возврата прихода
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::sellRefund
|
||||
* @covers \AtolOnline\Api\Fiscalizer::sellRefund
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getFullUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::registerDocument
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function testSellRefund(): void
|
||||
{
|
||||
$fisc_result = $this->newReceipt()->sellRefund(new Fiscalizer());
|
||||
$this->assertTrue($fisc_result->isSuccessful());
|
||||
$this->assertEquals('wait', $fisc_result->getContent()->status);
|
||||
self::$registered_uuids[] = $fisc_result->getContent()->uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует регистрацию документа возврата прихода
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Correction::sellCorrect
|
||||
* @covers \AtolOnline\Api\Fiscalizer::sellCorrect
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getFullUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::registerDocument
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
*/
|
||||
public function testSellCorrect(): void
|
||||
{
|
||||
$fisc_result = $this->newCorrection()->sellCorrect(new Fiscalizer());
|
||||
$this->assertTrue($fisc_result->isSuccessful());
|
||||
$this->assertEquals('wait', $fisc_result->getContent()->status);
|
||||
//self::$registered_uuids[] = $fisc_result->getContent()->uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует регистрацию документа расхода
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::buy
|
||||
* @covers \AtolOnline\Api\Fiscalizer::buy
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getFullUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::registerDocument
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function testBuy(): void
|
||||
{
|
||||
$fisc_result = $this->newReceipt()->buy(new Fiscalizer());
|
||||
$this->assertTrue($fisc_result->isSuccessful());
|
||||
$this->assertEquals('wait', $fisc_result->getContent()->status);
|
||||
//self::$registered_uuids[] = $fisc_result->getContent()->uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует регистрацию документа возврата расхода
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::buyRefund
|
||||
* @covers \AtolOnline\Api\Fiscalizer::buyRefund
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getFullUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::registerDocument
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws TooManyException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
public function testBuyRefund(): void
|
||||
{
|
||||
$fisc_result = $this->newReceipt()->buyRefund(new Fiscalizer());
|
||||
$this->assertTrue($fisc_result->isSuccessful());
|
||||
$this->assertEquals('wait', $fisc_result->getContent()->status);
|
||||
//self::$registered_uuids[] = $fisc_result->getContent()->uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует регистрацию документа возврата прихода
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Correction::buyCorrect
|
||||
* @covers \AtolOnline\Api\Fiscalizer::buyCorrect
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getFullUrl
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Fiscalizer::registerDocument
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidInnLengthException
|
||||
* @throws InvalidPaymentAddressException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongPaymentAddressException
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
*/
|
||||
public function testBuyCorrect(): void
|
||||
{
|
||||
$fisc_result = $this->newCorrection()->buyCorrect(new Fiscalizer());
|
||||
$this->assertTrue($fisc_result->isSuccessful());
|
||||
$this->assertEquals('wait', $fisc_result->getContent()->status);
|
||||
//self::$registered_uuids[] = $fisc_result->getContent()->uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует разовое получение статуса фискализации документа
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer::getDocumentStatus
|
||||
* @depends testSell
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidUuidException
|
||||
*/
|
||||
public function testGetDocumentStatus(): void
|
||||
{
|
||||
$fisc_status = (new Fiscalizer())->getDocumentStatus(array_shift(self::$registered_uuids));
|
||||
$this->assertTrue($fisc_status->isSuccessful());
|
||||
$this->assertTrue(in_array($fisc_status->getContent()->status, ['wait', 'done']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует опрос API на получение статуса фискализации документа
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Api\Fiscalizer::pollDocumentStatus
|
||||
* @depends testSellRefund
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws GuzzleException
|
||||
* @throws InvalidUuidException
|
||||
*/
|
||||
public function testPollDocumentStatus(): void
|
||||
{
|
||||
$fisc_status = (new Fiscalizer())->pollDocumentStatus(array_shift(self::$registered_uuids));
|
||||
$this->assertTrue($fisc_status->isSuccessful());
|
||||
$this->assertEquals('done', $fisc_status->getContent()->status);
|
||||
}
|
||||
}
|
||||
@@ -10,8 +10,8 @@
|
||||
namespace AtolOnline\Tests\Api;
|
||||
|
||||
use AtolOnline\Api\AtolClient;
|
||||
use AtolOnline\Api\KktMonitor;
|
||||
use AtolOnline\Api\KktResponse;
|
||||
use AtolOnline\Api\AtolResponse;
|
||||
use AtolOnline\Api\Monitor;
|
||||
use AtolOnline\Entities\Kkt;
|
||||
use AtolOnline\Exceptions\AuthFailedException;
|
||||
use AtolOnline\Exceptions\EmptyLoginException;
|
||||
@@ -29,46 +29,45 @@ use GuzzleHttp\Exception\GuzzleException;
|
||||
/**
|
||||
* Набор тестов для проверки работы API-клиента на примере монитора ККТ
|
||||
*/
|
||||
class KktMonitorTest extends BasicTestCase
|
||||
class MonitorTest extends BasicTestCase
|
||||
{
|
||||
/**
|
||||
* Возвращает объект клиента для тестирования с тестовым API АТОЛ
|
||||
* Возвращает объект монитора для тестирования с тестовым API АТОЛ
|
||||
*
|
||||
* @return KktMonitor
|
||||
* @return Monitor
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongLoginException
|
||||
* @throws TooLongPasswordException
|
||||
*/
|
||||
private function newTestClient(): KktMonitor
|
||||
private function newTestClient(): Monitor
|
||||
{
|
||||
$credentials = TestEnvParams::FFD105();
|
||||
return (new KktMonitor(true))
|
||||
->setLogin($credentials['login'])
|
||||
->setPassword($credentials['password']);
|
||||
return (new Monitor(true))
|
||||
->setLogin(TestEnvParams::FFD105()['login'])
|
||||
->setPassword(TestEnvParams::FFD105()['password']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует успешное создание объекта монитора без аргументов конструктора
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
*/
|
||||
public function testConstructorWithoutArgs(): void
|
||||
{
|
||||
$client = new KktMonitor();
|
||||
$client = new Monitor();
|
||||
$this->assertIsObject($client);
|
||||
$this->assertIsSameClass(KktMonitor::class, $client);
|
||||
$this->assertIsSameClass(Monitor::class, $client);
|
||||
$this->assertExtendsClasses([AtolClient::class], $client);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует успешное создание объекта монитора с аргументами конструктора
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::setLogin
|
||||
* @covers \AtolOnline\Api\KktMonitor::getLogin
|
||||
* @covers \AtolOnline\Api\KktMonitor::setPassword
|
||||
* @covers \AtolOnline\Api\KktMonitor::getPassword
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::setLogin
|
||||
* @covers \AtolOnline\Api\Monitor::getLogin
|
||||
* @covers \AtolOnline\Api\Monitor::setPassword
|
||||
* @covers \AtolOnline\Api\Monitor::getPassword
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongLoginException
|
||||
@@ -76,51 +75,52 @@ class KktMonitorTest extends BasicTestCase
|
||||
*/
|
||||
public function testConstructorWithArgs(): void
|
||||
{
|
||||
$client = new KktMonitor(false, 'login', 'password', []);
|
||||
$client = new Monitor(false, 'login', 'password', []);
|
||||
$this->assertIsObject($client);
|
||||
$this->assertIsSameClass($client, KktMonitor::class);
|
||||
$this->assertIsSameClass($client, Monitor::class);
|
||||
$this->assertExtendsClasses([AtolClient::class], $client);
|
||||
}
|
||||
//
|
||||
|
||||
/**
|
||||
* Тестирует установку и возврат логина
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::getLogin
|
||||
* @covers \AtolOnline\Api\KktMonitor::setLogin
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::getLogin
|
||||
* @covers \AtolOnline\Api\Monitor::setLogin
|
||||
* @throws EmptyLoginException
|
||||
* @throws TooLongLoginException
|
||||
*/
|
||||
public function testLogin(): void
|
||||
{
|
||||
$client = new KktMonitor(login: 'login');
|
||||
$client = new Monitor(false, login: 'login');
|
||||
$this->assertEquals('login', $client->getLogin());
|
||||
|
||||
$client = new KktMonitor();
|
||||
$this->assertNull($client->getLogin());
|
||||
$client = new Monitor();
|
||||
$this->assertEquals(TestEnvParams::FFD105()['login'], $client->getLogin());
|
||||
|
||||
$client->setLogin('login');
|
||||
$this->assertEquals('login', $client->getLogin());
|
||||
$this->assertEquals(TestEnvParams::FFD105()['login'], $client->getLogin());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует исключение при попытке передать пустой логин в конструктор
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::setLogin
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::setLogin
|
||||
* @covers \AtolOnline\Exceptions\EmptyLoginException
|
||||
*/
|
||||
public function testEmptyLoginException(): void
|
||||
{
|
||||
$this->expectException(EmptyLoginException::class);
|
||||
new KktMonitor(login: '');
|
||||
new Monitor(login: '');
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует исключение при попытке передать слишком длинный логин в конструктор
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::setLogin
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::setLogin
|
||||
* @covers \AtolOnline\Exceptions\TooLongLoginException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
@@ -130,48 +130,48 @@ class KktMonitorTest extends BasicTestCase
|
||||
public function testTooLongLoginException(): void
|
||||
{
|
||||
$this->expectException(TooLongLoginException::class);
|
||||
new KktMonitor(login: Helpers::randomStr(101));
|
||||
new Monitor(login: Helpers::randomStr(101));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку и возврат пароля
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::getPassword
|
||||
* @covers \AtolOnline\Api\KktMonitor::setPassword
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::getPassword
|
||||
* @covers \AtolOnline\Api\Monitor::setPassword
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongPasswordException
|
||||
*/
|
||||
public function testPassword(): void
|
||||
{
|
||||
$client = new KktMonitor(password: 'password');
|
||||
$client = new Monitor(false, password: 'password');
|
||||
$this->assertEquals('password', $client->getPassword());
|
||||
|
||||
$client = new KktMonitor();
|
||||
$this->assertNull($client->getPassword());
|
||||
$client = new Monitor();
|
||||
$this->assertEquals(TestEnvParams::FFD105()['password'], $client->getPassword());
|
||||
|
||||
$client->setPassword('password');
|
||||
$this->assertEquals('password', $client->getPassword());
|
||||
$this->assertEquals(TestEnvParams::FFD105()['password'], $client->getPassword());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует исключение при попытке передать пустой пароль в конструктор
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::setPassword
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::setPassword
|
||||
* @covers \AtolOnline\Exceptions\EmptyPasswordException
|
||||
*/
|
||||
public function testEmptyPasswordException(): void
|
||||
{
|
||||
$this->expectException(EmptyPasswordException::class);
|
||||
new KktMonitor(password: '');
|
||||
new Monitor(password: '');
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует исключение при попытке передать слишком длинный пароль в конструктор
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::setPassword
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::setPassword
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
* @throws TooLongLoginException
|
||||
@@ -180,34 +180,34 @@ class KktMonitorTest extends BasicTestCase
|
||||
public function testConstructorWithLongPassword(): void
|
||||
{
|
||||
$this->expectException(TooLongPasswordException::class);
|
||||
new KktMonitor(password: Helpers::randomStr(101));
|
||||
new Monitor(password: Helpers::randomStr(101));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку тестового режима
|
||||
*
|
||||
* @covers \AtolOnline\Api\KktMonitor::__construct
|
||||
* @covers \AtolOnline\Api\KktMonitor::isTestMode
|
||||
* @covers \AtolOnline\Api\KktMonitor::setTestMode
|
||||
* @covers \AtolOnline\Api\Monitor::__construct
|
||||
* @covers \AtolOnline\Api\Monitor::isTestMode
|
||||
* @covers \AtolOnline\Api\Monitor::setTestMode
|
||||
*/
|
||||
public function testTestMode(): void
|
||||
{
|
||||
$client = new KktMonitor();
|
||||
$client = new Monitor();
|
||||
$this->assertTrue($client->isTestMode());
|
||||
|
||||
$client = new KktMonitor(true);
|
||||
$client = new Monitor(true);
|
||||
$this->assertTrue($client->isTestMode());
|
||||
|
||||
$client = new KktMonitor(false);
|
||||
$client = new Monitor(false);
|
||||
$this->assertFalse($client->isTestMode());
|
||||
|
||||
$client = (new KktMonitor())->setTestMode();
|
||||
$client = (new Monitor())->setTestMode();
|
||||
$this->assertTrue($client->isTestMode());
|
||||
|
||||
$client = (new KktMonitor())->setTestMode(true);
|
||||
$client = (new Monitor())->setTestMode(true);
|
||||
$this->assertTrue($client->isTestMode());
|
||||
|
||||
$client = (new KktMonitor())->setTestMode(false);
|
||||
$client = (new Monitor())->setTestMode(false);
|
||||
$this->assertFalse($client->isTestMode());
|
||||
}
|
||||
|
||||
@@ -215,10 +215,10 @@ class KktMonitorTest extends BasicTestCase
|
||||
* Тестирует авторизацию
|
||||
*
|
||||
* @covers \AtolOnline\Api\AtolClient::getHeaders
|
||||
* @covers \AtolOnline\Api\KktMonitor::sendRequest
|
||||
* @covers \AtolOnline\Api\KktMonitor::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\KktMonitor::doAuth
|
||||
* @covers \AtolOnline\Api\KktMonitor::auth
|
||||
* @covers \AtolOnline\Api\Monitor::sendRequest
|
||||
* @covers \AtolOnline\Api\Monitor::getAuthEndpoint
|
||||
* @covers \AtolOnline\Api\Monitor::doAuth
|
||||
* @covers \AtolOnline\Api\Monitor::auth
|
||||
* @covers \AtolOnline\Exceptions\AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
* @throws EmptyPasswordException
|
||||
@@ -238,8 +238,8 @@ class KktMonitorTest extends BasicTestCase
|
||||
* Тестирует возврат токена после авторизации
|
||||
*
|
||||
* @depends testAuth
|
||||
* @covers \AtolOnline\Api\KktMonitor::setToken
|
||||
* @covers \AtolOnline\Api\KktMonitor::getToken
|
||||
* @covers \AtolOnline\Api\Monitor::setToken
|
||||
* @covers \AtolOnline\Api\Monitor::getToken
|
||||
* @covers \AtolOnline\Exceptions\AuthFailedException
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
@@ -250,7 +250,7 @@ class KktMonitorTest extends BasicTestCase
|
||||
*/
|
||||
public function testGetToken(): void
|
||||
{
|
||||
$client = new KktMonitor();
|
||||
$client = new Monitor();
|
||||
$this->assertNull($client->getToken());
|
||||
|
||||
$this->skipIfMonitoringIsOffline();
|
||||
@@ -263,7 +263,7 @@ class KktMonitorTest extends BasicTestCase
|
||||
* Тестирует возврат объекта последнего ответа от API
|
||||
*
|
||||
* @depends testAuth
|
||||
* @covers \AtolOnline\Api\KktMonitor::getResponse
|
||||
* @covers \AtolOnline\Api\Monitor::getLastResponse
|
||||
* @covers \AtolOnline\Exceptions\AuthFailedException
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
@@ -277,17 +277,17 @@ class KktMonitorTest extends BasicTestCase
|
||||
$this->skipIfMonitoringIsOffline();
|
||||
$client = $this->newTestClient();
|
||||
$client->auth();
|
||||
$this->assertIsSameClass(KktResponse::class, $client->getResponse());
|
||||
$this->assertIsSameClass(AtolResponse::class, $client->getLastResponse());
|
||||
}
|
||||
|
||||
/**
|
||||
* [Мониторинг] Тестирует получение данных о всех ККТ
|
||||
*
|
||||
* @depends testAuth
|
||||
* @covers \AtolOnline\Api\KktMonitor::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Monitor::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\AtolClient::getUrlToMethod
|
||||
* @covers \AtolOnline\Api\KktMonitor::fetchAll
|
||||
* @covers \AtolOnline\Api\KktMonitor::getAll
|
||||
* @covers \AtolOnline\Api\Monitor::fetchAll
|
||||
* @covers \AtolOnline\Api\Monitor::getAll
|
||||
* @covers \AtolOnline\Exceptions\AuthFailedException
|
||||
* @throws AuthFailedException
|
||||
* @throws EmptyLoginException
|
||||
@@ -302,7 +302,8 @@ class KktMonitorTest extends BasicTestCase
|
||||
$client = $this->newTestClient();
|
||||
$client->auth();
|
||||
$kkts = $client->getAll();
|
||||
$this->assertNotEmpty($client->getResponse()->getContent());
|
||||
$sss = $kkts->where('deviceNumber', 'KKT014034');
|
||||
$this->assertNotEmpty($client->getLastResponse()->getContent());
|
||||
$this->assertIsCollection($kkts);
|
||||
$this->assertTrue($kkts->count() > 0);
|
||||
$this->assertIsSameClass(Kkt::class, $kkts->random());
|
||||
@@ -312,10 +313,10 @@ class KktMonitorTest extends BasicTestCase
|
||||
* [Мониторинг] Тестирует получение данных о конкретной ККТ
|
||||
*
|
||||
* @depends testAuth
|
||||
* @covers \AtolOnline\Api\KktMonitor::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\Monitor::getMainEndpoint
|
||||
* @covers \AtolOnline\Api\AtolClient::getUrlToMethod
|
||||
* @covers \AtolOnline\Api\KktMonitor::fetchOne
|
||||
* @covers \AtolOnline\Api\KktMonitor::getOne
|
||||
* @covers \AtolOnline\Api\Monitor::fetchOne
|
||||
* @covers \AtolOnline\Api\Monitor::getOne
|
||||
* @covers \AtolOnline\Entities\Kkt::__construct
|
||||
* @covers \AtolOnline\Entities\Kkt::__get
|
||||
* @covers \AtolOnline\Entities\Kkt::jsonSerialize
|
||||
@@ -337,7 +338,7 @@ class KktMonitorTest extends BasicTestCase
|
||||
$client->auth();
|
||||
$serial_number = $client->getAll()->first()->serialNumber;
|
||||
$kkt = $client->getOne($serial_number);
|
||||
$this->assertNotEmpty($client->getResponse());
|
||||
$this->assertNotEmpty($client->getLastResponse());
|
||||
$this->assertIsSameClass(Kkt::class, $kkt);
|
||||
$this->assertIsAtolable($kkt);
|
||||
$this->assertNotNull($kkt->serialNumber);
|
||||
@@ -12,13 +12,27 @@ declare(strict_types = 1);
|
||||
namespace AtolOnline\Tests;
|
||||
|
||||
use AtolOnline\Collections\EntityCollection;
|
||||
use AtolOnline\Collections\Items;
|
||||
use AtolOnline\Collections\Payments;
|
||||
use AtolOnline\Collections\Vats;
|
||||
use AtolOnline\Entities\Client;
|
||||
use AtolOnline\Entities\Company;
|
||||
use AtolOnline\Entities\Correction;
|
||||
use AtolOnline\Entities\CorrectionInfo;
|
||||
use AtolOnline\Entities\Entity;
|
||||
use AtolOnline\Entities\Item;
|
||||
use AtolOnline\Entities\Payment;
|
||||
use AtolOnline\Entities\Receipt;
|
||||
use AtolOnline\Entities\Vat;
|
||||
use AtolOnline\Enums\CorrectionTypes;
|
||||
use AtolOnline\Enums\PaymentTypes;
|
||||
use AtolOnline\Enums\SnoTypes;
|
||||
use AtolOnline\Enums\VatTypes;
|
||||
use AtolOnline\Exceptions\EmptyCorrectionNumberException;
|
||||
use AtolOnline\Exceptions\EmptyItemNameException;
|
||||
use AtolOnline\Exceptions\EmptyItemsException;
|
||||
use AtolOnline\Exceptions\InvalidCorrectionDateException;
|
||||
use AtolOnline\Exceptions\InvalidEntityInCollectionException;
|
||||
use AtolOnline\Exceptions\InvalidEnumValueException;
|
||||
use AtolOnline\Exceptions\NegativeItemPriceException;
|
||||
use AtolOnline\Exceptions\NegativeItemQuantityException;
|
||||
@@ -29,7 +43,7 @@ use AtolOnline\Exceptions\TooLongItemNameException;
|
||||
use AtolOnline\Exceptions\TooManyException;
|
||||
use AtolOnline\Helpers;
|
||||
use Exception;
|
||||
use GuzzleHttp\Client;
|
||||
use GuzzleHttp\Client as GuzzleClient;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use Illuminate\Support\Collection;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
@@ -53,7 +67,7 @@ class BasicTestCase extends TestCase
|
||||
protected function ping(string $url, int $code): bool
|
||||
{
|
||||
try {
|
||||
$result = (new Client([
|
||||
$result = (new GuzzleClient([
|
||||
'http_errors' => false,
|
||||
'timeout' => 3,
|
||||
]))->request('GET', $url);
|
||||
@@ -93,6 +107,7 @@ class BasicTestCase extends TestCase
|
||||
* @param Entity|EntityCollection $entity
|
||||
* @param array|null $json_structure
|
||||
* @covers \AtolOnline\Entities\Entity::__toString
|
||||
* @covers \AtolOnline\Entities\Entity::toArray
|
||||
* @covers \AtolOnline\Entities\Entity::jsonSerialize
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @throws Exception
|
||||
@@ -100,6 +115,8 @@ class BasicTestCase extends TestCase
|
||||
public function assertIsAtolable(Entity|EntityCollection $entity, ?array $json_structure = null): void
|
||||
{
|
||||
$this->assertIsArray($entity->jsonSerialize());
|
||||
$this->assertIsArray($entity->toArray());
|
||||
$this->assertEquals($entity->jsonSerialize(), $entity->toArray());
|
||||
$this->assertIsString((string)$entity);
|
||||
$this->assertJson((string)$entity);
|
||||
if (!is_null($json_structure)) {
|
||||
@@ -384,4 +401,51 @@ class BasicTestCase extends TestCase
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает валидный тестовый объект чека прихода
|
||||
*
|
||||
* @return Receipt
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
protected function newReceipt(): Receipt
|
||||
{
|
||||
return new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+79501234567', '1234567890'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items($this->generateItemObjects(2)),
|
||||
new Payments($this->generatePaymentObjects())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает валидный тестовый объект чека
|
||||
*
|
||||
* @return Correction
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
*/
|
||||
protected function newCorrection(): Correction
|
||||
{
|
||||
return new Correction(
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new CorrectionInfo(CorrectionTypes::SELF, '01.01.2021', Helpers::randomStr()),
|
||||
new Payments($this->generatePaymentObjects(2)),
|
||||
new Vats($this->generateVatObjects(2)),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,6 +15,7 @@ use AtolOnline\{
|
||||
Tests\BasicTestCase};
|
||||
use AtolOnline\Exceptions\{
|
||||
EmptyItemNameException,
|
||||
EmptyItemsException,
|
||||
InvalidEntityInCollectionException,
|
||||
NegativeItemPriceException,
|
||||
NegativeItemQuantityException,
|
||||
@@ -29,10 +30,12 @@ use AtolOnline\Exceptions\{
|
||||
class ItemsTest extends BasicTestCase
|
||||
{
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком большого количества оплат через конструктор
|
||||
* Тестирует выброс исключения при установке слишком большого количества предметов расчёта
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @covers \AtolOnline\Exceptions\TooManyItemsException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws NegativeItemPriceException
|
||||
@@ -42,96 +45,25 @@ class ItemsTest extends BasicTestCase
|
||||
* @throws TooManyException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyItemsExceptionByConstructor()
|
||||
public function testTooManyItemsException()
|
||||
{
|
||||
$this->expectException(TooManyItemsException::class);
|
||||
new Items($this->generateItemObjects(Constraints::MAX_COUNT_DOC_ITEMS + 1));
|
||||
(new Items($this->generateItemObjects(Constraints::MAX_COUNT_DOC_ITEMS + 1)))->jsonSerialize();
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection::prepend
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyItemsException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyItemsExceptionByPrepend()
|
||||
{
|
||||
$this->expectException(TooManyItemsException::class);
|
||||
(new Items($this->generateItemObjects(Constraints::MAX_COUNT_DOC_ITEMS)))
|
||||
->prepend($this->generateItemObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в конец коллекции
|
||||
* Тестирует выброс исключения при установке нулевого количества предметов расчёта
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::add
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyItemsException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @covers \AtolOnline\Exceptions\EmptyItemsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyItemsExceptionByAdd()
|
||||
public function testEmptyItemsException()
|
||||
{
|
||||
$this->expectException(TooManyItemsException::class);
|
||||
(new Items($this->generateItemObjects(Constraints::MAX_COUNT_DOC_ITEMS)))
|
||||
->add($this->generateItemObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишних оплат в конец коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::push
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyItemsException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyItemsExceptionByPush()
|
||||
{
|
||||
$this->expectException(TooManyItemsException::class);
|
||||
(new Items($this->generateItemObjects(Constraints::MAX_COUNT_DOC_ITEMS)))
|
||||
->push(...$this->generateItemObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::merge
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyItemsException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyItemsExceptionByMerge()
|
||||
{
|
||||
$this->expectException(TooManyItemsException::class);
|
||||
(new Items($this->generateItemObjects(Constraints::MAX_COUNT_DOC_ITEMS)))
|
||||
->merge($this->generateItemObjects(2));
|
||||
$this->expectException(EmptyItemsException::class);
|
||||
(new Items([]))->jsonSerialize();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ namespace AtolOnline\Tests\Collections;
|
||||
use AtolOnline\{
|
||||
Collections\Payments,
|
||||
Constants\Constraints,
|
||||
Exceptions\EmptyPaymentsException,
|
||||
Exceptions\InvalidEntityInCollectionException,
|
||||
Exceptions\InvalidEnumValueException,
|
||||
Exceptions\NegativePaymentSumException,
|
||||
@@ -25,7 +26,7 @@ use AtolOnline\{
|
||||
class PaymentsTest extends BasicTestCase
|
||||
{
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком большого количества оплат через конструктор
|
||||
* Тестирует выброс исключения при установке слишком большого количества оплат
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
@@ -38,81 +39,21 @@ class PaymentsTest extends BasicTestCase
|
||||
public function testTooManyPaymentsExceptionByConstructor()
|
||||
{
|
||||
$this->expectException(TooManyPaymentsException::class);
|
||||
new Payments($this->generatePaymentObjects(Constraints::MAX_COUNT_DOC_PAYMENTS + 1));
|
||||
(new Payments($this->generatePaymentObjects(Constraints::MAX_COUNT_DOC_PAYMENTS + 1)))->jsonSerialize();
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection::prepend
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyPaymentsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyPaymentsExceptionByPrepend()
|
||||
{
|
||||
$this->expectException(TooManyPaymentsException::class);
|
||||
(new Payments($this->generatePaymentObjects(Constraints::MAX_COUNT_DOC_PAYMENTS)))
|
||||
->prepend($this->generatePaymentObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в конец коллекции
|
||||
* Тестирует выброс исключения при установке нулевого количества оплат
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::add
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyPaymentsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @covers \AtolOnline\Exceptions\EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyPaymentsExceptionByAdd()
|
||||
public function testEmptyPaymentsException()
|
||||
{
|
||||
$this->expectException(TooManyPaymentsException::class);
|
||||
(new Payments($this->generatePaymentObjects(Constraints::MAX_COUNT_DOC_PAYMENTS)))
|
||||
->add($this->generatePaymentObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишних оплат в конец коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::push
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyPaymentsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyPaymentsExceptionByPush()
|
||||
{
|
||||
$this->expectException(TooManyPaymentsException::class);
|
||||
(new Payments($this->generatePaymentObjects(Constraints::MAX_COUNT_DOC_PAYMENTS + 1)))
|
||||
->push(...$this->generatePaymentObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::merge
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyPaymentsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyPaymentsExceptionByMerge()
|
||||
{
|
||||
$this->expectException(TooManyPaymentsException::class);
|
||||
(new Payments($this->generatePaymentObjects(Constraints::MAX_COUNT_DOC_PAYMENTS - 1)))
|
||||
->merge($this->generatePaymentObjects(2));
|
||||
$this->expectException(EmptyPaymentsException::class);
|
||||
(new Payments([]))->jsonSerialize();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,6 +14,7 @@ use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Entities\Payment,
|
||||
Enums\PaymentTypes,
|
||||
Exceptions\EmptyVatsException,
|
||||
Exceptions\InvalidEntityInCollectionException,
|
||||
Exceptions\InvalidEnumValueException,
|
||||
Exceptions\NegativePaymentSumException,
|
||||
@@ -32,6 +33,8 @@ class VatsTest extends BasicTestCase
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws Exception
|
||||
*/
|
||||
@@ -44,150 +47,36 @@ class VatsTest extends BasicTestCase
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком большого количества ставок через конструктор
|
||||
* Тестирует выброс исключения при установке нулевого количества ставок
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @covers \AtolOnline\Exceptions\EmptyVatsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testEmptyVatsException()
|
||||
{
|
||||
$this->expectException(EmptyVatsException::class);
|
||||
(new Vats([]))->jsonSerialize();
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком большого количества ставок
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @covers \AtolOnline\Exceptions\TooManyVatsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyVatsExceptionByConstructor()
|
||||
public function testTooManyVatsException()
|
||||
{
|
||||
$this->expectException(TooManyVatsException::class);
|
||||
new Vats($this->generateVatObjects(Constraints::MAX_COUNT_DOC_VATS + 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует добавление ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::prepend
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testPrepend()
|
||||
{
|
||||
$vats = (new Vats($this->generateVatObjects(3)))
|
||||
->prepend($this->generateVatObjects());
|
||||
$this->assertEquals(4, $vats->count());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::prepend
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyVatsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyVatsExceptionByPrepend()
|
||||
{
|
||||
$this->expectException(TooManyVatsException::class);
|
||||
(new Vats($this->generateVatObjects(Constraints::MAX_COUNT_DOC_VATS)))
|
||||
->prepend($this->generateVatObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует добавление ставки в конец коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::add
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testAdd()
|
||||
{
|
||||
$vats = (new Vats($this->generateVatObjects(3)))
|
||||
->add($this->generateVatObjects());
|
||||
$this->assertEquals(4, $vats->count());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в конец коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::add
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyVatsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyVatsExceptionByAdd()
|
||||
{
|
||||
$this->expectException(TooManyVatsException::class);
|
||||
(new Vats($this->generateVatObjects(Constraints::MAX_COUNT_DOC_VATS)))
|
||||
->add($this->generateVatObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует добавление лишних ставок в конец коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::push
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testPush()
|
||||
{
|
||||
$vats = (new Vats($this->generateVatObjects(3)))
|
||||
->push(...$this->generateVatObjects(3));
|
||||
$this->assertEquals(6, $vats->count());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишних ставок в конец коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::push
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyVatsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyVatsExceptionByPush()
|
||||
{
|
||||
$this->expectException(TooManyVatsException::class);
|
||||
(new Vats($this->generateVatObjects(Constraints::MAX_COUNT_DOC_VATS)))
|
||||
->push(...$this->generateVatObjects());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует добавление ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::merge
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testMerge()
|
||||
{
|
||||
$vats = (new Vats($this->generateVatObjects(3)))
|
||||
->merge($this->generateVatObjects(3));
|
||||
$this->assertEquals(6, $vats->count());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при добавлении лишней ставки в начало коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::merge
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkCount
|
||||
* @covers \AtolOnline\Exceptions\TooManyVatsException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
*/
|
||||
public function testTooManyVatsExceptionByMerge()
|
||||
{
|
||||
$this->expectException(TooManyVatsException::class);
|
||||
(new Vats($this->generateVatObjects(Constraints::MAX_COUNT_DOC_VATS - 1)))
|
||||
->merge($this->generateVatObjects(2));
|
||||
(new Vats($this->generateVatObjects(Constraints::MAX_COUNT_DOC_VATS + 1)))->jsonSerialize();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -195,6 +84,7 @@ class VatsTest extends BasicTestCase
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemClass
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @covers \AtolOnline\Exceptions\InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
@@ -212,6 +102,9 @@ class VatsTest extends BasicTestCase
|
||||
/**
|
||||
* Тестирует выброс исключения при наличии объектов не тех классов в коллекции
|
||||
*
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemClass
|
||||
* @covers \AtolOnline\Collections\EntityCollection::checkItemsClasses
|
||||
* @covers \AtolOnline\Collections\EntityCollection::jsonSerialize
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
|
||||
@@ -9,15 +9,16 @@
|
||||
|
||||
namespace AtolOnline\Tests\Entities;
|
||||
|
||||
use AtolOnline\{
|
||||
Entities\Client,
|
||||
use AtolOnline\{Entities\Client,
|
||||
Exceptions\InvalidEmailException,
|
||||
Exceptions\InvalidInnLengthException,
|
||||
Exceptions\InvalidPhoneException,
|
||||
Exceptions\TooLongClientNameException,
|
||||
Exceptions\TooLongEmailException,
|
||||
Helpers,
|
||||
Tests\BasicTestCase};
|
||||
Tests\BasicTestCase
|
||||
};
|
||||
use BadMethodCallException;
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
@@ -58,17 +59,19 @@ class ClientTest extends BasicTestCase
|
||||
$this->assertIsAtolable(new Client(email: 'john@example.com'), ['email' => 'john@example.com']);
|
||||
$this->assertIsAtolable(new Client(phone: '+1/22/99*73s dsdas654 5s6'), ['phone' => '+122997365456']);
|
||||
$this->assertIsAtolable(new Client(inn: '+fasd3\qe3fs_=nac99013928czc'), ['inn' => '3399013928']);
|
||||
$this->assertIsAtolable(new Client(
|
||||
'John Doe',
|
||||
'john@example.com',
|
||||
'+1/22/99*73s dsdas654 5s6', // +122997365456
|
||||
'+fasd3\qe3fs_=nac99013928czc' // 3399013928
|
||||
), [
|
||||
'name' => 'John Doe',
|
||||
'email' => 'john@example.com',
|
||||
'phone' => '+122997365456',
|
||||
'inn' => '3399013928',
|
||||
]);
|
||||
$this->assertIsAtolable(
|
||||
new Client(
|
||||
'John Doe',
|
||||
'john@example.com',
|
||||
'+1/22/99*73s dsdas654 5s6', // +122997365456
|
||||
'+fasd3\qe3fs_=nac99013928czc' // 3399013928
|
||||
), [
|
||||
'name' => 'John Doe',
|
||||
'email' => 'john@example.com',
|
||||
'phone' => '+122997365456',
|
||||
'inn' => '3399013928',
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -131,12 +134,12 @@ class ClientTest extends BasicTestCase
|
||||
/**
|
||||
* Тестирует установку валидного телефона
|
||||
*
|
||||
* @throws InvalidPhoneException
|
||||
* @todo актуализировать при доработатанной валидации
|
||||
* @dataProvider providerValidPhones
|
||||
* @covers \AtolOnline\Entities\Client
|
||||
* @covers \AtolOnline\Entities\Client::setPhone
|
||||
* @covers \AtolOnline\Entities\Client::getPhone
|
||||
* @throws InvalidPhoneException
|
||||
*/
|
||||
public function testValidPhone(string $input, string $output): void
|
||||
{
|
||||
@@ -146,11 +149,11 @@ class ClientTest extends BasicTestCase
|
||||
/**
|
||||
* Тестирует установку невалидного телефона
|
||||
*
|
||||
* @throws InvalidPhoneException
|
||||
* @todo актуализировать при доработатанной валидации
|
||||
* @covers \AtolOnline\Entities\Client
|
||||
* @covers \AtolOnline\Entities\Client::setPhone
|
||||
* @covers \AtolOnline\Exceptions\InvalidPhoneException
|
||||
* @throws InvalidPhoneException
|
||||
*/
|
||||
public function testInvalidPhoneException(): void
|
||||
{
|
||||
@@ -247,4 +250,45 @@ class ClientTest extends BasicTestCase
|
||||
$this->expectException(InvalidInnLengthException::class);
|
||||
(new Client())->setInn('1234567890123');
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует обращение к атрибутам объекта как к элементам массива
|
||||
*
|
||||
* @covers \AtolOnline\Entities\Entity::offsetGet
|
||||
* @covers \AtolOnline\Entities\Entity::offsetExists
|
||||
* @return void
|
||||
*/
|
||||
public function testOffsetGetExists(): void
|
||||
{
|
||||
$client = new Client('John Doe');
|
||||
$this->assertEquals('John Doe', $client['name']);
|
||||
$this->assertTrue(isset($client['name']));
|
||||
$this->assertFalse(isset($client['qwerty']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при попытке задать значение атрибуту объекта как элементу массива
|
||||
*
|
||||
* @covers \AtolOnline\Entities\Entity::offsetSet
|
||||
* @return void
|
||||
*/
|
||||
public function testBadMethodCallExceptionBySet(): void
|
||||
{
|
||||
$this->expectException(BadMethodCallException::class);
|
||||
$client = new Client('John Doe');
|
||||
$client['name'] = 'qwerty';
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при попытке удалить значение атрибута объекта как элемент массива
|
||||
*
|
||||
* @covers \AtolOnline\Entities\Entity::offsetUnset
|
||||
* @return void
|
||||
*/
|
||||
public function testBadMethodCallExceptionByUnset(): void
|
||||
{
|
||||
$this->expectException(BadMethodCallException::class);
|
||||
$client = new Client('John Doe');
|
||||
unset($client['name']);
|
||||
}
|
||||
}
|
||||
|
||||
117
tests/AtolOnline/Tests/Entities/CorrectionTest.php
Normal file
117
tests/AtolOnline/Tests/Entities/CorrectionTest.php
Normal file
@@ -0,0 +1,117 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
|
||||
*
|
||||
* This code is licensed under MIT.
|
||||
* Этот код распространяется по лицензии MIT.
|
||||
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
|
||||
*/
|
||||
|
||||
namespace AtolOnline\Tests\Entities;
|
||||
|
||||
use AtolOnline\{
|
||||
Constants\Constraints,
|
||||
Helpers,
|
||||
Tests\BasicTestCase};
|
||||
use AtolOnline\Exceptions\{
|
||||
EmptyCorrectionNumberException,
|
||||
InvalidCorrectionDateException,
|
||||
InvalidEntityInCollectionException,
|
||||
InvalidEnumValueException,
|
||||
NegativePaymentSumException,
|
||||
TooHighPaymentSumException,
|
||||
TooLongCashierException};
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Набор тестов для проверки работы класса чека коррекции
|
||||
*/
|
||||
class CorrectionTest extends BasicTestCase
|
||||
{
|
||||
/**
|
||||
* Тестирует конструктор и корректное приведение к json
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Correction
|
||||
* @covers \AtolOnline\Entities\Correction::setCompany
|
||||
* @covers \AtolOnline\Entities\Correction::setCorrectionInfo
|
||||
* @covers \AtolOnline\Entities\Correction::setPayments
|
||||
* @covers \AtolOnline\Entities\Correction::setVats
|
||||
* @covers \AtolOnline\Entities\Correction::jsonSerialize
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testConstructor(): void
|
||||
{
|
||||
$correction = $this->newCorrection();
|
||||
$this->assertIsAtolable($correction);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку валидного кассира
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Correction::setCashier
|
||||
* @covers \AtolOnline\Entities\Correction::getCashier
|
||||
* @covers \AtolOnline\Entities\Correction::jsonSerialize
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongCashierException
|
||||
*/
|
||||
public function testCashier(): void
|
||||
{
|
||||
$correction = $this->newCorrection()->setCashier(Helpers::randomStr());
|
||||
$this->assertArrayHasKey('cashier', $correction->jsonSerialize());
|
||||
$this->assertEquals($correction->getCashier(), $correction->jsonSerialize()['cashier']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует обнуление кассира
|
||||
*
|
||||
* @param mixed $param
|
||||
* @return void
|
||||
* @dataProvider providerNullableStrings
|
||||
* @covers \AtolOnline\Entities\Correction::setCashier
|
||||
* @covers \AtolOnline\Entities\Correction::getCashier
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongCashierException
|
||||
*/
|
||||
public function testNullableCashier(mixed $param): void
|
||||
{
|
||||
$this->assertNull($this->newCorrection()->setCashier($param)->getCashier());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком длинного кассира (лол)
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Correction::setCashier
|
||||
* @covers \AtolOnline\Exceptions\TooLongCashierException
|
||||
* @throws EmptyCorrectionNumberException
|
||||
* @throws InvalidCorrectionDateException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongCashierException
|
||||
*/
|
||||
public function testTooLongCashierException(): void
|
||||
{
|
||||
$this->expectException(TooLongCashierException::class);
|
||||
$this->newCorrection()->setCashier(Helpers::randomStr(Constraints::MAX_LENGTH_CASHIER_NAME + 1));
|
||||
}
|
||||
}
|
||||
@@ -10,22 +10,28 @@
|
||||
namespace AtolOnline\Tests\Entities;
|
||||
|
||||
use AtolOnline\{
|
||||
Collections\Items,
|
||||
Collections\Payments,
|
||||
Collections\Vats,
|
||||
Entities\AgentInfo,
|
||||
Entities\Client,
|
||||
Entities\Company,
|
||||
Entities\Item,
|
||||
Entities\MoneyTransferOperator,
|
||||
Entities\PayingAgent,
|
||||
Entities\Receipt,
|
||||
Entities\ReceivePaymentsOperator,
|
||||
Entities\Supplier,
|
||||
Entities\Vat,
|
||||
Enums\AgentTypes,
|
||||
Enums\SnoTypes,
|
||||
Constants\Constraints,
|
||||
Helpers,
|
||||
Tests\BasicTestCase};
|
||||
use AtolOnline\Collections\{
|
||||
Items,
|
||||
Payments,
|
||||
Vats,};
|
||||
use AtolOnline\Entities\{
|
||||
AdditionalUserProps,
|
||||
AgentInfo,
|
||||
Client,
|
||||
Company,
|
||||
Item,
|
||||
MoneyTransferOperator,
|
||||
PayingAgent,
|
||||
Receipt,
|
||||
ReceivePaymentsOperator,
|
||||
Supplier,
|
||||
Vat,};
|
||||
use AtolOnline\Enums\{
|
||||
AgentTypes,
|
||||
SnoTypes,};
|
||||
use AtolOnline\Exceptions\{
|
||||
EmptyItemNameException,
|
||||
EmptyItemsException,
|
||||
@@ -41,6 +47,8 @@ use AtolOnline\Exceptions\{
|
||||
TooHighItemPriceException,
|
||||
TooHighItemSumException,
|
||||
TooHighPaymentSumException,
|
||||
TooLongAddCheckPropException,
|
||||
TooLongCashierException,
|
||||
TooLongItemNameException,
|
||||
TooLongPayingAgentOperationException,
|
||||
TooManyException};
|
||||
@@ -83,7 +91,6 @@ class ReceiptTest extends BasicTestCase
|
||||
{
|
||||
$receipt = $this->newReceipt();
|
||||
$this->assertIsAtolable($receipt);
|
||||
$receipt->getItems();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -120,7 +127,7 @@ class ReceiptTest extends BasicTestCase
|
||||
);
|
||||
$receipt = $this->newReceipt()->setAgentInfo($agent_info);
|
||||
$this->assertArrayHasKey('agent_info', $receipt->jsonSerialize());
|
||||
$this->assertEquals($receipt->getAgentInfo(), $receipt->jsonSerialize()['agent_info']);
|
||||
$this->assertEquals($receipt->getAgentInfo()->jsonSerialize(), $receipt->jsonSerialize()['agent_info']);
|
||||
$this->assertArrayNotHasKey('agent_info', $receipt->setAgentInfo(null)->jsonSerialize());
|
||||
}
|
||||
|
||||
@@ -152,7 +159,7 @@ class ReceiptTest extends BasicTestCase
|
||||
$supplier = new Supplier('some name', '+fasd3\qe3fs_=nac99013928czc', ['+122997365456']);
|
||||
$receipt = $this->newReceipt()->setSupplier($supplier);
|
||||
$this->assertArrayHasKey('supplier_info', $receipt->jsonSerialize());
|
||||
$this->assertEquals($receipt->getSupplier(), $receipt->jsonSerialize()['supplier_info']);
|
||||
$this->assertEquals($receipt->getSupplier()->jsonSerialize(), $receipt->jsonSerialize()['supplier_info']);
|
||||
$this->assertArrayNotHasKey('supplier_info', $receipt->setSupplier(null)->jsonSerialize());
|
||||
}
|
||||
|
||||
@@ -200,7 +207,9 @@ class ReceiptTest extends BasicTestCase
|
||||
public function testInvalidItemInCollectionException(): void
|
||||
{
|
||||
$this->expectException(InvalidEntityInCollectionException::class);
|
||||
$this->expectErrorMessage('Коллекция AtolOnline\Collections\Items должна содержать объекты AtolOnline\Entities\Item');
|
||||
$this->expectErrorMessage(
|
||||
'Коллекция AtolOnline\Collections\Items должна содержать объекты AtolOnline\Entities\Item'
|
||||
);
|
||||
new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
@@ -260,8 +269,10 @@ class ReceiptTest extends BasicTestCase
|
||||
public function testInvalidPaymentInCollectionException(): void
|
||||
{
|
||||
$this->expectException(InvalidEntityInCollectionException::class);
|
||||
$this->expectErrorMessage('Коллекция AtolOnline\Collections\Payments должна содержать объекты AtolOnline\Entities\Payment');
|
||||
new Receipt(
|
||||
$this->expectErrorMessage(
|
||||
'Коллекция AtolOnline\Collections\Payments должна содержать объекты AtolOnline\Entities\Payment'
|
||||
);
|
||||
(string)new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items([new Item('test item', 2, 3)]),
|
||||
@@ -280,7 +291,6 @@ class ReceiptTest extends BasicTestCase
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws EmptyVatsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
@@ -290,6 +300,7 @@ class ReceiptTest extends BasicTestCase
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testEmptyVatsException(): void
|
||||
{
|
||||
@@ -309,7 +320,6 @@ class ReceiptTest extends BasicTestCase
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws EmptyVatsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
@@ -319,12 +329,15 @@ class ReceiptTest extends BasicTestCase
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testInvalidVatInCollectionException(): void
|
||||
{
|
||||
$this->expectException(InvalidEntityInCollectionException::class);
|
||||
$this->expectErrorMessage('Коллекция AtolOnline\Collections\Vats должна содержать объекты AtolOnline\Entities\Vat');
|
||||
$this->newReceipt()->setVats(new Vats(['qwerty']));
|
||||
$this->expectErrorMessage(
|
||||
'Коллекция AtolOnline\Collections\Vats должна содержать объекты AtolOnline\Entities\Vat'
|
||||
);
|
||||
(string)$this->newReceipt()->setVats(new Vats(['qwerty']));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -350,26 +363,22 @@ class ReceiptTest extends BasicTestCase
|
||||
*/
|
||||
public function testCalculations(): void
|
||||
{
|
||||
$items_total = 0;
|
||||
$receipt = $this->newReceipt();
|
||||
|
||||
//TODO при $receipt->getItems()->pluck('sum') стреляет InvalidEntityInCollectionException
|
||||
// см. примечания в конструкторе EntityCollection
|
||||
$receipt->getItems()->each(function ($item) use (&$items_total) {
|
||||
/** @var Item $item */
|
||||
return $items_total += $item->getSum();
|
||||
});
|
||||
$items_total = $receipt->getItems()->pluck('sum')->sum();
|
||||
$this->assertEquals($items_total, $receipt->getTotal());
|
||||
|
||||
/** @var Vat $vat */
|
||||
$receipt->setVats(new Vats($this->generateVatObjects(2)))->getVats()
|
||||
->each(fn ($vat) => $this->assertEquals($items_total, $vat->getSum()));
|
||||
->each(fn($vat) => $this->assertEquals($items_total, $vat->getSum()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает валидный тестовый объект чека
|
||||
* Тестирует установку валидного кассира
|
||||
*
|
||||
* @return Receipt
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::setCashier
|
||||
* @covers \AtolOnline\Entities\Receipt::getCashier
|
||||
* @covers \AtolOnline\Entities\Receipt::jsonSerialize
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
@@ -382,14 +391,181 @@ class ReceiptTest extends BasicTestCase
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws TooLongCashierException
|
||||
* @throws Exception
|
||||
*/
|
||||
protected function newReceipt(): Receipt
|
||||
public function testCashier(): void
|
||||
{
|
||||
return new Receipt(
|
||||
new Client('John Doe', 'john@example.com', '+1/22/99*73s dsdas654 5s6', '+fasd3\qe3fs_=nac99013928czc'),
|
||||
new Company('company@example.com', SnoTypes::OSN, '1234567890', 'https://example.com'),
|
||||
new Items($this->generateItemObjects(2)),
|
||||
new Payments($this->generatePaymentObjects())
|
||||
$receipt = $this->newReceipt()->setCashier(Helpers::randomStr());
|
||||
$this->assertArrayHasKey('cashier', $receipt->jsonSerialize());
|
||||
$this->assertEquals($receipt->getCashier(), $receipt->jsonSerialize()['cashier']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует обнуление кассира
|
||||
*
|
||||
* @param mixed $param
|
||||
* @return void
|
||||
* @dataProvider providerNullableStrings
|
||||
* @covers \AtolOnline\Entities\Receipt::setCashier
|
||||
* @covers \AtolOnline\Entities\Receipt::getCashier
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongCashierException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
public function testNullableCashier(mixed $param): void
|
||||
{
|
||||
$this->assertNull($this->newReceipt()->setCashier($param)->getCashier());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком длинного кассира (лол)
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::setCashier
|
||||
* @covers \AtolOnline\Exceptions\TooLongCashierException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongCashierException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
public function testTooLongCashierException(): void
|
||||
{
|
||||
$this->expectException(TooLongCashierException::class);
|
||||
$this->newReceipt()->setCashier(Helpers::randomStr(Constraints::MAX_LENGTH_CASHIER_NAME + 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку дополнительного реквизита чека
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::setAddCheckProps
|
||||
* @covers \AtolOnline\Entities\Receipt::getAddCheckProps
|
||||
* @covers \AtolOnline\Entities\Receipt::jsonSerialize
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws TooLongAddCheckPropException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testAddCheckProps(): void
|
||||
{
|
||||
$receipt = $this->newReceipt()->setAddCheckProps(Helpers::randomStr());
|
||||
$this->assertArrayHasKey('additional_check_props', $receipt->jsonSerialize());
|
||||
$this->assertEquals($receipt->getAddCheckProps(), $receipt->jsonSerialize()['additional_check_props']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует обнуление дополнительного реквизита чека
|
||||
*
|
||||
* @param mixed $param
|
||||
* @return void
|
||||
* @dataProvider providerNullableStrings
|
||||
* @covers \AtolOnline\Entities\Receipt::setAddCheckProps
|
||||
* @covers \AtolOnline\Entities\Receipt::getAddCheckProps
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongAddCheckPropException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
public function testNullableAddCheckProps(mixed $param): void
|
||||
{
|
||||
$this->assertNull($this->newReceipt()->setAddCheckProps($param)->getAddCheckProps());
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует выброс исключения при установке слишком длинного дополнительного реквизита чека
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::setAddCheckProps
|
||||
* @covers \AtolOnline\Exceptions\TooLongAddCheckPropException
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongAddCheckPropException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
*/
|
||||
public function testTooLongAddCheckPropException(): void
|
||||
{
|
||||
$this->expectException(TooLongAddCheckPropException::class);
|
||||
$this->newReceipt()->setAddCheckProps(Helpers::randomStr(Constraints::MAX_LENGTH_ADD_CHECK_PROP + 1));
|
||||
}
|
||||
|
||||
/**
|
||||
* Тестирует установку дополнительного реквизита пользователя
|
||||
*
|
||||
* @return void
|
||||
* @covers \AtolOnline\Entities\Receipt::setAddUserProps
|
||||
* @covers \AtolOnline\Entities\Receipt::getAddUserProps
|
||||
* @covers \AtolOnline\Entities\Receipt::jsonSerialize
|
||||
* @throws EmptyItemNameException
|
||||
* @throws EmptyItemsException
|
||||
* @throws EmptyPaymentsException
|
||||
* @throws InvalidEntityInCollectionException
|
||||
* @throws InvalidEnumValueException
|
||||
* @throws NegativeItemPriceException
|
||||
* @throws NegativeItemQuantityException
|
||||
* @throws NegativePaymentSumException
|
||||
* @throws TooHighItemPriceException
|
||||
* @throws TooHighPaymentSumException
|
||||
* @throws TooLongItemNameException
|
||||
* @throws TooManyException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function testAdditionalUserProps(): void
|
||||
{
|
||||
$aup = new AdditionalUserProps('name', 'value');
|
||||
$receipt = $this->newReceipt()->setAddUserProps($aup);
|
||||
$this->assertArrayHasKey('additional_user_props', $receipt->jsonSerialize());
|
||||
$this->assertEquals(
|
||||
$receipt->getAddUserProps()->jsonSerialize(),
|
||||
$receipt->jsonSerialize()['additional_user_props']
|
||||
);
|
||||
$this->assertArrayNotHasKey('additional_user_props', $receipt->setAddUserProps(null)->jsonSerialize());
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user