PageBoundaries
in package
An abstract class for page boundary constants and some helper methods
Table of Contents
Constants
- ART_BOX = 'ArtBox'
- ArtBox
- BLEED_BOX = 'BleedBox'
- BleedBox
- CROP_BOX = 'CropBox'
- CropBox
- MEDIA_BOX = 'MediaBox'
- MediaBox
- TRIM_BOX = 'TrimBox'
- TrimBox
Properties
- $all : array<string|int, mixed>
- All page boundaries
Methods
- isValidName() : bool
- Checks if a name is a valid page boundary name.
Constants
ART_BOX
ArtBox
public
string
ART_BOX
= 'ArtBox'
The art box defines the extent of the page’s meaningful content (including potential white space) as intended by the page’s creator.
Tags
BLEED_BOX
BleedBox
public
string
BLEED_BOX
= 'BleedBox'
The bleed box defines the region to which the contents of the page shall be clipped when output in a production environment.
Tags
CROP_BOX
CropBox
public
string
CROP_BOX
= 'CropBox'
The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.
Tags
MEDIA_BOX
MediaBox
public
string
MEDIA_BOX
= 'MediaBox'
The media box defines the boundaries of the physical medium on which the page is to be printed.
Tags
TRIM_BOX
TrimBox
public
string
TRIM_BOX
= 'TrimBox'
The trim box defines the intended dimensions of the finished page after trimming.
Tags
Properties
$all
All page boundaries
public
static array<string|int, mixed>
$all
= array(self::MEDIA_BOX, self::CROP_BOX, self::BLEED_BOX, self::TRIM_BOX, self::ART_BOX)
Methods
isValidName()
Checks if a name is a valid page boundary name.
public
static isValidName(string $name) : bool
Parameters
- $name : string
-
The boundary name
Return values
bool —A boolean value whether the name is valid or not.