Class CrossReferenceTable in namespace setasign\SetaPDF2\Core\Document in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document

setasign\SetaPDF2\Core\Document

CrossReferenceTable Class representing a cross-reference table

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

Class hierarchy

CrossReferenceTable
- \setasign\SetaPDF2\Core\Parser\CrossReferenceTable\CorruptedCrossReferenceTable
- \setasign\SetaPDF2\Core\Parser\CrossReferenceTable\CrossReferenceTable

Summary

Properties

$_maxObjId
$_objectOffsets
$_pointerToXref
$_updatedOffsets

Properties

$_maxObjId

protected int CrossReferenceTable::$_maxObjId = 0

The greatest used object id

$_objectOffsets

protected array CrossReferenceTable::$_objectOffsets = array(...)

The cross-reference content

$_pointerToXref

protected int CrossReferenceTable::$_pointerToXref

The pointer to the last written xref table

$_updatedOffsets

protected array CrossReferenceTable::$_updatedOffsets = array()

Updated offsets

Methods

cleanUp()

public CrossReferenceTable::cleanUp (

void

): void

Release memory and cycled references.

deleteObject()

public CrossReferenceTable::deleteObject (

int $objectId

): void

Mark an object as deleted.

Parameters

$objectId: int

getCompressedStream()

public CrossReferenceTable::getCompressedStream (

\setasign\SetaPDF2\Core\Type\PdfDictionary $value,
int $newPointerToXref,
bool $onlyUpdated = true,
?string $compressionFilter = 'FlateDecode'

): bool|\setasign\SetaPDF2\Core\Type\PdfStream

Get the cross-reference as a compressed stream object.

Parameters

$value: \setasign\SetaPDF2\Core\Type\PdfDictionary
$newPointerToXref: int
$onlyUpdated: bool
$compressionFilter: ?string

getDefinedObjectIds()

public CrossReferenceTable::getDefinedObjectIds (

void

): array

Get all defined object ids.

getDefiniedObjectIds()

WARNING: This method is marked as deprecated!

public CrossReferenceTable::getDefiniedObjectIds (

void

): array

Alias for getDefinedObjectIds()

getGenerationNumberByObjectId()

public CrossReferenceTable::getGenerationNumberByObjectId (

int $objectId

): int|bool

Get the generation number by an object id.

Parameters

$objectId: int

getOffsetFor()

public CrossReferenceTable::getOffsetFor (

int $objectId,
?int $generation = 0

): int|array|bool

Get an offset for an object.

Parameters

$objectId: int
$generation: ?int

getPointerToXref()

public CrossReferenceTable::getPointerToXref (

void

): int

Returns the offset of the last written xref table.

getSize()

public CrossReferenceTable::getSize (

void

): int

Get the size of the cross-reference table.

isOffsetUpdated()

public CrossReferenceTable::isOffsetUpdated (

int $objectId

): bool

Checks if an objects offset is updated.

Parameters

$objectId: int

offsetsUpdated()

public CrossReferenceTable::offsetsUpdated (

void

): bool

Checks whether any offset was updated or not.

setOffsetFor()

public CrossReferenceTable::setOffsetFor (

int $objectId,
int $generation,
int|array $offset

): void

Set an object offset.

Parameters

$objectId: int
$generation: int
$offset: int|array

updateSize()

public CrossReferenceTable::updateSize (

int $objectId

): void

Updates the size value of this cross-reference table.

Parameters

$objectId: int

writeNormal()

public CrossReferenceTable::writeNormal (

\setasign\SetaPDF2\Core\Writer\WriterInterface $writer,
bool $onlyUpdated = true

): int

Writes the cross-reference to a writer.

Parameters

$writer: \setasign\SetaPDF2\Core\Writer\WriterInterface
$onlyUpdated: bool