setasign\SetaPDF2\Core\Document

ObjectStreamCompressor Class for compressing objects in object-streams

File: /SetaPDF v2/Core/Document/ObjectStreamCompressor.php
Old class name (alias): \SetaPDF_Core_Document_ObjectStreamCompressor

Class hierarchy

Summary

Properties

$_compressionFilter

$_gcCollectCyclesThreshold

Define how many streams should be created before gc_collect_cycles() is called if GC is disabled.

This property allows manual control about the garbage collection to gain performance.

$_objectsPerStream


Methods

__construct()

public ObjectStreamCompressor::__construct (
\setasign\SetaPDF2\Core\Document $document,
int $objectsPerStream = 400,
int $callGcCollectAfterStreamsCount = 5,
?string $compressionFilter = 'FlateDecode'
)
Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$objectsPerStream : int

The maximum number of objects per object stream.

$callGcCollectAfterStreamsCount : int

A number of streams after which the gc_collect() method is called.

$compressionFilter : ?string

The filter name used in the object stream.

register()

public ObjectStreamCompressor::register (
void
): void

Register this instance at the document instance.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception