Přidání enumeračních (výčtových) konstant

[jakubboucek]

Toto závisí na #5 - nejdřív se musí mergnout ta

V kódu i v příkladech se pracuje pouze číselnou interpretací různých přepínačů.

BC: ne

Doplnil jsem sadu konstant, které odpovídají hodnotám v dokumentaci a upravil jsem příklady.

Původní zápis:

$opt = array(
    'type' => 1,
    'calculate_vat' => 2,
    'payment_method' => 2
);

Nový zápis:

$opt = array(
    'type' => VyfakturujEnum::DOCUMENT_TYPE_FAKTURA,
    'calculate_vat' => VyfakturujEnum::VAT_CALC_METHOD_AMOUNT_WITH_VAT,
    'payment_method' => VyfakturujEnum::PAYMENT_METHOD_CASH
);

Názvy konstant jsou většinou převzaty ze zdrojového kódu Vyfakturuj, ale nejsou 1:1 (drobné úpravy, stylystické i gramatické korekce).

[jakubboucek]

Doplním důvod zamítnutí pro archivaci: Nový zápis pomocí konstant může být vhodný pro programátory, naopak může děsit začátečníky – což je ovšem cílovka Vyfakturuj.

Upravit tak, aby konstanty byla volba, nikoliv hlavní cesta.

Tedy v dokumentaci i v příkladech bude vždy uvedeno číslo. Naopak se doplní odkazy na Apiary a pro zkušení se zmíní číselník v knihovně.

[jakubboucek]

Návrh nové textace:

Některá čísla v příkladu níže jsou číselná označení systémových typů.
Například: 'type' => 1 znamená, že vytvořený doklad bude Faktura a nikoliv třeba Výzva k platbě.
Popis všech hodnot najdete v dokumentaci: https://vyfakturujcz.docs.apiary.io/#reference/faktury
Zkušenější uživatelé mohou použít výčet možných hodnot v přiložené třídě VyfakturujEnum.

Screenshot:

[jakubboucek]

Upraveno, odsouhlaseno přes Hangouts, merguju.