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

Class representing a boolean PDF object. More...

Inheritance diagram for PdfBoolean:
PdfType

Static Public Member Functions

static create ($value)
 Helper method to create an instance.
 
static ensure ($value)
 Ensures that the passed value is a PdfBoolean instance.
 
static flatten (PdfType $value, PdfParser $parser)
 Flatten indirect object references to direct objects.
 
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 boolean PDF object.

Member Function Documentation

◆ create()

static PdfBoolean::create ( $value)
static

Helper method to create an instance.

Parameters
bool$value
Return values
self

◆ ensure()

static PdfBoolean::ensure ( $value)
static

Ensures that the passed value is a PdfBoolean instance.

Parameters
mixed$value
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

◆ flatten()

static PdfType::flatten ( PdfType $value,
PdfParser $parser )
staticinherited

Flatten indirect object references to direct objects.

Parameters
PdfType$value
PdfParser$parser
Return values
PdfType
Exceptions
CrossReferenceException
PdfParserException

◆ 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: