phpdftk API Documentation

PageLabel extends PdfObject
in package

PDF Page Label dictionary (/Type /PageLabel).

Defines the numbering scheme for a range of pages. Page label ranges are stored as a number tree in /PageLabels in the Catalog; each key is the zero-based page index where the range begins.

Numbering styles (/S): D - Decimal Arabic numerals (1, 2, 3, …) r - Lowercase Roman numerals (i, ii, iii, …) R - Uppercase Roman numerals (I, II, III, …) a - Lowercase letters (a, b, …, z, aa, …) A - Uppercase letters (A, B, …, Z, AA, …) (omit /S to use prefix only, with no numeric part)

Attributes
#[RequiresPdfVersion]
\Phpdftk\Pdf\Core\PdfVersion::V1_3

Table of Contents

Constants

PDF_TYPE  = 'PageLabel'

Properties

$generationNumber  : int
$objectNumber  : int
$p  : PdfString|null
$s  : PdfName|null
$st  : int

Methods

toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Serialize the object's dictionary/value to PDF syntax.

Constants

PDF_TYPE

public mixed PDF_TYPE = 'PageLabel'

Properties

$generationNumber

public int $generationNumber = 0

Methods

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Serialize the object's dictionary/value to PDF syntax.

public toPdf() : string
Return values
string

        
On this page

Search results