Class PageLabels in namespace setasign\SetaPDF2\Core\Document\Catalog in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. Catalog
    2. Catalog
      1. AcroForm
      2. AdditionalActions
      3. Dests
      4. Extensions
      5. MarkInfo
      6. Names
      7. Names
      8. OptionalContent
      9. Outlines
      10. OutputIntents
      11. PageLabels
      12. Pages
      13. Permissions
      14. StructTreeRoot
      15. ViewerPreferences

setasign\SetaPDF2\Core\Document\Catalog

PageLabels Class for handling page labels

File: /SetaPDF v2/Core/Document/Catalog/PageLabels.php
Old class name (alias): \SetaPDF_Core_Document_Catalog_PageLabels

Class hierarchy

PageLabels

Summary

Constants

STYLE_DECIMAL_NUMERALS

public const string PageLabels::STYLE_DECIMAL_NUMERALS = 'D'

Style constant

Decimal arabic numerals

STYLE_LOWERCASE_LETTERS

public const string PageLabels::STYLE_LOWERCASE_LETTERS = 'a'

Style constant

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

STYLE_LOWERCASE_ROMAN_NUMERALS

public const string PageLabels::STYLE_LOWERCASE_ROMAN_NUMERALS = 'r'

Style constant

Lowercase roman numerals

STYLE_UPPERCASE_LETTERS

public const string PageLabels::STYLE_UPPERCASE_LETTERS = 'A'

Style constant

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

STYLE_UPPERCASE_ROMAN_NUMERALS

public const string PageLabels::STYLE_UPPERCASE_ROMAN_NUMERALS = 'R'

Style constant

Uppercase roman numerals

Properties

$_catalog

protected \SetaPDF_Core_Document_Catalog PageLabels::$_catalog

The documents catalog instance

$_ranges

protected array PageLabels::$_ranges = array()

Label ranges

$_tree

protected \SetaPDF_Core_DataStructure_NumberTree PageLabels::$_tree

The number tree

Static Methods

integerToLetters()

public static PageLabels::integerToLetters (

int $integer,
bool $uppercase = true

): string

Converts an integer to a letter.

Parameters

$integer : int
$uppercase : bool

integerToRoman()

public static PageLabels::integerToRoman (

int $integer,
bool $uppercase = true

): string

Converts an integer to roman numerals.

Parameters

$integer : int
$uppercase : bool

Methods

__construct()

public PageLabels::__construct (

\SetaPDF_Core_Document_Catalog $catalog

)

The constructor.

Parameters

$catalog : \SetaPDF_Core_Document_Catalog

_getRanges()

protected PageLabels::_getRanges (

void

): array

Get the page label ranges.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_getTree()

protected PageLabels::_getTree (

bool $create = false

): ?\SetaPDF_Core_DataStructure_NumberTree

Get the tree page labels number tree object.

Parameters

$create : bool

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

addRange()

public PageLabels::addRange (

int $startPage,
string $style = null,
string $prefix = '',
int $firstPageValue = 1,
string $encoding = 'UTF-8'

): void

Add a page label range.

Parameters

$startPage : int: The page index to start the page label range
$style : string: The page label style. See PageLabels::STYLE_XXX constants
$prefix : string: A page label prefix
$firstPageValue : int: The value of the numeric portion for the first page in the range
$encoding : string: The input encoding