Начало работы по #5 и #6

- строгая типизация - переработан класс `TestEnvParams`: - вынесен на уровень выше из под `AtolOnline\Constants` - вместо констант - две функции для получения актуальных параметров подключения по ФФД1.05 и ФФД1.2 - актуализированы `PaymentObjects` согласно #5 - исходники вынесены не уровень выше в `src` - константы теперь enum через `myclabs/php-enum` - новые константы `DocumentTypes` - классы констант финализированы - все исключения переименованы, а многие так или иначе отрефакторены (не полностью) - новые исключения `InvalidSnoException`, `InvalidPaymentAddressException` - `helpers.php` стал полноценным классом `Helpers` - удалены трейты `HasEmail`, `HasInn`, `RublesKopeksConverter` (конвертация перенесена в `Helpers`) - удалён хелпер `valid_strlen()`, вместо него теперь везде `mb_strlen()` - сущности `Client` и `Company` получили свои имплементации для `email` и `inn` - доработки в `BasicTestCase` - полное покрытие тестами: `Client`, `Company`, `Helpers` - поправлен `phpunit.xml` - везде обновлены копирайты - актуализированы и исправлены phpdoc, return types - начато введение `strict_types=1` - минимальный php теперь 8.0 - обновлены все зависимости - подключен пакет коллекций laravel для будущего использования - теперь можно `composer test` и `composer test-cov`
2021-11-18 12:24:30 +08:00
parent cc944a1dbb
commit 77481884ad
78 changed files with 4220 additions and 2712 deletions
--- a/src/Constants/Constraints.php
+++ b/src/Constants/Constraints.php
@@ -0,0 +1,83 @@
+<?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\Constants;
+
+/**
+ * Класс с константами ограничений
+ */
+final class Constraints
+{
+    /**
+     * Максимальная длина Callback URL
+     */
+    const MAX_LENGTH_CALLBACK_URL = 256;
+
+    /**
+     * Максимальная длина email
+     */
+    const MAX_LENGTH_EMAIL = 64;
+    
+    /**
+     * Максимальная длина логина ККТ
+     */
+    const MAX_LENGTH_LOGIN = 100;
+    
+    /**
+     * Максимальная длина пароля ККТ
+     */
+    const MAX_LENGTH_PASSWORD = 100;
+    
+    /**
+     * Максимальная длина имени покупателя
+     */
+    const MAX_LENGTH_CLIENT_NAME = 256;
+    
+    /**
+     * Максимальная длина телефона покупателя
+     */
+    const MAX_LENGTH_CLIENT_PHONE = 64;
+    
+    /**
+     * Максимальная длина адреса места расчётов
+     */
+    const MAX_LENGTH_PAYMENT_ADDRESS = 256;
+    
+    /**
+     * Максимальная длина имени кассира
+     */
+    const MAX_LENGTH_CASHIER_NAME = 64;
+    
+    /**
+     * Максимальная длина наименования предмета расчётов
+     */
+    const MAX_LENGTH_ITEM_NAME = 128;
+    
+    /**
+     * Максимальная длина единицы измерения предмета расчётов
+     */
+    const MAX_LENGTH_MEASUREMENT_UNIT = 16;
+    
+    /**
+     * Максимальная длина пользовательских данных для предмета расчётов
+     */
+    const MAX_LENGTH_USER_DATA = 64;
+    
+    /**
+     * Регулярное выражание для валидации строки ИНН
+     */
+    const PATTERN_INN = "/(^[0-9]{10}$)|(^[0-9]{12}$)/";
+    
+    /**
+     * Регулярное выражание для валидации строки Callback URL
+     */
+    const PATTERN_CALLBACK_URL = "/^http(s?)\:\/\/[0-9a-zA-Zа-яА-Я]([-.\w]*[0-9a-zA-Zа-яА-Я])*(:(0-9)*)*(\/?)([a-zAZ0-9а-яА-Я\-\.\?\,\'\/\\\+&=%\$#_]*)?$/";
+}
--- a/src/Constants/CorrectionTypes.php
+++ b/src/Constants/CorrectionTypes.php
@@ -0,0 +1,34 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие типы документов коррекции
+ *
+ * Тег ФФД -  1173
+ *
+ * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 35 (correction_info)
+ */
+final class CorrectionTypes extends Enum
+{
+    /**
+     * Самостоятельно
+     */
+    const SELF = 'self';
+
+    /**
+     * По предписанию
+     */
+    const INSTRUCTION = 'instruction';
+}
--- a/src/Constants/DocumentTypes.php
+++ b/src/Constants/DocumentTypes.php
@@ -0,0 +1,30 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие типы документов
+ */
+final class DocumentTypes extends Enum
+{
+    /**
+     * Чек прихода, возврата прихода, расхода, возврата расхода
+     */
+    const RECEIPT = 'receipt';
+
+    /**
+     * Чек коррекции
+     */
+    const CORRECTION = 'correction';
+}
--- a/src/Constants/PaymentMethods.php
+++ b/src/Constants/PaymentMethods.php
@@ -0,0 +1,59 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие признаки способов расчёта
+ *
+ * Тег ФФД -  1214
+ *
+ * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 22 (payment_method)
+ */
+final class PaymentMethods extends Enum
+{
+    /**
+     * Предоплата 100% до передачи предмета расчёта
+     */
+    const FULL_PREPAYMENT = 'full_prepayment';
+
+    /**
+     * Частичная предоплата до передачи предмета расчёта
+     */
+    const PREPAYMENT = 'prepayment';
+
+    /**
+     * Аванс
+     */
+    const ADVANCE = 'advance';
+
+    /**
+     * Полная оплата с учётом аванса/предоплаты в момент передачи предмета расчёта
+     */
+    const FULL_PAYMENT = 'full_payment';
+
+    /**
+     * Частичный расчёт в момент передачи предмета расчёта (дальнейшая оплата в кредит)
+     */
+    const PARTIAL_PAYMENT = 'partial_payment';
+
+    /**
+     * Передача предмета расчёта в кредит
+     */
+    const CREDIT = 'credit';
+
+    /**
+     * Оплата кредита
+     */
+    const CREDIT_PAYMENT = 'credit_payment';
+}
--- a/src/Constants/PaymentObjects.php
+++ b/src/Constants/PaymentObjects.php
@@ -0,0 +1,161 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие признаки предметов расчёта
+ *
+ * Тег ФФД -  1212
+ *
+ * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 23 (payment_object)
+ */
+final class PaymentObjects extends Enum
+{
+    /**
+     * Товар, кроме подакцизного
+     */
+    const COMMODITY = 'commodity';
+
+    /**
+     * Товар подакцизный
+     */
+    const EXCISE = 'excise';
+
+    /**
+     * Работа
+     */
+    const JOB = 'job';
+
+    /**
+     * Услуга
+     */
+    const SERVICE = 'service';
+
+    /**
+     * Ставка азартной игры
+     */
+    const GAMBLING_BET = 'gambling_bet';
+
+    /**
+     * Выигрыш азартной игры
+     */
+    const GAMBLING_PRIZE = 'gambling_prize';
+
+    /**
+     * Лотерея
+     */
+    const LOTTERY = 'lottery';
+
+    /**
+     * Выигрыш лотереи
+     */
+    const LOTTERY_PRIZE = 'lottery_prize';
+
+    /**
+     * Предоставление результатов интеллектуальной деятельности
+     */
+    const INTELLECTUAL_ACTIVITY = 'intellectual_activity';
+
+    /**
+     * Платёж (задаток, кредит, аванс, предоплата, пеня, штраф, бонус и пр.)
+     */
+    const PAYMENT = 'payment';
+
+    /**
+     * Агентское вознаграждение
+     */
+    const AGENT_COMMISSION = 'agent_commission';
+
+    /**
+     * Составной предмет расчёта
+     * @deprecated Более не используется согласно ФФД 1.05
+     * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 25 (payment_object)
+     */
+    const COMPOSITE = 'composite';
+
+    /**
+     * Другой предмет расчёта
+     */
+    const ANOTHER = 'another';
+
+    /**
+     * Имущественное право
+     */
+    const PROPERTY_RIGHT = 'property_right';
+
+    /**
+     * Внереализационный доход
+     */
+    const NON_OPERATING_GAIN = 'non-operating_gain';
+
+    /**
+     * Страховые взносы
+     */
+    const INSURANCE_PREMIUM = 'insurance_premium';
+
+    /**
+     * Торговый сбор
+     */
+    const SALES_TAX = 'sales_tax';
+
+    /**
+     * Курортный сбор
+     */
+    const RESORT_FEE = 'resort_fee';
+
+    /**
+     * Взнос в счёт оплаты пени, штрафе, вознаграждении, бонусе и ином аналогичном предмете расчета
+     */
+    const AWARD = 'award';
+
+    /**
+     * Залог
+     */
+    const DEPOSIT = 'deposit';
+
+    /**
+     * Расход, уменьшающий доход (в соответствии со статьей 346.16 НК РФ)
+     */
+    const EXPENSE = 'expense';
+
+    /**
+     * Взнос на ОПС ИП
+     */
+    const PEN_INSURANCE_IP = 'pension_insurance_ip';
+
+    /**
+     * Взнос на ОПС
+     */
+    const PEN_INSURANCE = 'pension_insurance';
+
+    /**
+     * Взнос на ОМС ИП
+     */
+    const MED_INSURANCE_IP = 'medical_insurance_ip';
+
+    /**
+     * Взнос на ОМС
+     */
+    const MED_INSURANCE = 'medical_insurance';
+
+    /**
+     * Взнос на ОСС
+     */
+    const SOC_INSURANCE = 'social_insurance';
+
+    /**
+     * Платёж казино
+     */
+    const CASINO_PAYMENT = 'casino_payment';
+}
--- a/src/Constants/PaymentTypes.php
+++ b/src/Constants/PaymentTypes.php
@@ -0,0 +1,77 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие виды оплат
+ *
+ * Теги ФФД: 1031, 1081, 1215, 1216, 1217
+ */
+final class PaymentTypes extends Enum
+{
+    /**
+     * Расчёт наличными. Тег ФФД - 1031.
+     */
+    const CASH = 0;
+
+    /**
+     * Расчёт безналичными. Тег ФФД - 1081.
+     */
+    const ELECTRON = 1;
+
+    /**
+     * Предварительная оплата (зачёт аванса). Тег ФФД - 1215.
+     */
+    const PRE_PAID = 2;
+
+    /**
+     * Предварительная оплата (кредит). Тег ФФД - 1216.
+     */
+    const CREDIT = 3;
+
+    /**
+     * Иная форма оплаты (встречное предоставление). Тег ФФД - 1217.
+     */
+    const OTHER = 4;
+
+    /**
+     * Расширенный типы оплаты (5)
+     * Для каждого фискального типа оплаты можно указать расширенный тип оплаты
+     */
+    const ADD_5 = 5;
+
+    /**
+     * Расширенный типы оплаты (6)
+     * Для каждого фискального типа оплаты можно указать расширенный тип оплаты
+     */
+    const ADD_6 = 6;
+
+    /**
+     * Расширенный типы оплаты (7)
+     * Для каждого фискального типа оплаты можно указать расширенный тип оплаты
+     */
+    const ADD_7 = 7;
+
+    /**
+     * Расширенный типы оплаты (8)
+     * Для каждого фискального типа оплаты можно указать расширенный тип оплаты
+     */
+    const ADD_8 = 8;
+
+    /**
+     * Расширенный типы оплаты (9)
+     * Для каждого фискального типа оплаты можно указать расширенный тип оплаты
+     */
+    const ADD_9 = 9;
+}
--- a/src/Constants/ReceiptOperationTypes.php
+++ b/src/Constants/ReceiptOperationTypes.php
@@ -0,0 +1,50 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие типы операций (чеков)
+ */
+final class ReceiptOperationTypes extends Enum
+{
+    /**
+     * Приход (мы продали)
+     */
+    const SELL = 'sell';
+
+    /**
+     * Возврат прихода (нам вернули предмет расчёта, мы вернули средства)
+     */
+    const SELL_REFUND = 'sell_refund';
+
+    /**
+     * Коррекция прихода
+     */
+    const SELL_CORRECTION = 'sell_correction';
+
+    /**
+     * Расход (мы купили)
+     */
+    const BUY = 'buy';
+
+    /**
+     * Возврат расхода (мы вернули предмет расчёта, нам вернули средства)
+     */
+    const BUY_REFUND = 'buy_refund';
+
+    /**
+     * Коррекция прихода (догоняем неучтённые средства)
+     */
+    const BUY_CORRECTION = 'buy_correction';
+}
--- a/src/Constants/SnoTypes.php
+++ b/src/Constants/SnoTypes.php
@@ -0,0 +1,52 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие типы налогообложения
+ *
+ * Тег ФДД - 1055
+ */
+final class SnoTypes extends Enum
+{
+    /**
+     * Общая СН
+     */
+    const OSN = 'osn';
+
+    /**
+     * Упрощенная СН (доходы)
+     */
+    const USN_INCOME = 'usn_income';
+
+    /**
+     * Упрощенная СН (доходы минус расходы)
+     */
+    const USN_INCOME_OUTCOME = 'usn_income_outcome';
+
+    /**
+     * Единый налог на вмененный доход
+     */
+    const ENDV = 'envd';
+
+    /**
+     * Единый сельскохозяйственный налог
+     */
+    const ESN = 'esn';
+
+    /**
+     * Патентная СН
+     */
+    const PATENT = 'patent';
+}
--- a/src/Constants/VatTypes.php
+++ b/src/Constants/VatTypes.php
@@ -0,0 +1,62 @@
+<?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\Constants;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Константы, определяющие типы ставок НДС
+ *
+ * Теги ФФД: 1199, 1105, 1104, 1103, 1102, 1107, 1106
+ */
+final class VatTypes extends Enum
+{
+    /**
+     * Без НДС
+     */
+    const NONE = 'none';
+
+    /**
+     * НДС 0%
+     */
+    const VAT0 = 'vat0';
+
+    /**
+     * НДС 10%
+     */
+    const VAT10 = 'vat10';
+
+    /**
+     * НДС 18%
+     */
+    const VAT18 = 'vat18';
+
+    /**
+     * НДС 20%
+     */
+    const VAT20 = 'vat20';
+
+    /**
+     * НДС 10/110%
+     */
+    const VAT110 = 'vat110';
+
+    /**
+     * НДС 18/118%
+     */
+    const VAT118 = 'vat118';
+
+    /**
+     * НДС 20/120%
+     */
+    const VAT120 = 'vat120';
+}