PHP - Manual: HaruDoc::addPageLabel
2024-12-21
(PECL haru >= 0.0.1)
HaruDoc::addPageLabel — Set the numbering style for the specified range of pages
$first_page
, int $style
, int $first_num
[, string $prefix
= ""
] ) : boolSet the numbering style for the specified range of pages.
first_page
The first page included into the labeling range.
style
The numbering style. The following values are allowed:
HaruPage::NUM_STYLE_DECIMAL
- page label is
displayed using decimal numerals.
HaruPage::NUM_STYLE_UPPER_ROMAN
- page label is
displayed using uppercase Roman numerals.
HaruPage::NUM_STYLE_LOWER_ROMAN
- page label is
displayed using lowercase Roman numerals.
HaruPage::NUM_STYLE_UPPER_LETTER
- page label is
displayed using uppercase letters (from A to Z).
HaruPage::NUM_STYLE_LOWER_LETTERS
- page label
is displayed using lowercase letters (from a to z).
first_num
The first page number in this range.
prefix
The prefix for the page label.
Returns TRUE
on success.
发生错误时抛出 HaruException 异常。