EncryptDictionary
extends PdfObject
in package
Encryption dictionary (/Type /Encrypt) — ISO 32000-2 §7.6.
This is the object-model representation only. It serializes to a
spec-compliant dictionary but is not wired into PdfWriter's trailer
or into per-object string/stream encryption — callers implementing
actual encryption are responsible for driving the PdfKeyDerivation primitives and patching the writer
output themselves. This distinction is deliberate so the object model
stays usable for libraries that want to emit encryption metadata
without phpdftk taking over the crypto pipeline.
Covers both the Standard security handler (Table 21) and the Public-key handler (Table 26), plus the shared crypt filter entries.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_1
Table of Contents
Constants
- PDF_TYPE = 'Encrypt'
Properties
- $cf : PdfDictionary|null
- $eff : PdfName|null
- $encryptMetadata : bool|null
- $filter : PdfName
- $generationNumber : int
- $length : int|null
- $o : PdfString|null
- $objectNumber : int
- $oe : PdfString|null
- $p : int|null
- $perms : PdfString|null
- $r : int|null
- $recipients : PdfArray|null
- $stmF : PdfName|null
- $strF : PdfName|null
- $subFilter : PdfName|null
- $u : PdfString|null
- $ue : PdfString|null
- $v : int
Methods
- __construct() : mixed
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Serialize the object's dictionary/value to PDF syntax.
Constants
PDF_TYPE
public
mixed
PDF_TYPE
= 'Encrypt'
Properties
$cf
public
PdfDictionary|null
$cf
= null
$eff
public
PdfName|null
$eff
= null
$encryptMetadata
public
bool|null
$encryptMetadata
= null
$filter
public
PdfName
$filter
$generationNumber
public
int
$generationNumber
= 0
$length
public
int|null
$length
= null
$o
public
PdfString|null
$o
= null
$objectNumber
public
int
$objectNumber
= 0
$oe
public
PdfString|null
$oe
= null
$p
public
int|null
$p
= null
$perms
public
PdfString|null
$perms
= null
$r
public
int|null
$r
= null
$recipients
public
PdfArray|null
$recipients
= null
$stmF
public
PdfName|null
$stmF
= null
$strF
public
PdfName|null
$strF
= null
$subFilter
public
PdfName|null
$subFilter
= null
$u
public
PdfString|null
$u
= null
$ue
public
PdfString|null
$ue
= null
$v
public
int
$v
Methods
__construct()
public
__construct([string $filter = 'Standard' ][, int $v = 2 ]) : mixed
Parameters
- $filter : string = 'Standard'
- $v : int = 2
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string