PdfParser
in package
A PDF parser class
Table of Contents
Properties
- $fileHeader : string
- The file header.
- $fileHeaderOffset : int
- The offset to the file header.
- $objects : array<string|int, mixed>
- All read objects.
- $streamReader : StreamReader
- $tokenizer : Tokenizer
- $xref : CrossReference|null
Methods
- __construct() : mixed
- PdfParser constructor.
- getCatalog() : PdfDictionary
- Get the catalog dictionary.
- getCrossReference() : CrossReference
- Get the cross-reference instance.
- getIndirectObject() : PdfIndirectObject
- Get an indirect object by its object number.
- getPdfVersion() : array<string|int, int>
- Get the PDF version.
- getStreamReader() : StreamReader
- Get the stream reader instance.
- getTokenizer() : Tokenizer
- Get the tokenizer instance.
- readValue() : false|PdfArray|PdfBoolean|PdfDictionary|PdfHexString|PdfIndirectObject|PdfIndirectObjectReference|PdfName|PdfNull|PdfNumeric|PdfStream|PdfString|PdfToken
- Read a PDF value.
- ensureExpectedType() : bool
- Ensures that the token will evaluate to an expected object type (or not).
- parsePdfArray() : false|PdfArray
- parsePdfDictionary() : bool|PdfDictionary
- parsePdfHexString() : false|PdfHexString
- parsePdfIndirectObject() : false|PdfIndirectObject
- parsePdfName() : PdfName
- parsePdfString() : PdfString
- resolveFileHeader() : int
- Resolves the file header.
Properties
$fileHeader
The file header.
protected
string
$fileHeader
$fileHeaderOffset
The offset to the file header.
protected
int
$fileHeaderOffset
$objects
All read objects.
protected
array<string|int, mixed>
$objects
= []
$streamReader
protected
StreamReader
$streamReader
$tokenizer
protected
Tokenizer
$tokenizer
$xref
protected
CrossReference|null
$xref
Methods
__construct()
PdfParser constructor.
public
__construct(StreamReader $streamReader) : mixed
Parameters
- $streamReader : StreamReader
getCatalog()
Get the catalog dictionary.
public
getCatalog() : PdfDictionary
Tags
Return values
PdfDictionarygetCrossReference()
Get the cross-reference instance.
public
getCrossReference() : CrossReference
Tags
Return values
CrossReferencegetIndirectObject()
Get an indirect object by its object number.
public
getIndirectObject(int $objectNumber[, bool $cache = false ]) : PdfIndirectObject
Parameters
- $objectNumber : int
- $cache : bool = false
Tags
Return values
PdfIndirectObjectgetPdfVersion()
Get the PDF version.
public
getPdfVersion() : array<string|int, int>
Tags
Return values
array<string|int, int> —An array of major and minor version.
getStreamReader()
Get the stream reader instance.
public
getStreamReader() : StreamReader
Return values
StreamReadergetTokenizer()
Get the tokenizer instance.
public
getTokenizer() : Tokenizer
Return values
TokenizerreadValue()
Read a PDF value.
public
readValue([null|bool|string $token = null ][, null|string $expectedType = null ]) : false|PdfArray|PdfBoolean|PdfDictionary|PdfHexString|PdfIndirectObject|PdfIndirectObjectReference|PdfName|PdfNull|PdfNumeric|PdfStream|PdfString|PdfToken
Parameters
- $token : null|bool|string = null
- $expectedType : null|string = null
Tags
Return values
false|PdfArray|PdfBoolean|PdfDictionary|PdfHexString|PdfIndirectObject|PdfIndirectObjectReference|PdfName|PdfNull|PdfNumeric|PdfStream|PdfString|PdfTokenensureExpectedType()
Ensures that the token will evaluate to an expected object type (or not).
protected
ensureExpectedType(string $token, string|null $expectedType) : bool
Parameters
- $token : string
- $expectedType : string|null
Tags
Return values
boolparsePdfArray()
protected
parsePdfArray() : false|PdfArray
Tags
Return values
false|PdfArrayparsePdfDictionary()
protected
parsePdfDictionary() : bool|PdfDictionary
Tags
Return values
bool|PdfDictionaryparsePdfHexString()
protected
parsePdfHexString() : false|PdfHexString
Return values
false|PdfHexStringparsePdfIndirectObject()
protected
parsePdfIndirectObject(int $objectNumber, int $generationNumber) : false|PdfIndirectObject
Parameters
- $objectNumber : int
- $generationNumber : int
Tags
Return values
false|PdfIndirectObjectparsePdfName()
protected
parsePdfName() : PdfName
Return values
PdfNameparsePdfString()
protected
parsePdfString() : PdfString
Return values
PdfStringresolveFileHeader()
Resolves the file header.
protected
resolveFileHeader() : int