SetaPDF v2 API Reference

SetaPDF_Core_Document_ObjectStreamCompressor Class for compressing objects in object-streams

File: /SetaPDF v2/Core/Document/ObjectStreamCompressor.php

Class hierarchy

SetaPDF_Core_Document_ObjectStreamCompressor

Summary

Methods

__construct()
getCollector()
register()
setCollector()

Properties

$_collector
$_document
$_gcCollectCyclesThreshold
$_objectsPerStream

Properties

$_collector

protected SetaPDF_Core_Document_ObjectCollectorInterface SetaPDF_Core_Document_ObjectStreamCompressor::$_collector

$_document

protected SetaPDF_Core_Document SetaPDF_Core_Document_ObjectStreamCompressor::$_document

$_gcCollectCyclesThreshold

protected int SetaPDF_Core_Document_ObjectStreamCompressor::$_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

protected int SetaPDF_Core_Document_ObjectStreamCompressor::$_objectsPerStream

Methods

__construct()

public SetaPDF_Core_Document_ObjectStreamCompressor::__construct (

SetaPDF_Core_Document $document [, int $objectsPerStream = 400 [, int $callGcCollectAfterStreamsCount = 5 ]]

)

Parameters

$document : SetaPDF_Core_Document
$objectsPerStream : int
$callGcCollectAfterStreamsCount : int

getCollector()

public SetaPDF_Core_Document_ObjectStreamCompressor::getCollector (

void

): SetaPDF_Core_Document_ObjectCollector|SetaPDF_Core_Document_ObjectCollectorInterface

register()

public SetaPDF_Core_Document_ObjectStreamCompressor::register (

void

): void

Register this instance at the document instance.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setCollector()

public SetaPDF_Core_Document_ObjectStreamCompressor::setCollector (

SetaPDF_Core_Document_ObjectCollectorInterface $collector

): void

Parameters

$collector : SetaPDF_Core_Document_ObjectCollectorInterface