API Reference

Index

\setasign\Fpdi
1. PdfParser
  1. CrossReference

setasign\Fpdi\PdfParser\CrossReference

CrossReference Class CrossReference

File: /FPDI v2/PdfParser/CrossReference/CrossReference.php

This class processes the standard cross reference of a PDF document.

Class hierarchy

CrossReference

Summary

Static Properties

$trailerSearchLength

static public int CrossReference::$trailerSearchLength = 5500

The byte length in which the "startxref" keyword should be searched.

Properties

$fileHeaderOffset

protected int CrossReference::$fileHeaderOffset = 0

$parser

protected \setasign\Fpdi\PdfParser\PdfParser CrossReference::$parser

$readers

protected ReaderInterface[] CrossReference::$readers = array()

Methods

__construct()

public CrossReference::__construct (

\setasign\Fpdi\PdfParser\PdfParser $parser [, $fileHeaderOffset = 0 ]

)

CrossReference constructor.

Parameters

$parser : \setasign\Fpdi\PdfParser\PdfParser
$fileHeaderOffset

Exceptions

Throws CrossReferenceException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

checkForEncryption()

protected CrossReference::checkForEncryption (

\setasign\Fpdi\PdfParser\Type\PdfDictionary $dictionary

): void

Check for encryption.

Parameters

$dictionary : \setasign\Fpdi\PdfParser\Type\PdfDictionary

Exceptions

Throws CrossReferenceException

findStartXref()

protected CrossReference::findStartXref (

void

): int

Find the start position for the first cross-reference.

Return Values

The byte-offset position of the first cross-reference.

Exceptions

Throws CrossReferenceException

getIndirectObject()

public CrossReference::getIndirectObject (

int $objectNumber

): \setasign\Fpdi\PdfParser\Type\PdfIndirectObject

Get an indirect object by its object number.

Parameters

$objectNumber : int

Exceptions

Throws CrossReferenceException

getOffsetFor()

public CrossReference::getOffsetFor (

int $objectNumber

): integer|bool

Get the offset by an object number.

Parameters

$objectNumber : int

getReaders()

public CrossReference::getReaders (

void

): ReaderInterface[]

Get the cross reference readser instances.

getSize()

public CrossReference::getSize (

void

): integer

Get the size of the cross reference.

getTrailer()

public CrossReference::getTrailer (

void

): \setasign\Fpdi\PdfParser\Type\PdfDictionary

Get the trailer dictionary.

initReaderInstance()

protected CrossReference::initReaderInstance (

\setasign\Fpdi\PdfParser\Type\PdfToken|\setasign\Fpdi\PdfParser\Type\PdfIndirectObject $initValue

): ReaderInterface|bool

Get a cross-reference reader instance.

Parameters

$initValue : \setasign\Fpdi\PdfParser\Type\PdfToken|\setasign\Fpdi\PdfParser\Type\PdfIndirectObject

Exceptions

Throws CrossReferenceException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

readXref()

protected CrossReference::readXref (

int $offset

): ReaderInterface

Read the cross-reference table at a given offset.

Internally the method will try to evaluate the best reader for this cross-reference.

Parameters

$offset : int

Exceptions

Throws CrossReferenceException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException