SetaPDF_Core_Document_Catalog_PageLabels Class for handling page labels

File: /SetaPDF/Core/Document/Catalog/PageLabels.php

Class hierarchy

Summary

Constants

STYLE_DECIMAL_NUMERALS

Decimal arabic numerals

STYLE_LOWERCASE_LETTERS

Lowercase letters (a to z for the first 26 pages, aa to zz for the next 26, and so on)

STYLE_LOWERCASE_ROMAN_NUMERALS

Lowercase roman numerals

STYLE_UPPERCASE_LETTERS

Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on)

STYLE_UPPERCASE_ROMAN_NUMERALS

Uppercase roman numerals


Properties

$_catalog

$_ranges

Label ranges


Static Methods

integerToLetters()

static public string SetaPDF_Core_Document_Catalog_PageLabels::integerToLetters ( integer $integer [, boolean $uppercase = true ] )

Converts an integer to a letter.

Parameters
$integer : integer
 
$uppercase : boolean
 

integerToRoman()

static public string SetaPDF_Core_Document_Catalog_PageLabels::integerToRoman ( integer $integer [, boolean $uppercase = true ] )

Converts an integer to roman numerals.

Parameters
$integer : integer
 
$uppercase : boolean
 

Methods

__construct()

_getRanges()

Get the page label ranges.

_getTree()

Get the tree page labels number tree object.

Parameters
$create : boolean
 

addRange()

public void SetaPDF_Core_Document_Catalog_PageLabels::addRange ( integer $startPage [, string $style = null [, string $prefix = '' [, integer $firstPageValue = 1 [, string $encoding = 'UTF-8' ]]]] )

Add a page label range.

Parameters
$startPage : integer

The page index to start the page label range

$style : string

The page label style. See SetaPDF_Core_Document_Catalog_PageLabels::STYLE_XXX constants

$prefix : string

A page label prefix

$firstPageValue : integer

The value of the numeric portion for the first page in the range

$encoding : string

The input encoding

Exceptions

Throws InvalidArgumentException

cleanUp()

Release memory / cycled references.

getDocument()

getPageLabelByPageNo()

public string SetaPDF_Core_Document_Catalog_PageLabels::getPageLabelByPageNo ( integer $pageNo [, string $encoding = 'UTF-8' ] )

Get the page label by a page number/index.

Parameters
$pageNo : integer

The page number/index to get the page label for

$encoding : string

The output encoding

Return Values

Returns the page label for the specific page number/index

getRange()

public array|null SetaPDF_Core_Document_Catalog_PageLabels::getRange ( integer $startPage [, string $encoding = 'UTF-8' ] )

Get a range by starting page number.

Parameters
$startPage : integer
 
$encoding : string
 

getRanges()

public array SetaPDF_Core_Document_Catalog_PageLabels::getRanges ( [ string $encoding = 'UTF-8' ] )

Ger all ranges.

Parameters
$encoding : string
 

removeRange()

public null|boolean SetaPDF_Core_Document_Catalog_PageLabels::removeRange ( integer $startPage )

Removes a range by the starting page number.

Parameters
$startPage : integer
 
Exceptions

Throws InvalidArgumentException