spoje.net/flexipeehp

PHP Based Library for easy interaction with czech accounting system Flexibee.

FlexiPeeHP

, _(*1)

PHP Based Library for easy interaction with Czech accounting system FlexiBee., _(*2)

CZ: PHP Knihovna pro snadnou práci s českým ekonomickým systémem FlexiBee, _(*3)

:exclamation: Tato knihovna bude označena za zastaralou. Věnujte prosím pozornost její odlehčené nástupkyni https://github.com/Spoje-NET/php-flexibee :exclamation:, _(*4)

, _(*5)

, _(*6)

, _(*7)

Poděkování

Vznik této knihovny by nebyl možný bez laskavé podpory společnosti Spoje.Net, která hradila vývoj řešení pro propojení LMS / FlexiBee a importu skladu. :+1:, _(*8)

, _(*9)

Dále chci poděkovat technické podpoře společnosti ABRA Flexi s.r.o. za jejich svatou trpělivost při reakcích na mé ne vždy bystré otázky a bugreporty., _(*10)

Parsování výsledků pro účely GDPR logování bylo dopracováno za laskavé podpory <PureHTML>, _(*11)

Instalace

composer require spoje.net/flexipeehp

pokud váš výsledný composer.json bude vypadat zhruba takto:, _(*12)

{
    "name": "vendor/projectname",
    "description": "Test",
    "type": "project",
    "require": {
        "spoje.net/flexipeehp": "*"
    },
    "license": "MIT",
    "authors": [
        {
            "name": "Vítězslav Dvořák",
            "email": "info@vitexsoftware.cz"
        }
    ],
    "minimum-stability": "stable"
}

spustí se příkazem composer install instalace:, _(*13)

, _(*14)

Konfigurace

Konfigurace se provádí nastavením následujících konstant:, _(*15)

   /*
    * URL Flexibee API
    */
    define('FLEXIBEE_URL', 'https://flexibee-dev.spoje.net:5434');
   /*
    * Uživatel FlexiBee API
    */
    define('FLEXIBEE_LOGIN', 'apiuser');
   /*
    * Heslo FlexiBee API
    */
    define('FLEXIBEE_PASSWORD', 'apipass');
   /*
    * Společnost v FlexiBee
    */
    define('FLEXIBEE_COMPANY', 'test_s_r_o_');
   /*
    * Nebo pokud nechceme používat jméno a heslo 
    */
    define('FLEXIBEE_AUTHSESSID', '6QuifebMits'); //Volitelné
   /*
    * Pomalý server, velká databáze a přes modem k tomu
    */
    define('FLEXIBEE_TIMEOUT', 60); //Volitelné

nebo je možné přihlašovací údaje zadávat při vytváření instance třídy., _(*16)

    $invoicer = new \FlexiPeeHP\FakturaVydana(null,[
                'company' => 'Firma_s_r_o_',
                'url' => 'https://flexibee.firma.cz/',
                'user' => 'rest',
                'password' => '-dj3x21xaA_'
            ]);

Tento způsob nastavení má vyšší prioritu než výše uvedené definovaní konstant., _(*17)

    $order = new \FlexiPeeHP\ObjednavkaPrijata('code:OBP0034/2019',['companyUrl'=> $_GET['companyUrl'], 'authSessionId'=>$_GET['authSessionId'] ])

Takto se ke flexibee a konrétní objednávce může připojit aplikace vyvolaná uživatelským tlačítkem předávajícím hodnoty companyUrl a authSessionId, _(*18)

Jak to celé funguje ?

Ústřední komponentou celé knihovny je Třída FlexiBeeRO, která je schopna pomocí PHP rozšíření curl komunikovat s REST Api FlexiBee., _(*19)

Z ní jsou pak odvozeny třídy pro jednotlivé evidence, obsahující metody pro často používané operace, například "Zaplať" v případě přijatých faktur., _(*20)

Nová odvozená třída vzniká tak, že jméno třídy je název evidence avšak bez pomlček. Ty jsou ve jméně nahrazeny velkým písmenem., _(*21)

    function evidenceToClass($evidence)
    {
        return str_replace(' ', '', ucwords(str_replace('-', ' ', $evidence)));
    }

Tzn. Pokud chceme odvodit novou třídu pro evidenci "Měrné jednotky" bude vypadat takto:, _(*22)

    <?php
    /**
     * @link https://demo.flexibee.eu/c/demo/merna-jednotka/properties Vlastnosti evidence
     */
    class MernaJednotka extends /FlexiPeeHP/FlexiBee
    {
        /**
         * Evidence užitá objektem.
         *
         * @var string
         */
        public $evidence = 'merna-jednotka';
    }

A poté je již snadné si vypsat měrné jednotky na 2 řádky:, _(*23)

    $jednotky = new MernaJednotka();
    print_r( $jednotky->getAllFromFlexiBee() );

Pokud chceme aby nově vytvořená třída uměla do flexibee i zapisovat, je třeba jí odvodit od předka FlexiBeeRW., _(*24)

Více příkladů použití je možné najít v samostatném projektu, _(*25)

Struktura Evidencí, Akcí a vztahů

V některých případech je dobré znát jaké můžeme provádět akce, či jáká je struktura evidence. Tyto informace je možno získat voláním https://demo.flexibee.eu/c/demo//properties.json respektive https://demo.flexibee.eu/c/demo//actions.json avšak jedná se o relativně časově náročné operace. Jelikož se struktura evidencí a Akce či vztahy mezi evidencemi FlexiBee často nemění FlexiPeeHP disponuje mechanizmem který umožní pracovat s těmito údaji bez nutnosti dotazovat se na ně serveru., _(*26)

Struktura je uložena ve třídě Structure (Actions,Relations) která obsahuje staticky definované pole obsahující informace které by jinak bylo nutné získat z FlexiBee., _(*27)

Položku v seznamu evidencí https://demo.flexibee.eu/c/demo/evidence-list je pak možné kdykoliv snadno ukázat:, _(*28)

    echo \FlexiPeeHP\Structure::$evidence['faktura-vydana'];

Sturktury jednotlivých evidencí jsou pak uloženy ve statických proměnných. Jejich jméno se řídí stejnými pravidly jako jsou pro vytváření jména nové třídy jen s tím rozdílem, že první písmeno je malé. Tzn.:, _(*29)

    lcfirst(\FlexiPeeHP\FlexiBeeRO::evidenceToClassName($evidence))

V případě potřeby je možné tyto třídy pak možné vygenerovat s aktuálním obsahem následujícím příkazem:, _(*30)

cd tools/ ./update_all.sh, _(*31)

Operace trvá několik minut. Zobrazit průběh můžeme takto:, _(*32)

tail -f /var/log/syslog | grep FlexiPeeHPtest, _(*33)

Ladicí režim

Pokud v objektech FlexiPeeHP nastavíte $this->debug na true, budou se před odesláním dat do FlexiBee provedeny dodatečné testy. Kontrolují se tyto možné chyby:, _(*34)

• Existuje vkládané políčko definované pro evidenci ?
• Je vkládané políčko Pouze pro čtení ?
• Pokud je vkládané políčko vazbou, je i polem ?

V ladícím režimu se také ukládají do složky /tmp všechny požadavky na flexibee a jejich odpovědi, _(*35)

Knihovna obsahuje mechanizmus pro odesílání zaznamenaných chyb při běhu FlexiBee vývojářům:, _(*36)

Pokud FlexiBee vrátí Internal Server Error 500, je odeslán vývojářům email obsahující chybovou zprávu., _(*37)

V případě že je použito FlexiBee běžící na stejném serveru a je možné číst chybové logy je z nich vypreparován patřičný fragment a i ten je přidán do těla mailu., _(*38)

Email obsahuje také dodatečné informace o licenci a povolených modulech., _(*39)

Jako přílohy jsou také připojeny soubory obsahující tělo dotazu na server, tělo jeho odpovědi a soubor obsahující informace o curl., _(*40)

Během života objektu se chyby evidují a odesílá se pouze první každého druhu., _(*41)

Testování

PHPUnit testy se nachází ve složce testing. Pokud chcete testovat proti jinému serveru než je oficální http://demo.flexibee.eu/ , je třeba změnit nastavení v souboru bootstrap.php., _(*42)

Obsah proměnné $testServer určuje která z předvolených nastavení budou použita. A samozřejmě si můžete nadefinovat i vlastní. Jako příklad je zde uveden testovací server spoje.net., _(*43)

Pro testování vytvořte prosím nejprve testovací firmu TESTING s.r.o. a nastavte přístupové údaje uživatele s oprávněním používat REST API. (Což je uživatel administrátora zadaný při instalaci FlexiBee.), _(*44)

Upozornění: testování proti firmě s množstvím faktur a připojenou bankou může trvat nějakou dobu, jelikož se testuje i zavolání automatického párování dokladů., _(*45)

Pokud se ve vašem projektu rozhodnete podědit FlexiPeeHP a k těmto třídám napíšete testy také poděděné z FlexiPeeHP např:, _(*46)

class HookRecieverTest extends \Test\FlexiPeeHP\ChangesTest, _(*47)

Přidejte do vašeho composer.json i cesty k původním testům:, _(*48)

"autoload-dev": {
    "psr-4": {
        "Test\\": "vendor/spoje.net/flexipeehp/testing/src/FlexiPeeHP/testing/",
        "Test\\Ease\\": "vendor/vitexsoftware/ease-framework/tests/src/Ease",
        "Test\\FlexiPeeHP\\": "vendor/spoje.net/flexipeehp/testing/src/FlexiPeeHP/",
     }
}

Ukázka

Ve složce Examples jsou tyto ukázky použití:, _(*49)

Příklady použití:

• Flexplorer Vývojářský nástoj a editor záznamů
• FlexiProXY Modifikátor webového rozhraní FlexiBee
• Upomínač Odesílač upomínek
• Matcher Párovač fakur
• Redmine2FlexiBee Generuje faktury z odpracovaného času v Redmine
• FlexiPeeHP-Bricks Příklady a často požívaní třídy při práci s FlexiBee
• TestingTools Nástroje pro testování FlexiBee aplikací

Reference:

• Import dat z FAPI do FlexiBee - blahasoft.cz
• Import dat z iDokladu do FlexiBee - blahasoft.cz

Docker

docker pull vitexsoftware/flexipeehp

Debian/Ubuntu

Pro Linux jsou k dispozici .deb balíčky. Prosím použijte repo:, _(*50)

wget -O - http://v.s.cz/info@vitexsoftware.cz.gpg.key|sudo apt-key add -
echo deb http://v.s.cz/ stable main > /etc/apt/sources.list.d/ease.list
aptitude update
aptitude install flexipeehp

V tomto případě je potřeba do souboru composer.json vaší aplikace přidat:, _(*51)

    "require": {
        "spojenet_flexipeehp": "*",
        "vitexsoftware_ease-framework": "*"
    },
    "repositories": [
        {
            "type": "path",
            "url": "/usr/share/php/FlexiPeeHP",
            "options": {
                "symlink": true
            }
        },
        {
            "type": "path",
            "url": "/usr/share/php/Ease",
            "options": {
                "symlink": true
            }
        }
    ]

Takže při instalaci závislostí bude vypadat nějak takto:, _(*52)

Loading composer repositories with package information
Installing dependencies from lock file
  - Installing vitexsoftware_ease-framework (1.1.3.3)
    Symlinked from /usr/share/php/Ease

  - Installing spojenet_flexipeehp (0.2.1)
    Symlinked from /usr/share/php/FlexiPeeHP

A aktualizaci bude možné dělat globálně pro celý systém prostřednictvím apt-get., _(*53)

Generujeme také balíček flexipeehp-doc, obsahující vývojářskou dokumentaci generovanou pomcí programu ApiGen. Dokumnentace je online k nahlédnutí na adrese http://flexibee-dev.spoje.net/flexipeehp/, _(*54)

Testování:, _(*55)

 cd /usr/share/doc/FlexiPeeHP/
 composer install
 php -f flexibeeping.php

, _(*56)

Sestavení

Debianí balíček vytvoříme spuštěním make deb, _(*57)

Obraz pro Docker:, _(*58)

docker build -t vitexsoftware/flexipeehp

FlexiBee knihovny pro další jazky:

• Flexipy (Python) Dokumentace
• Flexibee.rb (Ruby)
• UniMapper Flexibee extension (PHP)
• Flexibee client (PHP)
• Flexibee (Java)

Statistiky práce na projektu WakaTime, _(*59)