4.0.0

4.0.0

Author: filipsedivy

.docs/README.md

@@ -0,0 +1,116 @@
+# Client for electronic records of sale
+
+## Usage
+
+```php
+<?php
+use FilipSedivy\EET\Certificate;
+use FilipSedivy\EET\Dispatcher;
+use FilipSedivy\EET\Receipt;
+use Ramsey\Uuid\Uuid;
+
+$receipt = new Receipt;
+$receipt->uuid_zpravy = Uuid::uuid4();
+$receipt->id_provoz = '141';
+$receipt->id_pokl = '1patro-vpravo';
+$receipt->porad_cis = '141-18543-05';
+$receipt->dic_popl = 'CZ00000019';
+$receipt->dat_trzby = new DateTime;
+$receipt->celk_trzba = 500;
+
+$certificate = new Certificate('EET_CA1_Playground-CZ00000019.p12', 'eet');
+$dispatcher = new Dispatcher($certificate, Dispatcher::PLAYGROUND_SERVICE);
+
+try {
+    $dispatcher->send($receipt);
+
+    echo 'FIK: ' . $dispatcher->getFik();
+    echo 'BKP: ' . $dispatcher->getBkp();
+} catch (FilipSedivy\EET\Exceptions\EET\ClientException $exception) {
+    echo 'BKP: ' . $exception->getBkp();
+    echo 'PKP:' . $exception->getPkp();
+} catch (FilipSedivy\EET\Exceptions\EET\ErrorException $exception) {
+    echo '(' . $exception->getCode() . ') ' . $exception->getMessage();
+} catch (FilipSedivy\EET\Exceptions\Receipt\ConstraintViolationException $violationException) {
+    echo implode('<br>', $violationException->getErrors());
+}
+```
+
+## Certificate
+
+These are classes that allow the certificate to be exported without further processing.
+
+Received file in p12 format, the one that etrzby.cz will export.
+
+```php
+$certificate = FilipSedivy\EET\Certificate(string $file, string $password);
+```
+
+**Parameters:**
+- `string $file`: File path
+- `string $password`: Certificate password
+
+## Dispatcher
+
+Dispatcher is a class that takes care of recipe validation and communication with SoapClient.
+
+```php
+$dispatcher = FilipSedivy\EET\Dispatcher(Certificate $certificate, ?string $service = self::PRODUCTION_SERVICE, bool $validate = true);
+```
+
+**Parameters:**
+- `Certificate $certificate`: Certificate class instance
+- `?string $service`: Setting services (`self::PLAYGROUND_SERVICE` OR `self::PRODUCTION_SERVICE`)
+- `bool $validate`: Enable offline Receipt validation
+
+**Methods:**
+- `check(Receipt $receipt): bool`: Receipt verification without registering EET
+- `send(Receipt $receipt, bool $check = false): ?string`: Send EET to the server. If everything is OK, the string with FIK is returned. If `$check = true` is enabled, FIK is not returned
+
+## Exceptions
+
+All exceptions have a common namespace `FilipSedivy\EET\Exceptions`
+
+### EET\ClientException
+
+This is an exception that is thrown when there is a problem communicating with the target server.
+
+**This exception allows you to get the latest BKP, PKP and receipt.**
+
+```php
+try {
+    $dispatcher->send($receipt);
+} catch (FilipSedivy\EET\Exceptions\EET\ClientException $exception) {
+    echo 'BKP: ' . $exception->getBkp();
+    echo 'PKP:' . $exception->getPkp();
+    print_r($exception->getReceipt());
+}
+```
+
+### EET\ErrorException
+
+This error occurs when an error is returned directly from the EET server. In this case, the entire message is invalid and not recorded. For this reason it is not possible to get PKP and BKP code from the exception.
+
+`getCode()` returns the error code from the target server. `getMessage()` returns the translated error according to etrzby.cz documentation.
+
+```php
+try {
+    $dispatcher->send($receipt);
+} catch (FilipSedivy\EET\Exceptions\EET\ErrorException $exception) {
+     echo '(' . $exception->getCode() . ') ' . $exception->getMessage();
+}
+```
+
+### Receipt\ConstraintViolationException
+
+If validation is enabled, this exception is thrown in case of invalid value according to the scheme.
+
+In this case, the EET is not sent to the destination server and the Receipt is invalid and it is not possible to obtain BKP and PKP codes.
+
+```php
+try {
+    $dispatcher->send($receipt);
+} catch (FilipSedivy\EET\Exceptions\Receipt\ConstraintViolationException $violationException) {
+      echo implode('<br>', $violationException->getErrors());
+  }
+```

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+patreon: filipsedivy
+custom: https://filipsedivy.cz/donation?to=PHP-EET

.gitignore

@@ -1,3 +1,6 @@
-.idea/
-composer.lock
-vendor/
+# IDE
+/.idea
+
+# Composer
+/vendor
+/composer.lock

.travis.yml

@@ -1,6 +1,8 @@
 language: php
 php:
-  - 7.0
+  - 7.1
+  - 7.2
+  - 7.3
 
 cache:
   directories:
@@ -13,5 +15,4 @@ install:
   - travis_retry composer install --no-interaction --prefer-source
 
 script:
-  - vendor/bin/phpstan analyse -c phpstan.neon -l 7 src/
-  - vendor/bin/tester tests/
+  - travis_retry composer tests

CHANGELOG.md

@@ -1,147 +1,29 @@
-# PHP knihovna pro EET
+# Client for electronic records of sale
 
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/07f653430c254d0bbf3f40c8595f0c89)](https://www.codacy.com/app/mail_72/PHP-EET?utm_source=github.com&utm_medium=referral&utm_content=filipsedivy/PHP-EET&utm_campaign=badger)
 [![Build Status](https://travis-ci.org/filipsedivy/PHP-EET.svg?branch=master)](https://travis-ci.org/filipsedivy/PHP-EET) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://packagist.org/packages/filipsedivy/php-eet)
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/58a3ede2-9585-4e37-95ed-ca7726617ea8/mini.png)](https://insight.sensiolabs.com/projects/58a3ede2-9585-4e37-95ed-ca7726617ea8)
 
-ℹ️➡️ Možnost implementace EET přímo od autora knihovny + možnost odečtení slevy 5 000 Kč! [více informací](https://filipsedivy.github.io/PHP-EET/) ⬅️ℹ️
+If the library is useful, **[please make a donation now](https://filipsedivy.cz/donation?to=PHP-EET)**. Thank you!
 
-⚠️ Je třeba si aktualizovat EET knihovnu na verzi **v3.0.1**, jelikož předchozí verze neumožňuje odesílat opakované platby. **Aktualizace nemá vliv na kompatibilitu.** [Příručka jak opakovaně zasílat platby](https://github.com/filipsedivy/PHP-EET/wiki/Opakované-zas%C3%ADlán%C3%AD).
- ⚠️
-
-**Koukněte se na [přispěvatelé](#př%C3%ADspěvek), a příspějte taktéž na vývoj.** Díky těmto lidem je knihovna dále udržována a šířena zdarma jako open source.
-[Příspějte](https://github.com/filipsedivy/PHP-EET/wiki/Zaslán%C3%AD-př%C3%ADspěvku) a buďte na seznamu přispěvatelů
-
-V případě že podáváte **issue** a nenastavíte label - šítek, pro lepší přehlednost, tak je issue automaticky uzavřen bez řešení.
-Před podáním issue, prosím věnujte čas k pročtení [příručky](https://github.com/filipsedivy/PHP-EET/wiki/Issue-aneb-zaslán%C3%AD-chyby-nebo-nápadu).
-
-## Instalace
-
-### Composer
-
-Pro instalaci balíčku je nutné jej instalovat skrze [composer](https://getcomposer.org/).
+## Installation
 
 ```bash
 composer require filipsedivy/php-eet
 ```
 
-### Instalace bez composeru
-
-O tom jak nainstalovat závislosti bez composeru navštivte wiki - [instace bez composeru](https://github.com/filipsedivy/PHP-EET/wiki/Instalace-bez-composeru-pomoc%C3%AD-souboru)
-
-## Dokumentace
-
-Dokumentaci k použítí naleznete ve [wiki systému](https://github.com/filipsedivy/PHP-EET/wiki)
-
-Než se zeptáte, zkuste se do něj podívat, zda-li již problém není zdokumentován
-
-
-### Nejvíce zasílaných otázek
-* [Získání povinných kódů FIK, PKP a BKP](https://github.com/filipsedivy/PHP-EET/wiki/Z%C3%ADskán%C3%AD-BKP,-PKP-a-FIK-kódu)
-* [Popis prostředí playground a production a jejich nastavení](https://github.com/filipsedivy/PHP-EET/wiki/Práce-a-popis-prostřed%C3%AD)
-
-## Ukázka užití
-
-Ukázky naleznete ve složce **examples/**.
-
-Certifikát **EET_CA1_Playground-CZ00000019.p12** byl vydán pro účel testování Daňovou správou. Tento certifikát nepoužívejte pro ostrou verzi. Svůj certifikát si vygenerujete skrze rozhraní Daňové správy.
-
-```php
-<?php
-require_once __DIR__.'/vendor/autoload.php';
-
-use FilipSedivy\EET\Certificate;
-use FilipSedivy\EET\Dispatcher;
-use FilipSedivy\EET\Receipt;
-use FilipSedivy\EET\Utils\UUID;
-
-$certificate = new Certificate(__DIR__.'/EET_CA1_Playground-CZ00000019.p12', 'eet');
-$dispatcher = new Dispatcher($certificate);
-$dispatcher->setPlaygroundService();
-
-$uuid = UUID::v4();
-
-$r = new Receipt;
-$r->uuid_zpravy = $uuid;
-$r->id_provoz = '11';
-$r->id_pokl = 'IP105';
-$r->dic_popl = 'CZ1212121218';
-$r->porad_cis = '1';
-$r->dat_trzby = new \DateTime();
-$r->celk_trzba = 500;
-
-echo '<h2>---REQUEST---</h2>';
-echo '<pre>';
-
-try {
-    // Odeslání tržby
-    $dispatcher->send($r);
-
-    // Tržba byla úspěšně odeslána
-    echo sprintf('FIK: %s <br>', $dispatcher->getFik());
-    echo sprintf('BKP: %s <br>', $dispatcher->getBkp());
-}catch(\FilipSedivy\EET\Exceptions\EetException $ex){
-    // Tržba nebyla odeslána
-    echo sprintf('BKP: %s <br>', $dispatcher->getBkp());
-    echo sprintf('PKP: %s <br>', $dispatcher->getPkp());
-}catch(Exception $ex){
-    // Obecná chyba
-    var_dump($ex);
-}
-```
-
-# Nette rozšíření
-
-Od verze **3.1.0** je k dispozici do Nette rozšíření pro implementaci EET knihovny.
-
-Pro registraci je třeba do konfiguračního souboru přidat následujcí řádky
-
-```yaml
-eet:
-	certificate: 
-		file: Cesta k certifikátu
-		password: Heslo certifikátu
-	service: playgroud, production nebo cesta k wsdl souboru
-
-extensions:
-	eet: FilipSedivy\EET\Bridges\Nette\EetExtension
-```
-
-
-
-## Pomoc a řešní chyb
-
-V případě že potřebujete poradit, nebo při implementaci Vám třída zobrazuje chybu můžete využít následujících kontaktů.
-Základní pomoc je poskytována zcela zdarma. V ostatních případech se řídí dle aktuální ceny, kterou naleznete ve [wiki](https://github.com/filipsedivy/PHP-EET/wiki/Zasl%C3%A1n%C3%AD-p%C5%99%C3%ADsp%C4%9Bvku#co-z-toho-nebudu-m%C3%ADt).
-
-### Issues
-Issues je systém veřejných hlášení chyb. V rámci veřejné podpory jsou k dispozici štítky **otázka** a **potřebuji pomoc**.
-Před tím než vytvoříte issue, zkuste se podívat zda není problém již řešen nebo již vyřešen někým jiným. [Seznam problémů řešených i vyřešených](https://github.com/filipsedivy/PHP-EET/issues?q=label%3Aot%C3%A1zka+label%3A%22pot%C5%99ebuji+pomoc%22).
-
-### Email
-V případě že veřejné řešení problémů nepřipadá v úvahu, tak je možné mě kontaktovat na emailové adrese, kterou naleznete na mé osobní stránce https://filipsedivy.cz.
-
-## Příspěvek
-V případě že se vám knihovna líbí a je vám užitečná, můžete mi zaslat příspěvěk. Jak zaslat příspěvek a co z toho budete mít můžete nalést [ve wiki](https://github.com/filipsedivy/PHP-EET/wiki/Zasl%C3%A1n%C3%AD-p%C5%99%C3%ADsp%C4%9Bvku).
-
-### Přispěvatelé
-| Přispěvatel | Částka |
-|-------------|--------|
-| https://www.drento.cz | 1 000 Kč |
-| http://www.elektrahk.cz | 1 000 Kč |
-| http://www.nerosty.cz |500 Kč |
-| https://www.manvel.cz | 500 Kč |
-| https://www.skoda-dily.cz | 1 000 Kč |
-
-## Screencasty
-
-- Generování certifikátu pro EET - https://youtu.be/N5Cb9SqeP6g
-
-## Odkazy
-- etržby.cz - http://www.etrzby.cz/
-- Finanční správa - http://www.financnisprava.cz/cs/financni-sprava/eet
-- Daňový portál - https://adisspr.mfcr.cz/adistc/adis/idpr_pub/eet/eet_sluzby.faces
-- Informace o EET z pohledu podnikání - http://www.jakpodnikat.cz/eet-elektronicka-evidence-trzeb.php
-
-## Licence
-MIT - https://opensource.org/licenses/MIT
+## Documentation
+
+- [Usage](.docs/README.md#usage)
+- [Certificate](.docs/README.md#certificate)
+- [Dispatcher](.docs/README.md#dispatcher)
+- [Explanation of exceptions](.docs/README.md#exceptions)
+    - [EET\ClientException](.docs/README.md#eetclientexception)
+    - [EET\ErrorException](.docs/README.md#eeterrorexception)
+    - [Receipt\ConstraintViolationException](.docs/README.md#receiptconstraintviolationexception)
+
+## Links
+- http://www.etrzby.cz/
+- http://www.financnisprava.cz/cs/financni-sprava/eet
+- https://adisspr.mfcr.cz/adistc/adis/idpr_pub/eet/eet_sluzby.faces
+- http://www.jakpodnikat.cz/eet-elektronicka-evidence-trzeb.php