<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the numbering style for the specified range of pages</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harudoc.addpage.html">HaruDoc::addPage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harudoc.construct.html">HaruDoc::__construct</a></div>
<div class="up"><a href="class.harudoc.html">HaruDoc</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="harudoc.addpagelabel" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruDoc::addPageLabel</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruDoc::addPageLabel</span> — <span class="dc-title">Set the numbering style for the specified range of pages</span></p>
</div>
<div class="refsect1 description" id="refsect1-harudoc.addpagelabel-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>HaruDoc::addPageLabel</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$first_page</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$style</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$first_num</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code><span class="initializer"> = ""</span></span>
] )</div>
<p class="para rdfs-comment">
Set the numbering style for the specified range of pages.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-harudoc.addpagelabel-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">first_page</code></em></span>
<dd>
<p class="para">
The first page included into the labeling range.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">style</code></em></span>
<dd>
<p class="para">
The numbering style. The following values are allowed:
<ul class="simplelist">
<li class="member">
<strong><code>HaruPage::NUM_STYLE_DECIMAL</code></strong> - page label is
displayed using decimal numerals.
</li>
<li class="member">
<strong><code>HaruPage::NUM_STYLE_UPPER_ROMAN</code></strong> - page label is
displayed using uppercase Roman numerals.
</li>
<li class="member">
<strong><code>HaruPage::NUM_STYLE_LOWER_ROMAN</code></strong> - page label is
displayed using lowercase Roman numerals.
</li>
<li class="member">
<strong><code>HaruPage::NUM_STYLE_UPPER_LETTER</code></strong> - page label is
displayed using uppercase letters (from A to Z).
</li>
<li class="member">
<strong><code>HaruPage::NUM_STYLE_LOWER_LETTERS</code></strong> - page label
is displayed using lowercase letters (from a to z).
</li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">first_num</code></em></span>
<dd>
<p class="para">
The first page number in this range.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">prefix</code></em></span>
<dd>
<p class="para">
The prefix for the page label.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-harudoc.addpagelabel-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-harudoc.addpagelabel-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harudoc.addpage.html">HaruDoc::addPage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harudoc.construct.html">HaruDoc::__construct</a></div>
<div class="up"><a href="class.harudoc.html">HaruDoc</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
