SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. XmpHelper
  2. XmpHelper
    1. PdfA
    2. Zugferd

SetaPDF_Core_XmpHelper_PdfA A helper class to handle PDF/A metadata

File: /SetaPDF v2/Core/XmpHelper/PdfA.php

Class hierarchy

SetaPDF_Core_XmpHelper_PdfA

Summary

Static Methods

_extendShemaForTrappedValue()
getPartAndConformance()
update()

Static Methods

_extendShemaForTrappedValue()

protected static SetaPDF_Core_XmpHelper_PdfA::_extendShemaForTrappedValue (

SetaPDF_Core_Document_Info $info

): void

Adds XMP schema for the Trapped value.

Parameters

$info : SetaPDF_Core_Document_Info

Exceptions

Throws DOMException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getPartAndConformance()

public static SetaPDF_Core_XmpHelper_PdfA::getPartAndConformance (

SetaPDF_Core_Document $document

): array{0: string|false, 1: string|false}

Get the PDF/A part and conformance from a document instance.

Parameters

$document : SetaPDF_Core_Document

Return Values

Key 0 holds the part, key 1 the conformance

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

update()

public static SetaPDF_Core_XmpHelper_PdfA::update (

SetaPDF_Core_Document $document, string $part, string $conformance

): void

Updates the documents metadata package to PDF/A.

Parameters

$document : SetaPDF_Core_Document
$part : string: The PDF/A norm (e.g. 1, 2, or 3)
$conformance : string: The conformance level (e.g. B, U, or A)

Exceptions

Throws DOMException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception