HaruDoc
PHP Manual

HaruDoc::addPageLabel

(PECL haru:0.0.1)

HaruDoc::addPageLabelSet the numbering style for the specified range of pages

Descrição

bool HaruDoc::addPageLabel ( int $first_page , int $style , int $first_num [, string $prefix ] )

Set the numbering style for the specified range of pages.

Parâmetros

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. Optional, empty by default.

Valor Retornado

Returns TRUE on success.

Erros

Throws HaruException on error.


HaruDoc
PHP Manual