horstoeko / zugferd-laravel
A library for Laravel-Framework for creating and reading european electronic invoices
Installs: 1 025
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 3
Forks: 4
Open Issues: 0
Type:package
Requires
- php: ^7.3|^7.4|^8
- ext-json: *
- doctrine/dbal: ^2.9|^3|^4
- horstoeko/zugferd: ^1
- illuminate/bus: >=5.7
- illuminate/contracts: >=5.7
- illuminate/database: >=5.7
- illuminate/http: >=5.7
- illuminate/pagination: >=5.7
- illuminate/support: >=5.7
- symfony/yaml: ^5|^6|^7
Requires (Dev)
- pdepend/pdepend: ^2
- phploc/phploc: ^7
- phpmd/phpmd: ^2
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^9
- sebastian/phpcpd: ^6
- squizlabs/php_codesniffer: ^3
- theseer/phpdox: ^0
README
A simple ZUGFeRD/XRechnung/Factur-X Library for Laravel
Table of Contents
- ZUGFeRD/XRechnung/Factur-X for Laravel
- Table of Contents
- License
- Overview
- Dependencies
- Installation
- Usage
- Create a new Document Builder in the MINIMUM-Profile
- Create a new Document Builder in the BASIC-Profile
- Create a new Document Builder in the BASIC-WL-Profile
- Create a new Document Builder in the EN16931-Profile (COMFORT-Profile)
- Create a new Document Builder in the EXTENDED-Profile
- Create a new Document Builder in the XRECHNUNG-Profile (Version 2.2)
- Create a new Document Builder in the XRECHNUNG-Profile (Version 2.3)
- Create a new Document Builder in the XRECHNUNG-Profile (Version 3.0)
- Create a Document Reader from an existing XML file
- Create a Document Reader from an XML string
- Create a Document Reader from an existing PDF file (which has an attached XML file)
- Create a merged PDF (XML as attachment) by the output of a ZugferdDocumentBuilder
- Create a merged PDF by an existing XML file and existing PDF file
- Create a merged PDF by an existing XML data string and existing PDF file
- Create a merged PDF by an existing XML file and a PDF data string
- Create a merged PDF by an existing XML data string and a PDF data string
License
The code in this project is provided under the MIT license.
Overview
This library is an extension of the horstoeko/zugferd library for the Laravel framework. It provides facades for communication with the underlying library horstoeko/zugferd.
Dependencies
This package makes use of
Installation
There is one recommended way to install horstoeko/zugferd-laravel
via Composer:
- adding the dependency to your
composer.json
file:
"require": { .. "horstoeko/zugferd-laravel":"^1", .. },
Usage
In general, you should read the documentation and examples of the horstoeko/zugferd
library before using this library.
This package provides a facade ZugferdLaravel
which is used in the following examples.
Just add an use clause in the form of
use horstoeko\zugferdlaravel\Facades\ZugferdLaravel;
Create a new Document Builder in the MINIMUM-Profile
$document = ZugferdLaravel::createDocumentInMinimumProfile();
Create a new Document Builder in the BASIC-Profile
$document = ZugferdLaravel::createDocumentInBasicProfile();
Create a new Document Builder in the BASIC-WL-Profile
$document = ZugferdLaravel::createDocumentInBasicWlProfile();
Create a new Document Builder in the EN16931-Profile (COMFORT-Profile)
$document = ZugferdLaravel::createDocumentInEN16931Profile();
Create a new Document Builder in the EXTENDED-Profile
$document = ZugferdLaravel::createDocumentInExtendedProfile();
Create a new Document Builder in the XRECHNUNG-Profile (Version 2.2)
$document = ZugferdLaravel::createDocumentInXRechnung22Profile();
Create a new Document Builder in the XRECHNUNG-Profile (Version 2.3)
$document = ZugferdLaravel::createDocumentInXRechnung23Profile();
Create a new Document Builder in the XRECHNUNG-Profile (Version 3.0)
$document = ZugferdLaravel::createDocumentInXRechnung30Profile();
Create a Document Reader from an existing XML file
$document = ZugferdLaravel::readXmlFromFile('/path/to/file.xml');
Create a Document Reader from an XML string
$document = ZugferdLaravel::readXmlFromString('<xml>...</xml>');
Create a Document Reader from an existing PDF file (which has an attached XML file)
$document = ZugferdLaravel::readXmlFromPdfFile('/path/to/file.pdf');
Create a merged PDF (XML as attachment) by the output of a ZugferdDocumentBuilder
$document = ZugferdLaravel::createDocumentInEN16931Profile(); $document ->setDocumentInformation("471102", "380", \DateTime::createFromFormat("Ymd", "20180305"), "EUR") ->....; $pdfDataOrFilename = '/path/to/file.pdf'; $mergedPdfFilename = '/path/to/merged.pdf'; ZugferdLaravel::buildMergedPdfByDocumentBuilder($document, $pdfDataOrFilename, $mergedPdfFilename);
Create a merged PDF by an existing XML file and existing PDF file
$xmlDataOrFilename = '/path/to/file.xml'; $pdfDataOrFilename = '/path/to/file.pdf'; $mergedPdfFilename = '/path/to/merged.pdf'; ZugferdLaravel::buildMergedPdfByXmlDataOrXmlFilename($xmlDataOrFilename, $pdfDataOrFilename, $mergedPdfFilename);
Create a merged PDF by an existing XML data string and existing PDF file
$xmlDataOrFilename = '<?xml version="1.0" encoding="UTF-8"?><rsm:CrossIndustryInvoice.....'; $pdfDataOrFilename = '/path/to/file.pdf'; $mergedPdfFilename = '/path/to/merged.pdf'; ZugferdLaravel::buildMergedPdfByXmlDataOrXmlFilename($xmlDataOrFilename, $pdfDataOrFilename, $mergedPdfFilename);
Create a merged PDF by an existing XML file and a PDF data string
$xmlDataOrFilename = '/path/to/file.xml'; $pdfDataOrFilename = '%PDF-1.5....'; $mergedPdfFilename = '/path/to/merged.pdf'; ZugferdLaravel::buildMergedPdfByXmlDataOrXmlFilename($xmlDataOrFilename, $pdfDataOrFilename, $mergedPdfFilename);
Create a merged PDF by an existing XML data string and a PDF data string
$xmlDataOrFilename = '<?xml version="1.0" encoding="UTF-8"?><rsm:CrossIndustryInvoice....'; $pdfDataOrFilename = '%PDF-1.5....'; $mergedPdfFilename = '/path/to/merged.pdf'; ZugferdLaravel::buildMergedPdfByXmlDataOrXmlFilename($xmlDataOrFilename, $pdfDataOrFilename, $mergedPdfFilename);