Page
in package
Class representing a page of a PDF document
Table of Contents
Properties
- $inheritedAttributes : null|array<string|int, mixed>
- Inherited attributes
- $pageDictionary : PdfDictionary
- $pageObject : PdfIndirectObject
- $parser : PdfParser
Methods
- __construct() : mixed
- Page constructor.
- getAttribute() : PdfType|null
- Get a page attribute.
- getBoundary() : bool|Rectangle
- Get a boundary of this page.
- getContentStream() : string
- Get the raw content stream.
- getExternalLinks() : array<string|int, mixed>
- Get information of all external links on this page.
- getPageDictionary() : PdfDictionary
- Get the dictionary of this page.
- getPageObject() : PdfIndirectObject
- Get the indirect object of this page.
- getRotation() : int
- Get the rotation value.
- getWidthAndHeight() : array<string|int, mixed>|bool
- Get the width and height of this page.
Properties
$inheritedAttributes
Inherited attributes
protected
null|array<string|int, mixed>
$inheritedAttributes
$pageDictionary
protected
PdfDictionary
$pageDictionary
$pageObject
protected
PdfIndirectObject
$pageObject
$parser
protected
PdfParser
$parser
Methods
__construct()
Page constructor.
public
__construct(PdfIndirectObject $page, PdfParser $parser) : mixed
Parameters
- $page : PdfIndirectObject
- $parser : PdfParser
getAttribute()
Get a page attribute.
public
getAttribute(string $name[, bool $inherited = true ]) : PdfType|null
Parameters
- $name : string
- $inherited : bool = true
Tags
Return values
PdfType|nullgetBoundary()
Get a boundary of this page.
public
getBoundary([string $box = PageBoundaries::CROP_BOX ][, bool $fallback = true ]) : bool|Rectangle
Parameters
- $box : string = PageBoundaries::CROP_BOX
- $fallback : bool = true
Tags
Return values
bool|RectanglegetContentStream()
Get the raw content stream.
public
getContentStream() : string
Tags
Return values
stringgetExternalLinks()
Get information of all external links on this page.
public
getExternalLinks([mixed $box = PageBoundaries::CROP_BOX ]) : array<string|int, mixed>
All coordinates are normalized in view to rotation and translation of the boundary-box, so that their origin is lower-left.
The URI is the binary value of the PDF string object. It can be in PdfDocEncoding or in UTF-16BE encoding.
Parameters
- $box : mixed = PageBoundaries::CROP_BOX
Return values
array<string|int, mixed>getPageDictionary()
Get the dictionary of this page.
public
getPageDictionary() : PdfDictionary
Tags
Return values
PdfDictionarygetPageObject()
Get the indirect object of this page.
public
getPageObject() : PdfIndirectObject
Return values
PdfIndirectObjectgetRotation()
Get the rotation value.
public
getRotation() : int
Tags
Return values
intgetWidthAndHeight()
Get the width and height of this page.
public
getWidthAndHeight([string $box = PageBoundaries::CROP_BOX ][, bool $fallback = true ]) : array<string|int, mixed>|bool
Parameters
- $box : string = PageBoundaries::CROP_BOX
- $fallback : bool = true