Abstract Class setasign\Fpdi\PdfReader\PageBoundaries in FPDI v2 API Reference

Index

\setasign\Fpdi
1. PdfReader

setasign\Fpdi\PdfReader

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

File: /FPDI v2/PdfReader/PageBoundaries.php

Class hierarchy

PageBoundaries

Summary

Constants

ART_BOX

public const string 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

PDF 32000-1:2008 - 14.11.2 Page Boundaries

BLEED_BOX

public const string 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

PDF 32000-1:2008 - 14.11.2 Page Boundaries

CROP_BOX

public const string 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

PDF 32000-1:2008 - 14.11.2 Page Boundaries

MEDIA_BOX

public const string PageBoundaries::MEDIA_BOX = 'MediaBox'

MediaBox

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

See

PDF 32000-1:2008 - 14.11.2 Page Boundaries

TRIM_BOX

public const string PageBoundaries::TRIM_BOX = 'TrimBox'

TrimBox

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

See

PDF 32000-1:2008 - 14.11.2 Page Boundaries

Static Properties

$all

static public array PageBoundaries::$all = array(...)

All page boundaries

Static Methods

isValidName()

public static PageBoundaries::isValidName (

string $name

): boolean

Checks if a name is a valid page boundary name.

Parameters

$name : string: The boundary name

Return Values

A boolean value whether the name is valid or not.