PdfHexString Class Reference

Class representing a hexadecimal encoded PDF string object. More...

Inheritance diagram for PdfHexString:

Static Public Member Functions
static	create ($string)
	Helper method to create an instance.
static	ensure ($hexString)
	Ensures that the passed value is a PdfHexString instance.
static	parse (StreamReader $streamReader)
	Parses a hexadecimal string object from the stream reader.
static	resolve (PdfType $value, PdfParser $parser, $stopAtIndirectObject=false)
	Resolves a PdfType value to its value.

Public Attributes
mixed	$value
	The value of the PDF type.

Static Protected Member Functions
static	ensureType ($type, $value, $errorMessage)
	Ensure that a value is an instance of a specific PDF type.

Detailed Description

Class representing a hexadecimal encoded PDF string object.

Member Function Documentation

create()

static PdfHexString::create ( $string )

static

Helper method to create an instance.

Parameters

string

$string

The hex encoded string.

Return values

self

ensure()

static PdfHexString::ensure ( $hexString )

static

Ensures that the passed value is a PdfHexString instance.

Parameters

mixed

$hexString

Return values

self

Exceptions

PdfTypeException

ensureType()

static PdfType::ensureType ( $type, $value, $errorMessage )

staticprotectedinherited

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

Parameters

string	$type
PdfType	$value
string	$errorMessage

Return values

mixed

Exceptions

PdfTypeException

parse()

static PdfHexString::parse ( StreamReader $streamReader )

static

Parses a hexadecimal string object from the stream reader.

Parameters

StreamReader

$streamReader

Return values

bool|self

resolve()

static PdfType::resolve ( PdfType $value, PdfParser $parser, $stopAtIndirectObject = false )

staticinherited

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

PdfType	$value
PdfParser	$parser
bool	$stopAtIndirectObject

Return values

PdfType

Exceptions

CrossReferenceException
PdfParserException

---

The documentation for this class was generated from the following file:

• mod/assign/feedback/editpdf/fpdi/PdfParser/Type/PdfHexString.php