Class PdfName in namespace setasign\Fpdi\PdfParser\Type in FPDI v2 API Reference

Index

\setasign\Fpdi
1. PdfParser
  1. Type

setasign\Fpdi\PdfParser\Type

PdfName Class representing a PDF name object

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

Class hierarchy

PdfType
- PdfName

Summary

Static Methods

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

Properties

$value

Properties

$value

public mixed PdfType::$value

The value of the PDF type.

Static Methods

create()

public static PdfName::create (

string $string

): self

Helper method to create an instance.

Parameters

$string: string

ensure()

public static PdfName::ensure (

mixed $name

): self

Ensures that the passed value is a PdfName instance.

Parameters

$name: 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

parse()

public static PdfName::parse (

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

): self

Parses a name object from the passed tokenizer and stream-reader.

Parameters

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

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

unescape()

public static PdfName::unescape (

string $value

): string

Unescapes a name string.

Parameters

$value: string