Class setasign\Fpdi\PdfParser\Type\PdfDictionary in FPDI v2 API Reference

Index

\setasign\Fpdi
1. PdfParser
  1. Type

setasign\Fpdi\PdfParser\Type

PdfDictionary Class representing a PDF dictionary object

File: /FPDI v2/PdfParser/Type/PdfDictionary.php

Class hierarchy

PdfType
- PdfDictionary

Summary

Static Methods

create()
ensure()
ensureType()
flatten()
get()
parse()
resolve()

Properties

$value

Properties

$value

public mixed PdfType::$value

The value of the PDF type.

Static Methods

create()

public static PdfDictionary::create (

[ PdfType[] $entries = array ( ) ]

): PdfDictionary

Helper method to create an instance.

Parameters

$entries : PdfType[]: The keys are the name entries of the dictionary.

ensure()

public static PdfDictionary::ensure (

mixed $dictionary

): PdfDictionary

Ensures that the passed value is a PdfDictionary instance.

Parameters

$dictionary : mixed

Exceptions

Throws PdfTypeException

ensureType()

protected static PdfType::ensureType (

string $type, PdfType $value, string $errorMessage

): mixed

Ensure that a value is an instance of a specific PDF type.

Parameters

$type : string
$value : PdfType
$errorMessage : string

Exceptions

Throws PdfTypeException

flatten()

public static PdfType::flatten (

PdfType $value, \setasign\Fpdi\PdfParser\PdfParser $parser

): PdfType

Flatten indirect object references to direct objects.

Parameters

$value : PdfType
$parser : \setasign\Fpdi\PdfParser\PdfParser

Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\PdfParserException

get()

public static PdfDictionary::get (

mixed $dictionary, string $key [, PdfType|null $default = null ]

): PdfNull|PdfType

Get a value by its key from a dictionary or a default value.

Parameters

$dictionary : mixed
$key : string
$default : PdfType|null

Exceptions

Throws PdfTypeException

parse()

public static PdfDictionary::parse (

\setasign\Fpdi\PdfParser\Tokenizer $tokenizer, \setasign\Fpdi\PdfParser\StreamReader $streamReader, \setasign\Fpdi\PdfParser\PdfParser $parser

): bool|PdfDictionary

Parses a dictionary of the passed tokenizer, stream-reader and parser.

Parameters

$tokenizer : \setasign\Fpdi\PdfParser\Tokenizer
$streamReader : \setasign\Fpdi\PdfParser\StreamReader
$parser : \setasign\Fpdi\PdfParser\PdfParser

Exceptions

Throws PdfTypeException

resolve()

public static PdfType::resolve (

PdfType $value, \setasign\Fpdi\PdfParser\PdfParser $parser [, bool $stopAtIndirectObject = false ]

): PdfType

Resolves a PdfType value to its value.

This method is used to evaluate indirect and direct object references until a final value is reached.

Parameters

$value : PdfType
$parser : \setasign\Fpdi\PdfParser\PdfParser
$stopAtIndirectObject : bool

Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\PdfParserException