SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Xmp
    1. PdfA
    2. PdfUa
    3. XmpHelper
    4. Zugferd

setasign\SetaPDF2\Core\Xmp

PdfUa A helper class to handle PDF/UA metadata

File: /SetaPDF v2/Core/Xmp/PdfUa.php

Class hierarchy

PdfUa

Summary

Static Methods

getPart()
update()
updateUa1()
updateUa2()

Static Methods

getPart()

public static PdfUa::getPart (

\setasign\SetaPDF2\Core\Document $document

): false|int

Get the PDF/UA part identifier.

Parameters

$document : \setasign\SetaPDF2\Core\Document

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

update()

public static PdfUa::update (

\setasign\SetaPDF2\Core\Document $document,
int $part

): void

Update the metadata and document with information for PDF/UA.

Parameters

$document : \setasign\SetaPDF2\Core\Document
$part : int

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

updateUa1()

public static PdfUa::updateUa1 (

\setasign\SetaPDF2\Core\Document $document,
?string $amd = null,
?string $corr = null

): void

Update the metadata and document with information for PDF/UA-1.

Parameters

$document : \setasign\SetaPDF2\Core\Document
$amd : ?string
$corr : ?string

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

updateUa2()

public static PdfUa::updateUa2 (

\setasign\SetaPDF2\Core\Document $document,
int $rev = 2024

): void

Update the metadata and document with information for PDF/UA-2.

Parameters

$document : \setasign\SetaPDF2\Core\Document
$rev : int: Four-digit year of the date of publication or revision.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception