Index

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

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

File: /SetaPDF v2/Signer/TmpDocument.php

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

Class hierarchy

Summary

Methods

Properties

Properties

$_byteRange

protected array SetaPDF_Signer_TmpDocument::$_byteRange

The byte range value

$_documentIdentification

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

Document identification related data

$_hashFileWriter

protected SetaPDF_Core_Writer_TempFile SetaPDF_Signer_TmpDocument::$_hashFileWriter

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

$_identficationHash

protected string SetaPDF_Signer_TmpDocument::$_identficationHash

Hash of the last state of the intermediate document version.

$_writer

protected SetaPDF_Core_Writer_FileInterface SetaPDF_Signer_TmpDocument::$_writer

The file writer for the temporary version


Methods

__construct()

public SetaPDF_Signer_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 : SetaPDF_Core_Writer_FileInterface
 

_getHashByDocument()

private SetaPDF_Signer_TmpDocument::_getHashByDocument (): string

Get the SHA-256 hash by a document instance.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws SetaPDF_Signer_Exception

destroy()

public SetaPDF_Signer_TmpDocument::destroy (
void
): void

Unlinks the temporary file.

getByteRange()

public SetaPDF_Signer_TmpDocument::getByteRange (
void
): array

Get the byte range.

getHashFile()

public SetaPDF_Signer_TmpDocument::getHashFile (
void
): SetaPDF_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 SetaPDF_Signer_TmpDocument::getSignatureContentLength (
void
): integer

Get the signature content length.

getWriter()

public SetaPDF_Signer_TmpDocument::getWriter (
void
): SetaPDF_Core_Writer_FileInterface

Get the writer instance.

matchesDocument()

public SetaPDF_Signer_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 : SetaPDF_Core_Document
 

save()

public SetaPDF_Signer_TmpDocument::save (): void

Saves the temporary document to a writer instance.

Parameters
$writer : SetaPDF_Core_Writer_WriterInterface
 

setByteRange()

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

Set the final byte range.

Parameters
$byteRange : array
 

setDocumentIdentification()

public SetaPDF_Signer_TmpDocument::setDocumentIdentification (): void

Set the document identification related data.

Parameters
$document : SetaPDF_Core_Document
 

setWriter()

public SetaPDF_Signer_TmpDocument::setWriter (): void

Set the writer instance.

Parameters
$writer : SetaPDF_Core_Writer_FileInterface
 

updateIdentificationHash()

public SetaPDF_Signer_TmpDocument::updateIdentificationHash (
void
): void

Updates the identification hash of the intermediate document version.

updateLastByteOffset()

public SetaPDF_Signer_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 SetaPDF_Signer_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
 

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