Index

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

SetaPDF_Core_Document_Catalog_PageLabels Class for handling page labels

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

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

STYLE_DECIMAL_NUMERALS

public const string SetaPDF_Core_Document_Catalog_PageLabels::STYLE_DECIMAL_NUMERALS = 'D'

Style constant

Decimal arabic numerals

STYLE_LOWERCASE_LETTERS

public const string SetaPDF_Core_Document_Catalog_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 SetaPDF_Core_Document_Catalog_PageLabels::STYLE_LOWERCASE_ROMAN_NUMERALS = 'r'

Style constant

Lowercase roman numerals

STYLE_UPPERCASE_LETTERS

public const string SetaPDF_Core_Document_Catalog_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 SetaPDF_Core_Document_Catalog_PageLabels::STYLE_UPPERCASE_ROMAN_NUMERALS = 'R'

Style constant

Uppercase roman numerals


Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_PageLabels::$_catalog

The documents catalog instance

$_ranges

protected array SetaPDF_Core_Document_Catalog_PageLabels::$_ranges = array()

Label ranges

$_tree

protected SetaPDF_Core_DataStructure_NumberTree SetaPDF_Core_Document_Catalog_PageLabels::$_tree

The number tree


Static Methods

integerToLetters()

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

Converts an integer to a letter.

Parameters
$integer : integer
 
$uppercase : boolean
 

integerToRoman()

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

Converts an integer to roman numerals.

Parameters
$integer : integer
 
$uppercase : boolean
 

Methods

__construct()

public SetaPDF_Core_Document_Catalog_PageLabels::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

_getRanges()

protected SetaPDF_Core_Document_Catalog_PageLabels::_getRanges (
void
): array

Get the page label ranges.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_getTree()

protected SetaPDF_Core_Document_Catalog_PageLabels::_getTree (
[ boolean $create = false ]
): null|SetaPDF_Core_DataStructure_NumberTree

Get the tree page labels number tree object.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

addRange()

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

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 SetaPDF_Core_DataStructure_Tree_KeyAlreadyExistsException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_PageLabels::cleanUp (
void
): void

Release memory / cycled references.

getDocument()

public SetaPDF_Core_Document_Catalog_PageLabels::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getPageLabelByPageNo()

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

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getRange()

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

Get a range by starting page number.

Parameters
$startPage : integer
 
$encoding : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getRanges()

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

Ger all ranges.

Parameters
$encoding : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

removeRange()

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

Removes a range by the starting page number.

Parameters
$startPage : integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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