Index

  1. \setasign\SetaPDF2
    1. Core
      1. Parser
        1. CrossReferenceTable
          1. CorruptedCrossReferenceTable
          2. CrossReferenceTable
          3. CrossReferenceTableInterface
          4. Exception

setasign\SetaPDF2\Core\Parser\CrossReferenceTable

CorruptedCrossReferenceTable A PDF cross reference parser for corrupted pdfs

File: /SetaPDF v2/Core/Parser/CrossReferenceTable/CorruptedCrossReferenceTable.php
Old class name (alias): \SetaPDF_Core_Parser_CorruptedCrossReferenceTable

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_lastObjectOffset

protected int CorruptedCrossReferenceTable::$_lastObjectOffset

The offset of the last found object

$_matchedPositions

protected null CorruptedCrossReferenceTable::$_matchedPositions = array(...)

$_maxObjId

protected int \setasign\SetaPDF2\Core\Document\CrossReferenceTable::$_maxObjId = 0

The greatest used object id

$_objectOffsets

protected array \setasign\SetaPDF2\Core\Document\CrossReferenceTable::$_objectOffsets = array(...)

The cross-reference content

$_parser

protected \SetaPDF_Core_Parser_Pdf CorruptedCrossReferenceTable::$_parser

The PDF parser instance

$_parserObjectOffsets

protected array CorruptedCrossReferenceTable::$_parserObjectOffsets = array()

Object offsets in the parser File

$_pointerToXref

protected int \setasign\SetaPDF2\Core\Document\CrossReferenceTable::$_pointerToXref

The pointer to the last written xref table

$_trailer

protected \SetaPDF_Core_Type_Dictionary CorruptedCrossReferenceTable::$_trailer

The trailer dictionary

$_updatedOffsets

protected array \setasign\SetaPDF2\Core\Document\CrossReferenceTable::$_updatedOffsets = array()

Updated offsets


Methods

__construct()

public CorruptedCrossReferenceTable::__construct ()

The constructor.

Parameters
$parser : \SetaPDF_Core_Parser_Pdf
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

_extractObjectIds()

protected CorruptedCrossReferenceTable::_extractObjectIds (
string $buffer,
int $start
): int

Extracts object ids and their offsets from a buffer.

Parameters
$buffer : string
 
$start : int
 

_extractTrailers()

protected CorruptedCrossReferenceTable::_extractTrailers (
string $buffer,
int $start
): void

Extracts trailer information from a buffer.

Parameters
$buffer : string
 
$start : int
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception

_matchKeywords()

protected CorruptedCrossReferenceTable::_matchKeywords (
string $buffer,
int $start
): void

Extracts offsets for specific keywords from a buffer.

Parameters
$buffer : string
 
$start : int
 

_screen()

protected CorruptedCrossReferenceTable::_screen (
void
): void

Screens the file for objects and keywords.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

cleanUp()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::cleanUp (
void
): void

Release memory and cycled references.

deleteObject()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::deleteObject (
int $objectId
): void

Mark an object as deleted.

Parameters
$objectId : int
 

ensureTrailer()

public CorruptedCrossReferenceTable::ensureTrailer (
void
): void

Ensures that a trailer dictionary exists or is created.

Exceptions

Throws Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getCompressedStream()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::getCompressedStream (
\SetaPDF_Core_Type_Dictionary $value,
int $newPointerToXref,
bool $onlyUpdated = true
): bool|\SetaPDF_Core_Type_Stream

Get the cross-reference as a compressed stream object.

Parameters
$value : \SetaPDF_Core_Type_Dictionary
 
$newPointerToXref : int
 
$onlyUpdated : bool
 

getDefinedObjectIds()

public CorruptedCrossReferenceTable::getDefinedObjectIds (
void
): array

Get all defined object ids.

getDefiniedObjectIds()

WARNING: This method is marked as deprecated!

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::getDefiniedObjectIds (
void
): array

Alias for getDefinedObjectIds()

getGenerationNumberByObjectId()

public CorruptedCrossReferenceTable::getGenerationNumberByObjectId (
int $objectId
): int|bool

Get the generation number by an object id.

Parameters
$objectId : int
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getOffsetFor()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::getOffsetFor (
int $objectId,
?int $generation = 0
): int|array|bool

Get an offset for an object.

Parameters
$objectId : int
 
$generation : ?int
 

getParserOffsetFor()

public CorruptedCrossReferenceTable::getParserOffsetFor (
int $objectId,
?int $generation = null,
int &$objectGeneration = null
): false|array

Returns the offset position for a specific object.

Parameters
$objectId : int
 
$generation : ?int
 
$objectGeneration : int

The final generation number, resolved if no generation number was given.

getPointerToXref()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::getPointerToXref (
void
): int

Returns the offset of the last written xref table.

getSize()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::getSize (
void
): int

Get the size of the cross-reference table.

getTrailer()

public CorruptedCrossReferenceTable::getTrailer (
void
): \SetaPDF_Core_Type_Dictionary

Returns the trailer dictionary.

isCompressed()

public CorruptedCrossReferenceTable::isCompressed (
void
): bool

Check if the xref table uses compressed xref streams.

isOffsetUpdated()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::isOffsetUpdated (
int $objectId
): bool

Checks if an objects offset is updated.

Parameters
$objectId : int
 

offsetsUpdated()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::offsetsUpdated (
void
): bool

Checks whether any offset was updated or not.

setOffsetFor()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::setOffsetFor (
int $objectId,
int $generation,
int|array $offset
): void

Set an object offset.

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

updateSize()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::updateSize (
int $objectId
): void

Updates the size value of this cross-reference table.

Parameters
$objectId : int
 

writeNormal()

public \setasign\SetaPDF2\Core\Document\CrossReferenceTable::writeNormal (
\SetaPDF_Core_Writer_WriterInterface $writer,
bool $onlyUpdated = true
): int

Writes the cross-reference to a writer.

Parameters
$writer : \SetaPDF_Core_Writer_WriterInterface
 
$onlyUpdated : bool
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)