Interface SetaPDF_Core_Parser_CrossReferenceTable_CrossReferenceTableInterface in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Parser
    1. CrossReferenceTable
    2. CrossReferenceTable
      1. CrossReferenceTableInterface
      2. Exception

SetaPDF_Core_Parser_CrossReferenceTable_CrossReferenceTableInterface Cross-reference table interface

File: /SetaPDF v2/Core/Parser/CrossReferenceTable/CrossReferenceTableInterface.php

Implemented in

Summary

Methods

getDefinedObjectIds()

abstract public SetaPDF_Core_Parser_CrossReferenceTable_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 SetaPDF_Core_Parser_CrossReferenceTable_CrossReferenceTableInterface::getGenerationNumberByObjectId (

integer $objectId

): false|array

Get the generation number by an object id.

Parameters

$objectId : integer

Exceptions

Throws SetaPDF_Core_Type_Exception

getParserOffsetFor()

abstract public SetaPDF_Core_Parser_CrossReferenceTable_CrossReferenceTableInterface::getParserOffsetFor (

int $objectId [, int|null $generation = null [, integer &$objectGeneration = null ]]

): bool|int

Returns the offset position for a specific object.

Parameters

$objectId : int
$generation : int|null
$objectGeneration : integer: The final generation number, resolved if no generation number was given.

getTrailer()

abstract public SetaPDF_Core_Parser_CrossReferenceTable_CrossReferenceTableInterface::getTrailer (

void

): SetaPDF_Core_Type_Dictionary

Returns the trailer dictionary.

isCompressed()

abstract public SetaPDF_Core_Parser_CrossReferenceTable_CrossReferenceTableInterface::isCompressed (

void

): boolean

Check if the xref table uses compressed xref streams.