anthony/atol-online
1
0
Fork 0
mirror of https://github.com/anthonyaxenov/atol-online.git synced 2024-12-22 12:54:53 +00:00
Code Issues Projects Releases Wiki Activity

Мелочи по phpdoc

Browse Source
This commit is contained in:
Anthony Axenov 2021-12-06 14:13:48 +08:00
parent 7d0c526663
commit b451c7dc68
3 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/Entities/Kkt.php
View File

@ -13,8 +13,7 @@ namespace AtolOnline\Entities;
use AtolOnline\Exceptions\{ use AtolOnline\Exceptions\{
EmptyMonitorDataException, EmptyMonitorDataException,
NotEnoughMonitorDataException NotEnoughMonitorDataException};
};
use DateTime; use DateTime;
use Exception; use Exception;
@ -22,25 +21,26 @@ use Exception;
* Класс сущности ККТ, получаемой от монитора * Класс сущности ККТ, получаемой от монитора
* *
* @see https://online.atol.ru/files/API_service_information.pdf Документация, стр 11 * @see https://online.atol.ru/files/API_service_information.pdf Документация, стр 11
* @property string|null serialNumber Заводской номер ККТ * @property-read string|null serialNumber Заводской номер ККТ
* @property string|null registrationNumber Регистрационный номер машины (РНМ) * @property-read string|null registrationNumber Регистрационный номер машины (РНМ)
* @property string|null deviceNumber Номер автоматического устройства (внутренний идентификатор устройства) * @property-read string|null deviceNumber Номер автоматического устройства (внутренний идентификатор устройства)
* @property DateTime|string|null fiscalizationDate Дата активации (фискализации) ФН с указанием таймзоны * @property-read DateTime|string|null fiscalizationDate Дата активации (фискализации) ФН с указанием таймзоны
* @property DateTime|string|null fiscalStorageExpiration Дата замены ФН (Срок действия ФН), с указанием таймзоны * @property-read DateTime|string|null fiscalStorageExpiration Дата замены ФН (Срок действия ФН), с указанием таймзоны
* @property int|null signedDocuments Количество подписанных документов в ФН * @property-read int|null signedDocuments Количество подписанных документов в ФН
* @property float|null fiscalStoragePercentageUse Наполненость ФН в % * @property-read float|null fiscalStoragePercentageUse Наполненость ФН в %
* @property string|null fiscalStorageINN ИНН компании (указанный в ФН) * @property-read string|null fiscalStorageINN ИНН компании (указанный в ФН)
* @property string|null fiscalStorageSerialNumber Заводской (серийный) номер ФН * @property-read string|null fiscalStorageSerialNumber Заводской (серийный) номер ФН
* @property string|null fiscalStoragePaymentAddress Адрес расчёта, указанный в ФН * @property-read string|null fiscalStoragePaymentAddress Адрес расчёта, указанный в ФН
* @property string|null groupCode Код группы кассы * @property-read string|null groupCode Код группы кассы
* @property DateTime|string|null timestamp Время и дата формирования данных, UTC * @property-read DateTime|string|null timestamp Время и дата формирования данных, UTC
* @property bool|null isShiftOpened Признак открыта смена (true) или закрыта (false) * @property-read bool|null isShiftOpened Признак открыта смена (true) или закрыта (false)
* @property int|null shiftNumber Номер смены (или "Номер закрытой смены", когда смена закрыта) * @property-read int|null shiftNumber Номер смены (или "Номер закрытой смены", когда смена закрыта)
* @property int|null shiftReceipt Номер документа за смену (или "Кол-во чеков закрытой смены", когда смена закрыта) * @property-read int|null shiftReceipt Номер документа за смену (или "Кол-во чеков закрытой смены", когда смена
* @property int|null unsentDocs Количество неотправленных документов. Указывается, если значение отлично от 0. * закрыта)
* @property DateTime|string|null firstUnsetDocTimestamp Дата первого неотправленного документа. Указывается, если * @property-read int|null unsentDocs Количество неотправленных документов. Указывается, если значение отлично от 0.
* @property-read DateTime|string|null firstUnsetDocTimestamp Дата первого неотправленного документа. Указывается, если
* есть неотправленные документы. * есть неотправленные документы.
* @property int|null networkErrorCode Код ошибки сети * @property-read int|null networkErrorCode Код ошибки сети
*/ */
final class Kkt extends Entity final class Kkt extends Entity
{ {

2
src/Exceptions/TooManyVatsException.php
View File

@ -14,7 +14,7 @@ namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints; use AtolOnline\Constants\Constraints;
/** /**
* Исключение, возникающее при попытке добавить слишком много ставок НДС в массив * Исключение, возникающее при попытке добавить слишком много ставок НДС в документ
*/ */
class TooManyVatsException extends TooManyException class TooManyVatsException extends TooManyException
{ {

5
tests/AtolOnline/Tests/Entities/VatTest.php
View File

@ -13,8 +13,7 @@ use AtolOnline\{
Entities\Vat, Entities\Vat,
Enums\VatTypes, Enums\VatTypes,
Exceptions\InvalidEnumValueException, Exceptions\InvalidEnumValueException,
Tests\BasicTestCase Tests\BasicTestCase};
};
/** /**
* Набор тестов для проверки работы класса ставки НДС * Набор тестов для проверки работы класса ставки НДС
@ -84,7 +83,7 @@ class VatTest extends BasicTestCase
} }
/** /**
* Тестирует расчёт суммы НДС от исходной суммы 100+20р и 100-20р * Тестирует расчёт суммы НДС от суммы 100+20р и 100-20р
* *
* @dataProvider providerVatsAdd * @dataProvider providerVatsAdd
* @param string $type Тип НДС * @param string $type Тип НДС