SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. BitConverter
  2. Canvas
  3. ColorSpace
  4. Core
  5. DataStructure
  6. Document
  7. Document
  8. EmbeddedFileStream
  9. Encoding
  10. Exception
  11. FileSpecification
  12. Filter
  13. Font
  14. Geometry
  15. IccProfile
  16. Image
  17. OutputIntent
  18. PageBoundaries
  19. PageFormats
  20. Parser
  21. Reader
  22. Resource
  23. SecHandler
  24. Text
  25. Tokenizer
  26. TransparencyGroup
  27. Type
  28. Writer
  29. XObject
  30. Xmp
  31. Zugferd

setasign\SetaPDF2\Core

Zugferd A helper class to deal with ZUGFeRD (>= 2.3) documents

File: /SetaPDF v2/Core/Zugferd.php
Old class name (alias): \SetaPDF_Core_Zugferd

Class hierarchy

Zugferd

Summary

Static Methods

build()
extract()

Static Methods

build()

public static Zugferd::build (

\SetaPDF_Core_Document $document,
string $zugferdXml

): void

Adds the ZUGFeRD XML (>= 2.3) to a PDF/A-3 conforming PDF document instance and adds all relevant metadata information.

Parameters

$document : \SetaPDF_Core_Document
$zugferdXml : string

Exceptions

Throws DataStructure\Tree\KeyAlreadyExistsException

Throws Reader \Exception

Throws SecHandler \Exception

Throws Type \Exception

Throws \Exception

extract()

public static Zugferd::extract (

\SetaPDF_Core_Document $document

): false|string

Extract the ZUGFeRD XML (>= 2.3) from a document instance.

Parameters

$document : \SetaPDF_Core_Document

Return Values

If the document is not a ZUGFeRD document, false will be returned. Otherwise, the XML of the embedded file.

Exceptions

Throws SecHandler \Exception

Throws Type \Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException