SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Parser
    1. CrossReferenceTable

setasign\SetaPDF2\Core\Parser\CrossReferenceTable

CrossReferenceTableInterface Cross-reference table interface

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

Implemented in

Summary

Methods

getDefinedObjectIds()
getGenerationNumberByObjectId()
getParserOffsetFor()
getTrailer()
isCompressed()

Methods

getDefinedObjectIds()

abstract public CrossReferenceTableInterface::getDefinedObjectIds (

void

): array

Get all defined object ids.

This method returns an array of all objects which are noticed in any cross-reference table. The appearance of an object id in this list is not an evidence of existence of the desired object.

getGenerationNumberByObjectId()

abstract public CrossReferenceTableInterface::getGenerationNumberByObjectId (

int $objectId

): false|array

Get the generation number by an object id.

Parameters

$objectId : int

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getParserOffsetFor()

abstract public CrossReferenceTableInterface::getParserOffsetFor (

int $objectId,
?int $generation = null,
int &$objectGeneration = null

): bool|int

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.

getTrailer()

abstract public CrossReferenceTableInterface::getTrailer (

void

): \SetaPDF_Core_Type_Dictionary

Returns the trailer dictionary.

isCompressed()

abstract public CrossReferenceTableInterface::isCompressed (

void

): bool

Check if the xref table uses compressed xref streams.