Table of contents
Namespace: Com\Tecnick\Pdf\Page
abstract class Settings extends Box
Extends: Box
Source: src/Settings.php:47
Constants
EPS
Epsilon precision used to compare floating point values.
public const EPS = 0.0001
Source: src/Settings.php:52
MAX_COLUMNS
Maximum number of equal vertical columns a page can be split into.
public const MAX_COLUMNS = 1000
Source: src/Settings.php:57
PAGE_NUM
Alias for page number.
public const PAGE_NUM = '~#PN'
Source: src/Settings.php:71
PAGE_TOT
Alias for total number of pages in a group.
public const PAGE_TOT = '~#PT'
Source: src/Settings.php:64
Methods
getPageID()
Return the current page ID.
public getPageID(): int
Returns: int: Page ID.
Source: src/Settings.php:171
sanitizeAnnotRefs()
Sanitize or set the annotation references.
public sanitizeAnnotRefs(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:236
sanitizeBoxData()
Sanitize or set the page boxes containing the page boundaries.
Every entry of PageInputData[‘box’] is optional and is completed first.
public sanitizeBoxData(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Throws:
Source: src/Settings.php:711
sanitizeContent()
Sanitize or set the page content.
public sanitizeContent(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:216
sanitizeGroup()
Sanitize or set the page group.
public sanitizeGroup(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:206
sanitizeMargins()
Sanitize or set the page margins.
public sanitizeMargins(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Throws:
Source: src/Settings.php:405
sanitizePageFormat()
Sanitize or set the page format.
The pseudo-format ‘MediaBox’ means that the page size is taken from the MediaBox: it is left untouched here and resolved by sanitizeBoxData(), which then re-enters this method with the box-derived dimensions and a cleared format.
public sanitizePageFormat(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Throws:
Source: src/Settings.php:845
sanitizePageNumber()
Sanitize or set the page number.
public sanitizePageNumber(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:181
sanitizeRegions()
Sanitize or set the page regions (columns).
public sanitizeRegions(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:592
sanitizeRotation()
Sanitize or set the page rotation.
The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90; it is normalized to the [0, 360) range.
public sanitizeRotation(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:250
sanitizeTime()
Sanitize or set the page modification time.
A missing time is set to the default page time, or to the current time when no default is set. Negative values are set to 0.
public sanitizeTime(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:196
sanitizeTransitions()
Sanitize or set the page transitions.
public sanitizeTransitions(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:283
sanitizeZoom()
Sanitize or set the page preferred zoom (magnification) factor.
The factor is a magnification, so any non-positive value falls back to 1.0.
public sanitizeZoom(PageInputData &$data): void
Parameters:
$data(PageInputData): Page data.
Source: src/Settings.php:269
Inherited members
From Box
- BOX: Page box names.
- setBox(): Set page boundaries.
- setPageBoxes(): Initialize page boxes.
- swapCoordinates(): Swap X and Y coordinates of page boxes (change page boxes orientation).
From Format
- FORMAT: Array of page formats (width, height).
- UNITRATIO: Array of conversion ratios relative to points.
- convertPoints(): Convert Points to another unit.
- getPageFormatSize(): Get page dimensions.
- getPageOrientation(): Returns the page orientation.
- getPageOrientedSize(): Returns the page dimensions oriented as specified.
- getUnitRatio(): Get the unit ratio for the specified unit of measure.
From Mode
- getDisplay(): Get the canonical page display mode.
- getLayout(): Get the canonical page layout name.