NAME

Quiq::Mustang - Frontend für Mustang Kommendozeilen-Werkzeug

BASE CLASS

Quiq::Hash

DESCRIPTION

Mustang ist eine Java-Biblithek sowie ein Kommandzeilen-Werkzeug für den Umgang mit ZUGFeRD-Rechnungen. Die Klasse Quiq::Mustang stellt ein Perl-Frontend für die Nutzung des Kommandozeilen-Werkzeugs bereit.

METHODS

Klassenmethoden

new() - Konstruktor

Synopsis

$mus = $class->new($jarFile);

Arguments

$jarFile

Pfad zur JAR-Datei Mustang-CLI-X.Y.Z.jar, z.B. ~/Mustang-CLI-2.16.2.jar

Returns

Mustang-Objekt

Description

Instantiiere ein Objekt der Klasse und liefere eine Referenz auf dieses Objekt zurück.

Objektmethoden

validate() - Validiere ZUGFeRD-Datei

Synopsis

$status = $mus->validate($file);

Arguments

$file

ZUGFeRD-Datei, wie Mustang sie erwartet (als XML oder PDF).

Options

-force => $bool (Default: 0)

Forciere die Validierung, auch wenn sie schon einmal erfolgt ist.

-notice => $bool (Default: 0)

Protokolliere nicht nur Validierungsfehler, sondern gib darüber hinaus Empfehlungen zu Verbesserungen am ZUGFeRD XML aus.

-verbose => $bool (Default: 0)

Gib Laufzeitinformation über die Verarbeitung auf STDOUT aus.

Returns

(Integer) Status der Validierung: 0 = ok, 1 = fehlgeschlagen, -1 = Datei wurde übergangen, da bereits validiert.

Description

Validiere die ZUGFeRD-Datei $file und liefere den Status der Validierung zurück.

getResult() - Liefere Validierungsresultat

Synopsis

($status,$val) = $mus->getResult($pattern,$as);

($status,$text) = $mus->getResult($pattern,'text');
($status,$ruleH) = $mus->getResult($pattern,'hash');

Arguments

$pattern

Glob()-Pattern der Resultat-Datei des Mustang Validators.

$as

Typ des Returnwerts:

'text'
'hash'

Description

Liefere das Ergebnis der ZUGFeRD-Validierung.

visualize() - Visualisiere ZUGFeRD-Datei

Synopsis

$mus->visualize($xmlFile,$pdfFile);

Arguments

$xmlFile

ZUGFeRD XML-Datei

$pdfFile

Erzeugte Visualisierungsdatei (als PDF)

Description

Visualisiere die ZUGFeRD-Datei $xmlFile als PDF-Datei $pdfFile.

VERSION

1.226

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2025 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.