Initial commit, v0.1.0-b

docs/company.md

@@ -0,0 +1,72 @@
+# Работа с компанией (продавцом)
+
+Объект компании инициализируется следующим образом:
+
+```php
+$customer = new AtolOnline\Entities\Company();
+```
+
+У объекта компании должны быть указаны все следующие атрибуты:
+* email (тег ФФД 1117);
+* ИНН (тег ФФД 1018);
+* тип системы налогообложения (тег ФФД 1055) - все типы перечислены в классе `AtolOnline\Constants\SnoTypes`;
+* адрес места расчётов (тег ФФД 1187) - для интернет-сервисов указывается URL с протоколом.
+
+> Все эти атрибуты являются **обязательными**.  
+> Для тестового режима используйте значения ИНН и адреса места расчётов, [указанные здесь](https://online.atol.ru/files/ffd/test_sreda.txt).
+
+Указать эти атрибуты можно двумя способами:
+
+```php
+// 1 способ - через конструктор
+$company = new AtolOnline\Entities\Company(
+    AtolOnline\Constants\SnoTypes::OSN, // тип СНО
+    '5544332219', // номер ИНН
+    'https://v4.online.atol.ru', // адрес места расчётов
+    'company@example.com' // email
+);
+
+// 2 способ - через сеттеры
+$company = (new AtolOnline\Entities\Company())
+    ->setEmail('company@example.com')
+    ->setInn('5544332219')
+    ->setSno(AtolOnline\Constants\SnoTypes::USN_INCOME)
+    ->setPaymentAddress('https://v4.online.atol.ru');
+
+// либо комбинация этих способов
+```
+
+Метод `setEmail()` проверяет входную строку на длину (до 64 символов) и валидность формата email.
+Выбрасывает исключения:
+* `AtolEmailTooLongException` (если слишком длинный email);
+* `AtolEmailValidateException` (если email невалиден).
+
+Метод `setInn()` чистит входную строку от всех символов, кроме цифр, и проверяет длину (либо 10, либо 12 цифр).
+Выбрасывает исключение `AtolInnWrongLengthException` (если длина строка ИНН некорректна).
+
+Метод `setPaymentAddress()` проверяет длину (до 256 символов).
+Выбрасывает исключение `AtolPaymentAddressTooLongException` (если слишком длинный адрес места расчётов).
+
+Конструктор может выбрасывать любое из указанных выше исключений, если в него передаются параметры.
+
+Получить установленные значения параметров можно через геттеры:
+
+```php
+$company->getInn();
+$company->getEmail();
+$company->getPaymentAddress();
+$company->getSno();
+```
+
+Объект класса приводится к JSON-строке автоматически или принудительным приведением к `string`:
+
+```php
+echo $company;
+$json_string = (string)$company;
+```
+
+Чтобы получить те же данные в виде массива, нужно вызвать метод `jsonSerialize()`:
+
+```php
+$json_array = $company->jsonSerialize();
+```