Source of: /manual/en/function.harudoc-setpagesconfiguration.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.harudoc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.harudoc-setpagesconfiguration.php',
1 => 'HaruDoc::setPagesConfiguration',
),
'up' =>
array (
0 => 'class.harudoc.php',
1 => 'The HaruDoc class',
),
'prev' =>
array (
0 => 'function.harudoc-setpagemode.php',
1 => 'HaruDoc::setPageMode',
),
'next' =>
array (
0 => 'function.harudoc-setpassword.php',
1 => 'HaruDoc::setPassword',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.harudoc-setpagesconfiguration" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruDoc::setPagesConfiguration</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruDoc::setPagesConfiguration</span> — <span class="dc-title">Set the number of pages per set of pages</span></p>
</div>
<a name="function.harudoc-setpagesconfiguration.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>HaruDoc::setPagesConfiguration</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$page_per_pages</tt></span>
)</div>
<p class="para rdfs-comment">
By default the document has one pages object as a root for all pages.
All page objects are create as branches of this object. One pages object
can contain only 8191, therefore the maximum number of pages per document
is 8191. But you can change that fact by setting
<i><tt class="parameter">page_per_pages</tt></i>
parameter, so that the root pages
object contains 8191 more pages (not page) objects, which in turn contain
8191 pages each. So the maximum number of pages in the document becomes
8191*<i><tt class="parameter">page_per_pages</tt></i>
.
</p>
</div>
<a name="function.harudoc-setpagesconfiguration.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">page_per_pages</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The numbers of pages that a pages object can contain.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.harudoc-setpagesconfiguration.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success.
</p>
</div>
<a name="function.harudoc-setpagesconfiguration.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.php" class="classname">HaruException</a> on error.</p>
</div>
</div><?php manual_footer(); ?>
