Класс `MoneyTransferOperator`, покрытый тестами

Также мелкофиксы по phpdoc `PayingAgent` и его тестам

src/Constants/Ffd105Tags.php

@@ -44,13 +44,18 @@ final class Ffd105Tags
      */
     const COMPANY_PADDRESS = 1187;
 
+    /**
+     * Телефон оператора по приёму платежей
+     */
+    const RPO_PHONES = 1074;
+
     /**
      * ИНН оператора перевода
      */
     const MTO_INN = 1016;
 
     /**
-     * Телефон платежного агента
+     * Телефон платёжного агента
      */
     const PAGENT_PHONE = 1073;
 

src/Entities/Kkt.php

@@ -52,7 +52,7 @@ final class Kkt extends Entity
         3 => 'Разрыв соединения при передаче документа на сервер',
         4 => 'Некорректный заголовок сессионного пакета',
         5 => 'Превышен таймаут ожидания квитанции',
-        6 => 'Разрыв соединения при приеме квитанции',
+        6 => 'Разрыв соединения при приёме квитанции',
         7 => 'Превышен таймаут передачи документа на сервер',
         8 => 'ОФД-процесс не иницилизирован',
     ];

src/Entities/MoneyTransferOperator.php

@@ -0,0 +1,85 @@
+<?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;
+
+use AtolOnline\Constants\Constraints;
+use AtolOnline\Exceptions\InvalidPhoneException;
+use Illuminate\Support\Collection;
+
+/**
+ * Класс, описывающий оператора по приёму платежей
+ *
+ * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 19-20
+ */
+class MoneyTransferOperator extends Entity
+{
+    /**
+     * @var Collection Телефоны платёжного агента (1073)
+     */
+    protected Collection $phones;
+
+    /**
+     * Конструктор
+     *
+     * @param array|Collection|null $phones Телефон оператора по приёму платежей (1074)
+     * @throws InvalidPhoneException
+     */
+    public function __construct(
+        array|Collection|null $phones = null,
+    ) {
+        $this->setPhones($phones);
+    }
+
+    /**
+     * Возвращает установленные номера телефонов
+     *
+     * @todo вытащить в трейт
+     * @return Collection
+     */
+    public function getPhones(): Collection
+    {
+        return $this->phones;
+    }
+
+    /**
+     * Устанавливает массив номеров телефонов
+     *
+     * @todo вытащить в трейт
+     * @param array|Collection|null $phones
+     * @return $this
+     * @throws InvalidPhoneException
+     */
+    public function setPhones(array|Collection|null $phones): self
+    {
+        if (!is_null($phones)) {
+            $phones = is_array($phones) ? collect($phones) : $phones;
+            $phones->each(function ($phone) {
+                $phone = preg_replace('/[^\d]/', '', trim($phone));
+                if (preg_match(Constraints::PATTERN_PHONE, $phone) != 1) {
+                    throw new InvalidPhoneException($phone);
+                }
+            });
+        }
+        $this->phones = empty($phones) ? collect() : $phones;
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function jsonSerialize(): array
+    {
+        $json = [];
+        !$this->getPhones()->isEmpty() && $json['phones'] = $this->getPhones()->toArray();
+        return $json;
+    }
+}

src/Entities/PayingAgent.php

@@ -17,7 +17,7 @@ use AtolOnline\Exceptions\TooLongPayingAgentOperationException;
 use Illuminate\Support\Collection;
 
 /**
- * Класс, описывающий данные платёжного агента
+ * Класс, описывающий платёжного агента
  *
  * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 19
  */
@@ -29,7 +29,7 @@ class PayingAgent extends Entity
     protected ?string $operation = null;
 
     /**
-     * @var Collection Телефоны платежного агента (1073)
+     * @var Collection Телефоны платёжного агента (1073)
      */
     protected Collection $phones;
 
@@ -37,7 +37,7 @@ class PayingAgent extends Entity
      * Конструктор
      *
      * @param string|null $operation Наименование операции (1044)
-     * @param array|Collection|null $phones Телефоны платежного агента (1073)
+     * @param array|Collection|null $phones Телефоны платёжного агента (1073)
      * @throws TooLongPayingAgentOperationException
      * @throws InvalidPhoneException
      */
@@ -81,6 +81,7 @@ class PayingAgent extends Entity
     /**
      * Устанавливает массив номеров телефонов
      *
+     * @todo вытащить в трейт
      * @param array|Collection|null $phones
      * @return $this
      * @throws InvalidPhoneException
@@ -101,8 +102,9 @@ class PayingAgent extends Entity
     }
 
     /**
-     * Возвращает установленные
+     * Возвращает установленные номера телефонов
      *
+     * @todo вытащить в трейт
      * @return Collection
      */
     public function getPhones(): Collection

src/Enums/AgentTypes.php

@@ -23,22 +23,22 @@ use AtolOnline\Enum;
 final class AgentTypes extends Enum
 {
     /**
-     * Банковский платежный агент
+     * Банковский платёжный агент
      */
     const BANK_PAYING_AGENT = 'bank_paying_agent';
 
     /**
-     * Банковский платежный субагент
+     * Банковский платёжный субагент
      */
     const BANK_PAYING_SUBAGENT = 'bank_paying_subagent';
 
     /**
-     * Платежный агент
+     * Платёжный агент
      */
     const PAYING_AGENT = 'paying_agent';
 
     /**
-     * Платежный субагент
+     * Платёжный субагент
      */
     const PAYING_SUBAGENT = 'paying_subagent';
 

src/Exceptions/InvalidPhoneException.php

@@ -14,13 +14,14 @@ namespace AtolOnline\Exceptions;
 use AtolOnline\Constants\Ffd105Tags;
 
 /**
- * Исключение, возникающее при ошибке валидации телефона
+ * Исключение, возникающее при ошибке валидации номера телефона
  */
 class InvalidPhoneException extends AtolException
 {
     protected array $ffd_tags = [
         Ffd105Tags::CLIENT_CONTACT,
         Ffd105Tags::PAGENT_PHONE,
+        Ffd105Tags::RPO_PHONES,
     ];
 
     /**

tests/AtolOnline/Tests/Entities/MoneyTransferOperatorTest.php

@@ -0,0 +1,95 @@
+<?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\{
+    Entities\MoneyTransferOperator,
+    Exceptions\InvalidPhoneException,
+    Tests\BasicTestCase};
+
+/**
+ * Набор тестов для проверки работы класса оператора по приёму платежей
+ */
+class MoneyTransferOperatorTest extends BasicTestCase
+{
+    /**
+     * Тестирует конструктор без передачи значений и корректное приведение к json
+     *
+     * @covers \AtolOnline\Entities\MoneyTransferOperator
+     * @covers \AtolOnline\Entities\MoneyTransferOperator::jsonSerialize
+     */
+    public function testConstructorWithoutArgs(): void
+    {
+        $this->assertEquals('[]', (string)(new MoneyTransferOperator()));
+    }
+
+    /**
+     * Тестирует конструктор с передачей значений и корректное приведение к json
+     *
+     * @covers \AtolOnline\Entities\MoneyTransferOperator
+     * @covers \AtolOnline\Entities\MoneyTransferOperator::jsonSerialize
+     * @covers \AtolOnline\Entities\MoneyTransferOperator::setPhones
+     * @covers \AtolOnline\Entities\MoneyTransferOperator::getPhones
+     * @throws InvalidPhoneException
+     */
+    public function testConstructorWithArgs(): void
+    {
+        $this->assertAtolable(new MoneyTransferOperator(['+122997365456']), ['phones' => ['+122997365456']]);
+    }
+
+    /**
+     * Провайдер массивов телефонов, которые приводятся к null
+     *
+     * @return array<array>
+     */
+    public function providerNullablePhonesArrays(): array
+    {
+        return [
+            [[]],
+            [null],
+            [collect()],
+        ];
+    }
+
+    /**
+     * Тестирует установку пустых телефонов
+     *
+     * @dataProvider providerNullablePhonesArrays
+     * @covers       \AtolOnline\Entities\MoneyTransferOperator
+     * @covers       \AtolOnline\Entities\MoneyTransferOperator::setPhones
+     * @covers       \AtolOnline\Entities\MoneyTransferOperator::getPhones
+     * @throws InvalidPhoneException
+     */
+    public function testNullablePhones(mixed $phones): void
+    {
+        $agent = new MoneyTransferOperator($phones);
+        $this->assertIsCollection($agent->getPhones());
+        $this->assertTrue($agent->getPhones()->isEmpty());
+    }
+
+    /**
+     * Тестирует установку невалидных телефонов
+     *
+     * @covers \AtolOnline\Entities\MoneyTransferOperator
+     * @covers \AtolOnline\Entities\MoneyTransferOperator::setPhones
+     * @covers \AtolOnline\Exceptions\InvalidPhoneException
+     * @throws InvalidPhoneException
+     */
+    public function testInvalidPhoneException(): void
+    {
+        $this->expectException(InvalidPhoneException::class);
+        (new MoneyTransferOperator())->setPhones([
+            '12345678901234567', // good
+            '+123456789012345678', // good
+            '12345678901234567890', // bad
+            '+12345678901234567890', // bad
+        ]);
+    }
+}

tests/AtolOnline/Tests/Entities/PayingAgentTest.php

@@ -14,8 +14,7 @@ use AtolOnline\{
     Exceptions\InvalidPhoneException,
     Exceptions\TooLongPayingAgentOperationException,
     Helpers,
-    Tests\BasicTestCase
-};
+    Tests\BasicTestCase};
 
 /**
  * Набор тестов для проверки работы класса платёжного агента
@@ -81,7 +80,7 @@ class PayingAgentTest extends BasicTestCase
     }
 
     /**
-     * Тестирует установку невалидного имени покупателя
+     * Тестирует установку невалидной операции
      *
      * @covers \AtolOnline\Entities\PayingAgent
      * @covers \AtolOnline\Entities\PayingAgent::setOperation
@@ -96,7 +95,7 @@ class PayingAgentTest extends BasicTestCase
     /**
      * Провайдер массивов телефонов, которые приводятся к null
      *
-     * @return array<array<mixed>>
+     * @return array<array>
      */
     public function providerNullablePhonesArrays(): array
     {