Index

  1. \setasign\Fpdi
    1. PdfReader
      1. DataStructure
      2. Page
      3. PageBoundaries
      4. PdfReader
      5. PdfReaderException

setasign\Fpdi\PdfReader

Page Class representing a page of a PDF document

File: /FPDI v2/PdfReader/Page.php

Class hierarchy

Summary

Methods

Properties

Properties

$inheritedAttributes

protected null|array Page::$inheritedAttributes

Inherited attributes

$pageDictionary

protected \setasign\Fpdi\PdfParser\Type\PdfDictionary Page::$pageDictionary

$pageObject

protected \setasign\Fpdi\PdfParser\Type\PdfIndirectObject Page::$pageObject

$parser

protected \setasign\Fpdi\PdfParser\PdfParser Page::$parser

Methods

__construct()

public Page::__construct ()

Page constructor.

Parameters
$page : \setasign\Fpdi\PdfParser\Type\PdfIndirectObject
 
$parser : \setasign\Fpdi\PdfParser\PdfParser
 

getAttribute()

public Page::getAttribute (
string $name [, bool $inherited = true ]
): \setasign\Fpdi\PdfParser\Type\PdfType|null

Get a page attribute.

Parameters
$name : string
 
$inherited : bool
 
Exceptions

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

getBoundary()

public Page::getBoundary (
[ string $box = PageBoundaries::CROP_BOX [, bool $fallback = true ]]
): bool|DataStructure\Rectangle

Get a boundary of this page.

Parameters
$box : string
 
$fallback : bool
 
Exceptions

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

See
  • PageBoundaries

getContentStream()

public Page::getContentStream (
void
): string

Get the raw content stream.

Exceptions

Throws PdfReaderException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfParser\Filter\FilterException

Throws \setasign\Fpdi\PdfParser\PdfParserException

getExternalLinks()

public Page::getExternalLinks (): array

Get information of all external links on this page.

All coordinates are normalized in view to rotation and translation of the boundary-box, so that their origin is lower-left.

Parameters
$box
 

getPageDictionary()

public Page::getPageDictionary (
void
): \setasign\Fpdi\PdfParser\Type\PdfDictionary

Get the dictionary of this page.

Exceptions

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

getPageObject()

public Page::getPageObject (
void
): \setasign\Fpdi\PdfParser\Type\PdfIndirectObject

Get the indirect object of this page.

getRotation()

public Page::getRotation (
void
): int

Get the rotation value.

Exceptions

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

getWidthAndHeight()

public Page::getWidthAndHeight (
[ string $box = PageBoundaries::CROP_BOX [, bool $fallback = true ]]
): array|bool

Get the width and height of this page.

Parameters
$box : string
 
$fallback : bool
 
Exceptions

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)