SetaPDF v2 API Reference

SetaPDF_Core_Document_Catalog_Pages Class for handling PDF pages

File: /SetaPDF v2/Core/Document/Catalog/Pages.php

Class hierarchy

SetaPDF_Core_Document_Catalog_Pages

Implements

Countable

Summary

Methods

__construct()
_ensureAllPageObjects()
_ensureIndirectObjectAndDictionaryAndType()
_ensurePageObject()
_ensurePagesArray()
_readPage()
_readPageBackwards()
append()
cleanUp()
count()
create()
deletePage()
ensureAllPageObjects()
extract()
getDocument()
getLastPage()
getPage()
getPageByAnnotation()
getPageByIndirectObject()
getPageNumberByIndirectObject()
getPageNumberByPageObject()
getPagesIndirectObject()
prepend()
resolvePagesRootObject()

Properties

$_annotationCache
$_catalog
$_currentPagesObject
$_pageCount
$_pageObjects
$_pageObjectsToPageNumbers
$_pages
$_pagesRootObject

Properties

$_annotationCache

protected array SetaPDF_Core_Document_Catalog_Pages::$_annotationCache = array()

Caches annotation object identifiers to page numbers

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_Pages::$_catalog

The catalog instance

$_currentPagesObject

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Catalog_Pages::$_currentPagesObject

The current pages object while walking through the page tree

$_pageCount

protected integer SetaPDF_Core_Document_Catalog_Pages::$_pageCount = 0

The page count

$_pageObjects

protected array SetaPDF_Core_Document_Catalog_Pages::$_pageObjects = array()

An array holding the native indirect objects of pages

$_pageObjectsToPageNumbers

protected array SetaPDF_Core_Document_Catalog_Pages::$_pageObjectsToPageNumbers = array()

A helper array matching objects to page numbers

$_pages

protected SetaPDF_Core_Document_Page[] SetaPDF_Core_Document_Catalog_Pages::$_pages = array()

An array holding page instances

$_pagesRootObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_Document_Catalog_Pages::$_pagesRootObject

The pages root object

Methods

__construct()

public SetaPDF_Core_Document_Catalog_Pages::__construct (

SetaPDF_Core_Document_Catalog $catalog

)

The constructor.

Parameters

$catalog : SetaPDF_Core_Document_Catalog

_ensureAllPageObjects()

protected SetaPDF_Core_Document_Catalog_Pages::_ensureAllPageObjects (

SetaPDF_Core_Type_IndirectObjectInterface $node

): void

Method to extract page objects recursively.

Parameters

$node : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws SetaPDF_Core_Type_Exception

_ensureIndirectObjectAndDictionaryAndType()

private SetaPDF_Core_Document_Catalog_Pages::_ensureIndirectObjectAndDictionaryAndType (

SetaPDF_Core_Type_Array $kids, integer $offset

): SetaPDF_Core_Type_IndirectObject

This method checks an entry in a Kids array for valid values and repairs it (if possible).

Parameters

$kids : SetaPDF_Core_Type_Array
$offset : integer

Exceptions

Throws SetaPDF_Core_Exception

_ensurePageObject()

protected SetaPDF_Core_Document_Catalog_Pages::_ensurePageObject (

integer $pageNumber

): SetaPDF_Core_Type_IndirectObject

Ensures that a page object is read and available in the $_pageObjects property.

Parameters

$pageNumber : integer

Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

_ensurePagesArray()

private SetaPDF_Core_Document_Catalog_Pages::_ensurePagesArray (

SetaPDF_Core_Document_Page|SetaPDF_Core_Document_Catalog_Pages|array $pages

): SetaPDF_Core_Document_Page[]

Ensures that the parameter ends in an array of SetaPDF_Core_Document_Page instances.

Parameters

$pages : SetaPDF_Core_Document_Page|SetaPDF_Core_Document_Catalog_Pages|array

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_readPage()

protected SetaPDF_Core_Document_Catalog_Pages::_readPage (

integer $pageNumber

): void

Resolves a page object by walking forwards through the page tree.

This method is optimized, to take the fastest way through the page tree, beginning at the pages root node. The page tree will be walked forward.

Parameters

$pageNumber : integer: The original page number - 1

Exceptions

Throws SetaPDF_Core_Exception

_readPageBackwards()

protected SetaPDF_Core_Document_Catalog_Pages::_readPageBackwards (

integer $pageNumber

): void

Resolves a page object by walking backwards through the page tree.

This method is optimized to take the fastest way through the page tree, beginning at the pages root node. The page tree will be walked forward.

Parameters

$pageNumber : integer

Exceptions

Throws SetaPDF_Core_Exception

append()

public SetaPDF_Core_Document_Catalog_Pages::append (

SetaPDF_Core_Document_Page|SetaPDF_Core_Document_Catalog_Pages|array $pages

): void

Append pages to the existing pages.

Parameters

$pages : SetaPDF_Core_Document_Page|SetaPDF_Core_Document_Catalog_Pages|array

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_Pages::cleanUp (

void

): void

Release memory / cycled references.

count()

public SetaPDF_Core_Document_Catalog_Pages::count (

void

): int

Returns the page count of the document.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

See

Countable::count()

create()

public SetaPDF_Core_Document_Catalog_Pages::create (

string|array $format [, string $orientation = SetaPDF_Core_PageFormats ::ORIENTATION_PORTRAIT [, boolean $append = true ]]

): SetaPDF_Core_Document_Page

Create a page.

Parameters

$format : string|array: The page format. See constants in SetaPDF_Core_PageFormats and the getFormat() method.
$orientation : string: The orientation. See constants in SetaPDF_Core_PageFormats.
$append : boolean: Whether the page should be appended to the page tree or not.

Exceptions

Throws SetaPDF_Core_Exception

deletePage()

public SetaPDF_Core_Document_Catalog_Pages::deletePage (

integer $pageNumber

): void

Deletes a page.

Parameters

$pageNumber : integer

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

ensureAllPageObjects()

public SetaPDF_Core_Document_Catalog_Pages::ensureAllPageObjects (

void

): void

This method makes sure that all pages are read.

It walks the complete page tree to cache/get all page objects in one iteration. This method should be used if all pages of a document should be handled. It is much faster than using the random access.

Exceptions

Throws BadMethodCallException

Throws SetaPDF_Core_Exception

extract()

public SetaPDF_Core_Document_Catalog_Pages::extract (

integer $pageNumber, SetaPDF_Core_Document $document [, boolean $returnPageInstance = true ]

): SetaPDF_Core_Document_Page|SetaPDF_Core_Type_IndirectObject

Extracts a page and prepares it for the usage in another document.

This method is needed if a page should be extracted independently. For example the original document should be modified after extraction and the page itself will be edited in the new document (inherited attributes get flattened).

Parameters

$pageNumber : integer
$document : SetaPDF_Core_Document
$returnPageInstance : boolean

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_Pages::getDocument (

void

): SetaPDF_Core_Document

Get the document instance.

getLastPage()

public SetaPDF_Core_Document_Catalog_Pages::getLastPage (

void

): SetaPDF_Core_Document_Page

Get the last page.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

getPage()

public SetaPDF_Core_Document_Catalog_Pages::getPage (

integer $pageNumber

): SetaPDF_Core_Document_Page

Get a page.

Parameters

$pageNumber : integer

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

getPageByAnnotation()

public SetaPDF_Core_Document_Catalog_Pages::getPageByAnnotation (

SetaPDF_Core_Document_Page_Annotation|SetaPDF_Core_Type_IndirectObjectInterface $annotationOrIndirectObject

): boolean|SetaPDF_Core_Document_Page

Find the page of an annotation object.

Parameters

$annotationOrIndirectObject : SetaPDF_Core_Document_Page_Annotation|SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

getPageByIndirectObject()

public SetaPDF_Core_Document_Catalog_Pages::getPageByIndirectObject (

SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

): SetaPDF_Core_Document_Page|false

Get a page by its indirect object.

Parameters

$indirectObject : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

getPageNumberByIndirectObject()

public SetaPDF_Core_Document_Catalog_Pages::getPageNumberByIndirectObject (

SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

): boolean|integer

Get the page number by a page indirect object.

If the object is not found in the page tree, false is returned.

Parameters

$indirectObject : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

getPageNumberByPageObject()

public SetaPDF_Core_Document_Catalog_Pages::getPageNumberByPageObject (

SetaPDF_Core_Document_Page $page

): boolean|integer

Get the page number by a page object.

If the object is not found in the page tree, false is returned.

Parameters

$page : SetaPDF_Core_Document_Page

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

getPagesIndirectObject()

public SetaPDF_Core_Document_Catalog_Pages::getPagesIndirectObject (

integer $pageNumber

): SetaPDF_Core_Type_IndirectObject

Get a pages indirect object.

Parameters

$pageNumber : integer

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

prepend()

public SetaPDF_Core_Document_Catalog_Pages::prepend (

SetaPDF_Core_Document_Catalog_Pages|SetaPDF_Core_Document_Page[]|SetaPDF_Core_Document_Page $pages

): void

Prepend pages to the existing pages.

Parameters

$pages : SetaPDF_Core_Document_Catalog_Pages|SetaPDF_Core_Document_Page[]|SetaPDF_Core_Document_Page

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

resolvePagesRootObject()

public SetaPDF_Core_Document_Catalog_Pages::resolvePagesRootObject (

[ boolean $create = false ]

): SetaPDF_Core_Type_IndirectObject

Resolves the root page tree node.

Parameters

$create : boolean

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception