Class Pdf in namespace setasign\SetaPDF2\Core\Parser in SetaPDF v2 API Reference

This is needed to create a relation between a parsed object and its owning element. The complete chain will be able to get a relation to the owning document. Needed for example for handling en- and decryption of strings or streams.

$_reader

protected \SetaPDF_Core_Reader_ReaderInterface Pdf::$_reader

The reader class

$_tokenizer

protected \SetaPDF_Core_Tokenizer Pdf::$_tokenizer

The tokenizer

Methods

__construct()

public Pdf::__construct (

\SetaPDF_Core_Reader_ReaderInterface $reader

)

The constructor.

Parameters

$reader : \SetaPDF_Core_Reader_ReaderInterface

_ensureExpectedValue()

private Pdf::_ensureExpectedValue (

string $token,
?string $expectedType

): true

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

Parameters

$token : string
$expectedType : ?string

Exceptions

Throws Pdf\InvalidTokenException

_getNextToken()

protected Pdf::_getNextToken (

void

): string|false

Get the next token.

_readValue()

private Pdf::_readValue (

?string $token,
?string $expectedType = null

): \SetaPDF_Core_Type_AbstractType|false

Read a value based on a token.

Parameters

$token : ?string
$expectedType : ?string

Exceptions

Throws Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Exception

Throws \UnexpectedValueException

cleanUp()

public Pdf::cleanUp (

void

): void

Released memory and resources.

getOwner()

public Pdf::getOwner (

void

): ?\SetaPDF_Core_Document

Get the owner pdf document.

getPdfVersion()

public Pdf::getPdfVersion (

void

): string

Get the PDF version.

Exceptions

Throws Exception

getReader()

public Pdf::getReader (

void

): \SetaPDF_Core_Reader_ReaderInterface

Get the reader object.

Exceptions

Throws Exception

getTokenizer()

public Pdf::getTokenizer (

void

): \SetaPDF_Core_Tokenizer

Get the tokenizer object.

readValue()

public Pdf::readValue (

?string $expectedType = null

): \SetaPDF_Core_Type_AbstractType|false

Read a value.

Parameters

$expectedType : ?string

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws Pdf\InvalidTokenException

reset()

public Pdf::reset (

int $pos = 0

): void

Reset the reader to a specific position.

Parameters

$pos : int

setOwner()

public Pdf::setOwner (

\SetaPDF_Core_Type_Owner $owner

): void

Set the owner pdf document.

Parameters

$owner : \SetaPDF_Core_Type_Owner

setPassOwningObjectToChilds()

public Pdf::setPassOwningObjectToChilds (

bool $passOwningObjectToChilds = true

): void

Define if the owning object should be passed to it's childs.

Parameters

$passOwningObjectToChilds : bool

See

$_passOwningObjectToChilds

setReader()

public Pdf::setReader (

\SetaPDF_Core_Reader_ReaderInterface $reader

): void

Set the reader object.

Parameters

$reader : \SetaPDF_Core_Reader_ReaderInterface

skipUntilToken()

public Pdf::skipUntilToken (

string $token,
bool $inToken = false

): bool

Skips tokens until a special token is found.

This method can be used to e.g. jump over binary inline image data.

Parameters

$token : string
$inToken : bool: Defines if the token should match exactly or if a strpos should be used to find the token.