class final Core · roukmoute/pdf 0.6.1
PDF\Serialization\SerializationContextAn identity map and serialization guard scoped to one PDF file.Inheritance and contracts
This type declares no parent, interface or trait.
Construction
__construct()
public function __construct(PDF\Syntax\Object\IndirectObject\ObjectNumber $firstNewNumber = new ObjectNumber(), PDF\Syntax\FileStructure\RevisionObject|PDF\Syntax\FileStructure\RevisionReference|PDF\Syntax\FileStructure\RetiredObjectGeneration|PDF\Syntax\FileStructure\FreeListState|PDF\Security\FileEncryption|PDF\Security\DocumentMetadataExemption|PDF\Syntax\Linearization\ObjectIdentifierRemapping ...$existingObjects)Declared methods
effectiveReferenceValue()
public function effectiveReferenceValue(PDF\Syntax\Object\IndirectReference $reference): PDF\Syntax\FileStructure\BasicTypeResolve a known generation without allocating unknown targets or reparsing historical builders.encryptStream()
public function encryptStream(PDF\Syntax\Object\StreamObject $stream, string $bytes): stringStream encoders run before encryption; xref and excluded metadata bytes stay clear.excludeDocumentMetadata()
public function excludeDocumentMetadata(PDF\Security\DocumentMetadataExemption $exemption): voidSelect the effective root metadata after incremental bindings have been staged.identifier()
public function identifier(PDF\Syntax\FileStructure\BasicType $object): PDF\Syntax\Object\IndirectObject\ObjectIdentifierisByteRangeSignature()
public function isByteRangeSignature(PDF\Syntax\Object\DictionaryType $dictionary): boolRecognizes byte-range signature containers; object signatures without ByteRange use normal encryption.isHistorical()
public function isHistorical(PDF\Syntax\FileStructure\BasicType $object): boolknownIdentifier()
public function knownIdentifier(PDF\Syntax\FileStructure\BasicType $object): ?PDF\Syntax\Object\IndirectObject\ObjectIdentifierInspect an existing identity without allocating or discovering another object.objects()
public function objects(): array@return array<int, BasicType>prepare()
public function prepare(PDF\Syntax\FileStructure\BasicType|PDF\Syntax\Object\IndirectObject ...$roots): voidDiscover explicit identifiers before assigning automatic numbers.prepareFile()
public function prepareFile(PDF\Syntax\FileStructure\FileBody $body, PDF\Syntax\Object\IndirectReference $root, ?PDF\Syntax\Object\DictionaryType $trailer = null): voidDiscover trailer values without promoting direct values to orphan indirect objects.recordStreamEmission()
public function recordStreamEmission(PDF\Syntax\Object\StreamObject $stream, PDF\Syntax\Object\DictionaryType $dictionary, string $encoded): voidCalled by StreamObject with the actual final dictionary and same-call pre-encryption bytes.reference()
public function reference(PDF\Syntax\Object\IndirectReference $reference): PDF\Syntax\Object\IndirectObject\ObjectIdentifierreferenceTo()
public function referenceTo(PDF\Syntax\FileStructure\BasicType $target): PDF\Syntax\Object\IndirectReferencereferences()
public function references(): array@return list<RevisionReference>register()
public function register(PDF\Syntax\FileStructure\BasicType $object, ?PDF\Syntax\Object\IndirectObject\ObjectIdentifier $identifier = null): PDF\Syntax\Object\IndirectObject\ObjectIdentifierserialize()
public function serialize(PDF\Syntax\FileStructure\BasicType $object): stringserializeEntry()
public function serializeEntry(PDF\Syntax\Object\DictionaryType $dictionary, PDF\Syntax\Object\DictionaryObject\Entry $entry): stringSignature container Contents stay clear; this also matches qpdf's signature handling.serializeIndirect()
public function serializeIndirect(PDF\Syntax\FileStructure\BasicType $object, ?PDF\Syntax\Object\IndirectObject\ObjectIdentifier $containingIdentifier = null): stringA normalized copy may use its containing object's identifier without acquiring a second identity.serializeStreamValue()
public function serializeStreamValue(PDF\Syntax\FileStructure\BasicType|PDF\Syntax\ContentStreamsResources\ContentStreams $object): stringEmbedded object and content-stream strings are encrypted with their containing stream.serializedSnapshot()
public function serializedSnapshot(PDF\Syntax\FileStructure\BasicType $value, ?PDF\Syntax\Object\IndirectObject\ObjectIdentifier $identifier = null): PDF\Syntax\FileStructure\SerializedRevisionValuestage()
public function stage(PDF\Syntax\Object\IndirectObject $object): PDF\Syntax\Object\IndirectObject\ObjectIdentifierSelect an explicit addition or replacement; historical references alone never stage a value.stageReused()
public function stageReused(PDF\Syntax\Object\IndirectObject $object): PDF\Syntax\Object\IndirectObject\ObjectIdentifierA reuse is authorized only against the preceding effective free index.streamFilters()
public function streamFilters(PDF\Syntax\Object\StreamObject $stream): array@return list<Filter>wasSerializedExternalStream()
public function wasSerializedExternalStream(PDF\Syntax\Object\StreamObject $stream): boolAn unchanged emitted stream must not lose the declaration that made its retained bytes external.