setasign\Fpdi\PdfParser\Type

PdfName Class representing a PDF name object

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

Class hierarchy

Summary

Properties

$value

public mixed setasign\Fpdi\PdfParser\Type\PdfName::$value

The value of the PDF type.


Static Methods

create()

public static PdfName::create (
string $string
): PdfName

Helper method to create an instance.

Parameters
$string : string
 

ensure()

public static PdfName::ensure (
mixed $name
): PdfName

Ensures that the passed value is a PdfName instance.

Parameters
$name : mixed
 

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

parse()

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