Index

  1. \setasign\Fpdi
    1. PdfParser
      1. CrossReference
      2. Filter
      3. Type
      4. PdfParser
      5. PdfParserException
      6. StreamReader
      7. Tokenizer

setasign\Fpdi\PdfParser

PdfParser A PDF parser class

File: /FPDI v2/PdfParser/PdfParser.php

Class hierarchy

Summary

Methods

Properties

Properties

$fileHeader

protected string PdfParser::$fileHeader

The file header.

$fileHeaderOffset

protected int PdfParser::$fileHeaderOffset

The offset to the file header.

$objects

protected array PdfParser::$objects = array()

All read objects.

$streamReader

protected StreamReader PdfParser::$streamReader

$tokenizer

protected Tokenizer PdfParser::$tokenizer

$xref

protected CrossReference\CrossReference|null PdfParser::$xref

Methods

__construct()

public PdfParser::__construct (
StreamReader $streamReader
)

PdfParser constructor.

Parameters
$streamReader : StreamReader
 

ensureExpectedType()

protected PdfParser::ensureExpectedType (
string $token, string|null $expectedType
): bool

Ensures that the token will evaluate to an expected object type (or not).

Parameters
$token : string
 
$expectedType : string|null
 
Exceptions

Throws Type\PdfTypeException

getCatalog()

public PdfParser::getCatalog (
void
): Type\PdfDictionary

Get the catalog dictionary.

Exceptions

Throws Type\PdfTypeException

Throws CrossReference\CrossReferenceException

Throws PdfParserException

getCrossReference()

public PdfParser::getCrossReference (
void
): CrossReference\CrossReference

Get the cross-reference instance.

Exceptions

Throws CrossReference\CrossReferenceException

Throws PdfParserException

getIndirectObject()

public PdfParser::getIndirectObject (
int $objectNumber [, bool $cache = false ]
): Type\PdfIndirectObject

Get an indirect object by its object number.

Parameters
$objectNumber : int
 
$cache : bool
 
Exceptions

Throws CrossReference\CrossReferenceException

Throws PdfParserException

getPdfVersion()

public PdfParser::getPdfVersion (
void
): int[]

Get the PDF version.

Return Values

An array of major and minor version.

Exceptions

Throws PdfParserException

getStreamReader()

public PdfParser::getStreamReader (
void
): StreamReader

Get the stream reader instance.

getTokenizer()

public PdfParser::getTokenizer (
void
): Tokenizer

Get the tokenizer instance.

parsePdfArray()

protected PdfParser::parsePdfArray (
void
): false|Type\PdfArray
Exceptions

Throws Type\PdfTypeException

parsePdfDictionary()

protected PdfParser::parsePdfDictionary (
void
): bool|Type\PdfDictionary
Exceptions

Throws Type\PdfTypeException

parsePdfHexString()

protected PdfParser::parsePdfHexString (
void
): false|Type\PdfHexString

parsePdfIndirectObject()

protected PdfParser::parsePdfIndirectObject (
int $objectNumber, int $generationNumber
): false|Type\PdfIndirectObject
Parameters
$objectNumber : int
 
$generationNumber : int
 
Exceptions

Throws Type\PdfTypeException

parsePdfName()

protected PdfParser::parsePdfName (
void
): Type\PdfName

parsePdfString()

protected PdfParser::parsePdfString (
void
): Type\PdfString

readValue()

public PdfParser::readValue (
[ null|bool|string $token = null [, null|string $expectedType = null ]]
): false|Type\PdfArray|Type\PdfBoolean|Type\PdfDictionary|Type\PdfHexString|Type\PdfIndirectObject|Type\PdfIndirectObjectReference|Type\PdfName|Type\PdfNull|Type\PdfNumeric|Type\PdfStream|Type\PdfString|Type\PdfToken

Read a PDF value.

Parameters
$token : null|bool|string
 
$expectedType : null|string
 
Exceptions

Throws Type\PdfTypeException

resolveFileHeader()

protected PdfParser::resolveFileHeader (
void
): int

Resolves the file header.

Exceptions

Throws PdfParserException


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