Доработка коллекций и не только

- коллекция `Items` с покрытием
- вынос коллекций из `AtolOnline\Entities` в `AtolOnline\Collections`
- фикс ] в `AtolException`
- финализирован `CorrectionInfo`
- фиксы по тестам коллекций
- прочие мелочи по phpdoc

src/Collections/EntityCollection.php

@@ -0,0 +1,104 @@
+<?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\Collections;
+
+use AtolOnline\Exceptions\InvalidEntityInCollectionException;
+use Exception;
+use Illuminate\Support\Collection;
+
+/**
+ * Абстрактное описание коллекции любых сущностей
+ */
+abstract class EntityCollection extends Collection
+{
+    /**
+     * @inheritDoc
+     */
+    public function __construct($items = [])
+    {
+        $this->checkCount($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->each(function ($item) {
+            $this->checkClass($item);
+        });
+        return parent::jsonSerialize();
+    }
+
+    /**
+     * Проверяет количество ставок
+     *
+     * @param array $items Массив элементов, если пустой - проверит содержимое коллекции
+     * @return void
+     */
+    private function checkCount(array $items = []): void
+    {
+        if (count($items) > static::MAX_COUNT || $this->count() === static::MAX_COUNT) {
+            throw new (static::EXCEPTION_CLASS)(static::MAX_COUNT);
+        }
+    }
+
+    /**
+     * Проверяет корректность класса объекта
+     *
+     * @throws InvalidEntityInCollectionException
+     */
+    private function checkClass(mixed $item): void
+    {
+        if (!is_object($item) || $item::class !== static::ENTITY_CLASS) {
+            throw new InvalidEntityInCollectionException(static::class, static::ENTITY_CLASS, $item);
+        }
+    }
+}

src/Collections/Items.php

@@ -0,0 +1,35 @@
+<?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\Collections;
+
+use AtolOnline\Constants\Constraints;
+use AtolOnline\Entities\Item;
+use AtolOnline\Exceptions\TooManyItemsException;
+
+/**
+ * Класс, описывающий коллекцию предметов расчёта для документа
+ */
+final class Items extends EntityCollection
+{
+    /**
+     * Класс объектов, находящихся в коллекции
+     */
+    protected const ENTITY_CLASS = Item::class;
+
+    /**
+     * Максмальное количество объектов в коллекции
+     */
+    protected const MAX_COUNT = Constraints::MAX_COUNT_DOC_ITEMS;
+
+    /**
+     * Класс-наследник TooManyException для выброса при превышении количества
+     */
+    protected const EXCEPTION_CLASS = TooManyItemsException::class;
+}

src/Collections/Payments.php

@@ -0,0 +1,35 @@
+<?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\Collections;
+
+use AtolOnline\Constants\Constraints;
+use AtolOnline\Entities\Payment;
+use AtolOnline\Exceptions\TooManyPaymentsException;
+
+/**
+ * Класс, описывающий коллекцию оплат для документа
+ */
+final class Payments extends EntityCollection
+{
+    /**
+     * Класс объектов, находящихся в коллекции
+     */
+    protected const ENTITY_CLASS = Payment::class;
+
+    /**
+     * Максмальное количество объектов в коллекции
+     */
+    protected const MAX_COUNT = Constraints::MAX_COUNT_DOC_PAYMENTS;
+
+    /**
+     * Класс-наследник TooManyException для выброса при превышении количества
+     */
+    protected const EXCEPTION_CLASS = TooManyPaymentsException::class;
+}

src/Collections/Vats.php

@@ -0,0 +1,35 @@
+<?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\Collections;
+
+use AtolOnline\Constants\Constraints;
+use AtolOnline\Entities\Vat;
+use AtolOnline\Exceptions\TooManyVatsException;
+
+/**
+ * Класс, описывающий коллекцию ставок НДС для документа
+ */
+final class Vats extends EntityCollection
+{
+    /**
+     * Класс объектов, находящихся в коллекции
+     */
+    protected const ENTITY_CLASS = Vat::class;
+
+    /**
+     * Максмальное количество объектов в коллекции
+     */
+    protected const MAX_COUNT = Constraints::MAX_COUNT_DOC_VATS;
+
+    /**
+     * Класс-наследник TooManyException для выброса при превышении количества
+     */
+    protected const EXCEPTION_CLASS = TooManyVatsException::class;
+}