Начало работы по #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/Entities/CorrectionInfo.php
+++ b/src/Entities/CorrectionInfo.php
@@ -0,0 +1,171 @@
+<?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\Entities;
+
+/**
+ * Класс CorrectionInfo, описывающий данные чек коррекции
+ */
+class CorrectionInfo extends Entity
+{
+    /**
+     * @var string Тип коррекции. Тег ФФД - 1173.
+     */
+    protected string $type;
+    
+    /**
+     * @var string Дата документа основания для коррекции. Тег ФФД - 1178.
+     */
+    protected string $base_date;
+    
+    /**
+     * @var string Номер документа основания для коррекции. Тег ФФД - 1179.
+     */
+    protected string $base_number;
+    
+    /**
+     * @var string Описание коррекции. Тег ФФД - 1177.
+     */
+    protected string $base_name;
+    
+    /**
+     * CorrectionInfo constructor.
+     *
+     * @param string|null $type        Тип коррекции
+     * @param string|null $base_date   Дата документа
+     * @param string|null $base_number Номер документа
+     * @param string|null $base_name   Описание коррекции
+     */
+    public function __construct(?string $type = null, ?string $base_date = null, ?string $base_number = null, ?string $base_name = null)
+    {
+        if ($type) {
+            $this->setType($type);
+        }
+        if ($base_date) {
+            $this->setDate($base_date);
+        }
+        if ($base_number) {
+            $this->setNumber($base_number);
+        }
+        if ($base_name) {
+            $this->setName($base_name);
+        }
+    }
+    
+    /**
+     * Возвращает номер документа основания для коррекции.
+     * Тег ФФД - 1179.
+     *
+     * @return string|null
+     */
+    public function getNumber(): ?string
+    {
+        return $this->base_number;
+    }
+    
+    /**
+     * Устанавливает номер документа основания для коррекции.
+     * Тег ФФД - 1179.
+     *
+     * @param string $number
+     * @return $this
+     */
+    public function setNumber(string $number): CorrectionInfo
+    {
+        $this->base_number = trim($number);
+        return $this;
+    }
+    
+    /**
+     * Возвращает описание коррекции.
+     * Тег ФФД - 1177.
+     *
+     * @return string|null
+     */
+    public function getName(): ?string
+    {
+        return $this->base_name;
+    }
+    
+    /**
+     * Устанавливает описание коррекции.
+     * Тег ФФД - 1177.
+     *
+     * @param string $name
+     * @return $this
+     */
+    public function setName(string $name): CorrectionInfo
+    {
+        $this->base_name = trim($name);
+        return $this;
+    }
+    
+    /**
+     * Возвращает дату документа основания для коррекции.
+     * Тег ФФД - 1178.
+     *
+     * @return string|null
+     */
+    public function getDate(): ?string
+    {
+        return $this->base_date;
+    }
+    
+    /**
+     * Устанавливает дату документа основания для коррекции.
+     * Тег ФФД - 1178.
+     *
+     * @param string $date Строка в формате d.m.Y
+     * @return $this
+     */
+    public function setDate(string $date): CorrectionInfo
+    {
+        $this->base_date = $date;
+        return $this;
+    }
+    
+    /**
+     * Возвращает тип коррекции.
+     * Тег ФФД - 1173.
+     *
+     * @return string|null
+     */
+    public function getType(): ?string
+    {
+        return $this->type;
+    }
+    
+    /**
+     * Устанавливает тип коррекции.
+     * Тег ФФД - 1173.
+     *
+     * @param string $type
+     * @return $this
+     */
+    public function setType(string $type): CorrectionInfo
+    {
+        $this->type = $type;
+        return $this;
+    }
+    
+    /**
+     * @inheritDoc
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'type' => $this->getType() ?? '', // обязателен
+            'base_date' => $this->getDate() ?? '', // обязателен
+            'base_number' => $this->getNumber() ?? '', // обязателен
+            'base_name' => $this->getName() ?? '' // не обязателен
+        ];
+    }
+}