📄 function.harudoc-addpagelabel.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Set the numbering style for the specified range of pages</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.harudoc-addpage.html">HaruDoc::addPage</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.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="function.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"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><b>HaruDoc::addPageLabel</b></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$first_page</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$style</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$first_num</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$prefix</tt></span> ] )</div> <p class="para rdfs-comment"> Set the numbering style for the specified range of pages. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">first_page</tt></i></span> <dd> <p class="para"> The first page included into the labeling range. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">style</tt></i></span> <dd> <p class="para"> The numbering style. The following values are allowed: <ul class="simplelist"> <li class="member"> <b><tt>HaruPage::NUM_STYLE_DECIMAL</tt></b> - page label is displayed using decimal numerals. </li> <li class="member"> <b><tt>HaruPage::NUM_STYLE_UPPER_ROMAN</tt></b> - page label is displayed using uppercase Roman numerals. </li> <li class="member"> <b><tt>HaruPage::NUM_STYLE_LOWER_ROMAN</tt></b> - page label is displayed using lowercase Roman numerals. </li> <li class="member"> <b><tt>HaruPage::NUM_STYLE_UPPER_LETTER</tt></b> - page label is displayed using uppercase letters (from A to Z). </li> <li class="member"> <b><tt>HaruPage::NUM_STYLE_LOWER_LETTERS</tt></b> - page label is displayed using lowercase letters (from a to z). </li> </ul> </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">first_num</tt></i></span> <dd> <p class="para"> The first page number in this range. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">prefix</tt></i></span> <dd> <p class="para"> The prefix for the page label. Optional, empty by default. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <b><tt>TRUE</tt></b> on success. </p> </div> <div class="refsect1 errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Throws <a href="class.haruexception.html" class="classname">HaruException</a> on error. </p> </div> </div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.harudoc-addpage.html">HaruDoc::addPage</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.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>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -