intermedia / ksef-fa3
PHP models for KSeF FA(3) with XML serializer and XSD validator
Requires
- php: ^8.1
- ext-dom: *
- ext-libxml: *
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Biblioteka generowana na podstawie schematów XSD systemu KSeF FA(3).
Zawiera komplet modeli PHP, enumów, serializer XML oraz walidator zgodny z XSD.
Zawartość
src/Model/*– klasy PHP odwzorowujące struktury z XSD (np.FakturaType,Podmiot1Type,FaType,FaWierszType,StopkaType).src/Enums/*– typy wyliczeniowe (np. kody krajów, waluty, formy płatności).src/Serializer/XmlSerializer.php– serializer obiektów PHP → XML zgodny ze schematem.src/Validator/XmlValidator.php– walidator dokumentów XML względem XSD.schema/*.xsd– schematy użyte do generacji.
Instalacja
composer require intermedia/ksef-fa3
Przykład użycia
<?php require __DIR__.'/vendor/autoload.php'; use Intermedia\Ksef\Fa3\Model\FakturaType; use Intermedia\Ksef\Fa3\Model\TNaglowek; use Intermedia\Ksef\Fa3\Model\Podmiot1Type; use Intermedia\Ksef\Fa3\Model\FaType; use Intermedia\Ksef\Fa3\Model\FaWierszType; use Intermedia\Ksef\Fa3\Serializer\XmlSerializer; use Intermedia\Ksef\Fa3\Validator\XmlValidator; // Tworzenie faktury $faktura = new FakturaType(); $faktura->naglowek = new TNaglowek(); $faktura->podmiot1 = new Podmiot1Type(); $pozycja = new FaWierszType(); $fa = new FaType(); $fa->faWiersz = [$pozycja]; $faktura->fa = $fa; // Serializacja do XML $serializer = new XmlSerializer(); $doc = $serializer->createDocument('Faktura', $faktura); echo $doc->saveXML(); // Walidacja względem XSD $validator = new XmlValidator(__DIR__.'/vendor/intermedia/ksef-fa3/schema/FA3.xsd'); $result = $validator->validate($doc); if ($result->isValid) { echo "Dokument jest poprawny względem XSD."; } else { foreach ($result->errors as $error) { echo $error->message, PHP_EOL; } }
Typy i właściwości
- Każda klasa ma statyczną metodę
schema(), która odwzorowuje definicję z XSD. - Wszystkie właściwości mają PHPDoc (
@var) z typem oraz opisem z dokumentacji XSD – dzięki temu IDE (PHPStorm, VSCode) podpowiada pola i opisy.
Modele pomocnicze AdresZamieszkaniaType, AdresSiedzibyType i AdresZamieszkaniaSiedzibyType
odwzorowują adres ze schematu DefinicjeTypy. Należy ustawić w nich jeden z wariantów:
adresPol (TAdresPolski) albo adresZagr (TAdresZagraniczny). Kod korzystający
z wcześniejszych, błędnych pól kodKraju, adresL1, adresL2 i gLN w tych trzech
modelach wymaga przejścia na odpowiedni wariant adresu. Adresy faktury FA(3) nadal
korzystają z modelu TAdres.
Uruchomienie przykładu i testów
W katalogu repozytorium:
composer dump-autoload
php example/generate_invoice.php
composer test
Testy obejmują zgodność XML z zapisanym wzorcem, adres korespondencyjny, oba warianty adresów pomocniczych, przywracanie ustawień libxml oraz walidację z lokalnymi XSD bez pobierania przez sieć.
Licencja
MIT