HaruDoc
PHP Manual

HaruDoc::addPageLabel

(PECL haru >= 0.0.1)

HaruDoc::addPageLabelDéfinit le style de numérotation d'une série de pages

Description

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

Définit le style de numérotation d'une série de pages spécifiées.

Liste de paramètres

first_page

La première page de l'intervalle.

style

Le style de numérotation. Les valeurs suivantes sont autorisées :

  • HaruPage::NUM_STYLE_DECIMAL - le libellé de la page est affiché en utilisant des nombres décimaux.
  • HaruPage::NUM_STYLE_UPPER_ROMAN - le libellé de la page est affiché en utilisant des nombres romains en majuscule.
  • HaruPage::NUM_STYLE_LOWER_ROMAN - le libellé de la page est affiché en utilisant des nombres romains en minuscule.
  • HaruPage::NUM_STYLE_UPPER_LETTER - le libellé de la page est affiché en lettres majuscules (de A à Z).
  • HaruPage::NUM_STYLE_LOWER_LETTERS - le libellé de la page est affiché en lettres minuscules (de a à z).

first_num

Le numéro de la première page de l'intervalle.

prefix

Le préfixe pour le libellé de la page.

Valeurs de retour

Retourne TRUE en cas de succès.

Erreurs / Exceptions

Émet une exception HaruException en cas d'erreur.


HaruDoc
PHP Manual