Index

  1. \setasign\SetaPDF2
    1. Signer
      1. Asn1
      2. CertificateBundler
      3. Cms
      4. Digest
      5. DigestInterface
      6. DocumentSecurityStore
      7. Exception
      8. Exception
      9. InformationResolver
      10. Ocsp
      11. PemHelper
      12. Signature
      13. SignatureField
      14. Signer
      15. Timestamp
      16. TmpDocument
      17. Tsp
      18. ValidationRelatedInfo
      19. X509

setasign\SetaPDF2\Signer

TmpDocument Class for handling an intermediate version of the document that should be signed.

File: /SetaPDF v2/Signer/TmpDocument.php
Old class name (alias): \SetaPDF_Signer_TmpDocument

This class is used for an asyncron signature flow. Otherwise, it is used internally.

Class hierarchy

Summary

Methods

Properties

Properties

$_byteRange

protected array TmpDocument::$_byteRange

The byte range value

$_documentIdentification

protected array TmpDocument::$_documentIdentification = array(...)

Document identification related data

$_hashFileWriter

protected \setasign\SetaPDF2\Core\Writer\TempFileWriter TmpDocument::$_hashFileWriter

The writer instance for the 2nd temporary file, that represents the data to hash

$_identficationHash

protected string TmpDocument::$_identficationHash

Hash of the last state of the intermediate document version.

$_writer

protected \setasign\SetaPDF2\Core\Writer\FileInterface TmpDocument::$_writer

The file writer for the temporary version


Methods

__construct()

public TmpDocument::__construct ()

The constructor

The $writer parameter is optional and can be used in an asyncron workflow to have control over the temporary version of the document.

Parameters
$writer : ?\setasign\SetaPDF2\Core\Writer\FileInterface
 

_getHashByDocument()

protected TmpDocument::_getHashByDocument (): string

Get the SHA-256 hash by a document instance.

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Exception

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws Exception

destroy()

public TmpDocument::destroy (
void
): void

Unlinks the temporary file.

getByteRange()

public TmpDocument::getByteRange (
void
): array

Get the byte range.

getHashFile()

public TmpDocument::getHashFile (
void
): \setasign\SetaPDF2\Core\Reader\FilePath

Create and get the file path to a temporary file that represents the bytes that should be be used for hashing.

getSignatureContentLength()

public TmpDocument::getSignatureContentLength (
void
): int

Get the signature content length.

getWriter()

public TmpDocument::getWriter (
void
): \setasign\SetaPDF2\Core\Writer\FileInterface

Get the writer instance.

matchesDocument()

public TmpDocument::matchesDocument (): bool

Checks whether the document instance matches this temporary version.

The checks are done by the instance identification of the class instance frist. If this does not match, because of an asyncron workflow the document identifications are compared.

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Parser\Exception

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws Exception

save()

public TmpDocument::save (): void

Saves the temporary document to a writer instance.

Parameters
$writer : \setasign\SetaPDF2\Core\Writer\WriterInterface
 
Exceptions

Throws \setasign\SetaPDF2\Core\Reader\Exception

setByteRange()

public TmpDocument::setByteRange (
array $byteRange
): void

Set the final byte range.

Parameters
$byteRange : array
 

setDocumentIdentification()

public TmpDocument::setDocumentIdentification (): void

Set the document identification related data.

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
Exceptions

Throws Exception

Throws \setasign\SetaPDF2\Core\Parser\Exception

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setWriter()

public TmpDocument::setWriter (): void

Set the writer instance.

Parameters
$writer : \setasign\SetaPDF2\Core\Writer\FileInterface
 

updateIdentificationHash()

public TmpDocument::updateIdentificationHash (
void
): void

Updates the identification hash of the intermediate document version.

updateLastByteOffset()

public TmpDocument::updateLastByteOffset (
int $offset,
int $position,
int $length
): void

Updates the last byte offset in the /ByteRange entry in the to be signed document.

Parameters
$offset : int
 
$position : int
 
$length : int
 

writeSignature()

public TmpDocument::writeSignature (
string $signature
): void

Writes the signature into the reserved gap.

The signature string needs to have the same length as the gap.

Parameters
$signature : string
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)