Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
PdfName Class Reference

Class representing a PDF name object. More...

Inheritance diagram for PdfName:

Static Public Member Functions

static create ($string)
 Helper method to create an instance.
 
static ensure ($name)
 Ensures that the passed value is a PdfName instance.
 
static parse (Tokenizer $tokenizer, StreamReader $streamReader)
 Parses a name object from the passed tokenizer and stream-reader.
 
static unescape ($value)
 Unescapes a name string.
 

Detailed Description

Class representing a PDF name object.

Member Function Documentation

◆ create()

static PdfName::create ( $string)
static

Helper method to create an instance.

Parameters
string$string
Return values
self

◆ ensure()

static PdfName::ensure ( $name)
static

Ensures that the passed value is a PdfName instance.

Parameters
mixed$name
Return values
self
Exceptions
PdfTypeException

◆ parse()

static PdfName::parse ( Tokenizer $tokenizer,
StreamReader $streamReader )
static

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

Parameters
Tokenizer$tokenizer
StreamReader$streamReader
Return values
self

◆ unescape()

static PdfName::unescape ( $value)
static

Unescapes a name string.

Parameters
string$value
Return values
string

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