Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
PdfDictionary Class Reference

Class representing a PDF dictionary object. More...

Inheritance diagram for PdfDictionary:

Static Public Member Functions

static create (array $entries=[])
 Helper method to create an instance.
 
static ensure ($dictionary)
 Ensures that the passed value is a PdfDictionary instance.
 
static get ($dictionary, $key, PdfType $default=null)
 Get a value by its key from a dictionary or a default value.
 
static parse (Tokenizer $tokenizer, StreamReader $streamReader, PdfParser $parser)
 Parses a dictionary of the passed tokenizer, stream-reader and parser.
 

Detailed Description

Class representing a PDF dictionary object.

Member Function Documentation

◆ create()

static PdfDictionary::create ( array $entries = [])
static

Helper method to create an instance.

Parameters
PdfType[]$entriesThe keys are the name entries of the dictionary.
Return values
self

◆ ensure()

static PdfDictionary::ensure ( $dictionary)
static

Ensures that the passed value is a PdfDictionary instance.

Parameters
mixed$dictionary
Return values
self
Exceptions
PdfTypeException

◆ get()

static PdfDictionary::get ( $dictionary,
$key,
PdfType $default = null )
static

Get a value by its key from a dictionary or a default value.

Parameters
mixed$dictionary
string$key
PdfType | null$default
Return values
PdfNull|PdfType
Exceptions
PdfTypeException

◆ parse()

static PdfDictionary::parse ( Tokenizer $tokenizer,
StreamReader $streamReader,
PdfParser $parser )
static

Parses a dictionary of the passed tokenizer, stream-reader and parser.

Parameters
Tokenizer$tokenizer
StreamReader$streamReader
PdfParser$parser
Return values
bool|self
Exceptions
PdfTypeException

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