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

An abstract class for page boundary constants and some helper methods. More...

Static Public Member Functions

static isValidName ($name)
 Checks if a name is a valid page boundary name.
 

Public Attributes

string const ART_BOX = 'ArtBox'
 ArtBox.
 
string const BLEED_BOX = 'BleedBox'
 BleedBox.
 
string const CROP_BOX = 'CropBox'
 CropBox.
 
string const MEDIA_BOX = 'MediaBox'
 MediaBox.
 
string const TRIM_BOX = 'TrimBox'
 TrimBox.
 

Static Public Attributes

static array $all
 All page boundaries.
 

Detailed Description

An abstract class for page boundary constants and some helper methods.

Member Function Documentation

◆ isValidName()

static PageBoundaries::isValidName ( $name)
static

Checks if a name is a valid page boundary name.

Parameters
string$nameThe boundary name
Return values
booleanA boolean value whether the name is valid or not.

Member Data Documentation

◆ $all

array PageBoundaries::$all
static
Initial value:
= array(
self::MEDIA_BOX,
self::CROP_BOX,
self::BLEED_BOX,
self::TRIM_BOX,
self::ART_BOX
)

All page boundaries.

◆ ART_BOX

string const PageBoundaries::ART_BOX = 'ArtBox'

ArtBox.

The art box defines the extent of the page’s meaningful content (including potential white space) as intended by the page’s creator.

See also
PDF 32000-1:2008 - 14.11.2 Page Boundaries

◆ BLEED_BOX

string const PageBoundaries::BLEED_BOX = 'BleedBox'

BleedBox.

The bleed box defines the region to which the contents of the page shall be clipped when output in a production environment.

See also
PDF 32000-1:2008 - 14.11.2 Page Boundaries

◆ CROP_BOX

string const PageBoundaries::CROP_BOX = 'CropBox'

CropBox.

The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.

See also
PDF 32000-1:2008 - 14.11.2 Page Boundaries

◆ MEDIA_BOX

string const PageBoundaries::MEDIA_BOX = 'MediaBox'

MediaBox.

The media box defines the boundaries of the physical medium on which the page is to be printed.

See also
PDF 32000-1:2008 - 14.11.2 Page Boundaries

◆ TRIM_BOX

string const PageBoundaries::TRIM_BOX = 'TrimBox'

TrimBox.

The trim box defines the intended dimensions of the finished page after trimming.

See also
PDF 32000-1:2008 - 14.11.2 Page Boundaries

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