PdfString Class Reference

Class representing a PDF string object. More...

Inheritance diagram for PdfString:

Static Public Member Functions
static	create ($value)
	Helper method to create an instance.
static	ensure ($string)
	Ensures that the passed value is a PdfString instance.
static	escape ($s)
	Escapes sequences in a string according to the PDF specification.
static	parse (StreamReader $streamReader)
	Parses a string object from the stream reader.
static	unescape ($s)
	Unescapes escaped sequences in a PDF string according to the PDF specification.

Detailed Description

Class representing a PDF string object.

Member Function Documentation

create()

static PdfString::create ( $value )

static

Helper method to create an instance.

Parameters

string

$value

The string needs to be escaped accordingly.

Return values

self

ensure()

static PdfString::ensure ( $string )

static

Ensures that the passed value is a PdfString instance.

Parameters

mixed

$string

Return values

self

Exceptions

PdfTypeException

escape()

static PdfString::escape ( $s )

static

Escapes sequences in a string according to the PDF specification.

Parameters

string

$s

Return values

string

parse()

static PdfString::parse ( StreamReader $streamReader )

static

Parses a string object from the stream reader.

Parameters

StreamReader

$streamReader

Return values

self

unescape()

static PdfString::unescape ( $s )

static

Unescapes escaped sequences in a PDF string according to the PDF specification.

Parameters

string

$s

Return values

string

---

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

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