phpdftk API Documentation

PageLabeler
in package

FinalYes

Set page numbering labels on a PDF.

Usage: PageLabeler::open('report.pdf') ->setRomanNumerals(1, 4) // pages 1-4: i, ii, iii, iv ->setArabic(5, null, 1) // pages 5+: 1, 2, 3, ... ->save('labeled.pdf');

Table of Contents

Methods

getPageCount()  : int
getReader()  : PdfReader
getVersionWarnings()  : array<int, string>
open()  : self
openString()  : self
removeLabels()  : self
Remove all page labels from the document.
save()  : void
setAlphabetic()  : self
Set alphabetic labels for a page range.
setArabic()  : self
Set arabic numeral labels starting at a page.
setLabels()  : self
Set a label range starting at the given page.
setRomanNumerals()  : self
Set roman numeral labels for a page range.
toBytes()  : string

Methods

getPageCount()

public getPageCount() : int
Return values
int

getVersionWarnings()

public getVersionWarnings() : array<int, string>
Return values
array<int, string>

open()

public static open(string $path[, string $password = '' ]) : self
Parameters
$path : string
$password : string = ''
Return values
self

openString()

public static openString(string $pdfBytes[, string $password = '' ]) : self
Parameters
$pdfBytes : string
$password : string = ''
Return values
self

removeLabels()

Remove all page labels from the document.

public removeLabels() : self
Return values
self

save()

public save(string $path) : void
Parameters
$path : string

setAlphabetic()

Set alphabetic labels for a page range.

public setAlphabetic(int $fromPage, int $toPage[, bool $uppercase = false ]) : self
Parameters
$fromPage : int

1-based start page

$toPage : int

1-based end page

$uppercase : bool = false
Return values
self

setArabic()

Set arabic numeral labels starting at a page.

public setArabic(int $fromPage[, int|null $toPage = null ][, int $startNumber = 1 ]) : self
Parameters
$fromPage : int

1-based start page

$toPage : int|null = null

1-based end page, or null for all remaining

$startNumber : int = 1
Return values
self

setLabels()

Set a label range starting at the given page.

public setLabels(int $startPage, LabelStyle $style[, string $prefix = '' ][, int $startNumber = 1 ]) : self
Parameters
$startPage : int

1-based page number where this label range begins

$style : LabelStyle
$prefix : string = ''
$startNumber : int = 1
Return values
self

setRomanNumerals()

Set roman numeral labels for a page range.

public setRomanNumerals(int $fromPage, int $toPage[, bool $uppercase = false ]) : self
Parameters
$fromPage : int

1-based start page

$toPage : int

1-based end page

$uppercase : bool = false
Return values
self

toBytes()

public toBytes() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results