Source of: /manual/en/function.harudoc-setcompressionmode.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-setcompressionmode.php',
1 => 'HaruDoc::setCompressionMode',
),
'up' =>
array (
0 => 'class.harudoc.php',
1 => 'The HaruDoc class',
),
'prev' =>
array (
0 => 'function.harudoc-savetostream.php',
1 => 'HaruDoc::saveToStream',
),
'next' =>
array (
0 => 'function.harudoc-setcurrentencoder.php',
1 => 'HaruDoc::setCurrentEncoder',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.harudoc-setcompressionmode" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruDoc::setCompressionMode</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruDoc::setCompressionMode</span> — <span class="dc-title">Set compression mode for the document</span></p>
</div>
<a name="function.harudoc-setcompressionmode.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::setCompressionMode</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span>
)</div>
<p class="para rdfs-comment">
Defines compression mode for the document. In case when libharu was
compiled without Zlib support this function will always throw
<a href="class.haruexception.php" class="classname">HaruException</a>.
</p>
</div>
<a name="function.harudoc-setcompressionmode.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">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The compression mode to use. The value is a combination of the
following flags:
</p><ul class="simplelist">
<li class="member">
<b><tt class="constant">HaruDoc::COMP_NONE</tt></b> - all contents is not
compressed.
</li>
<li class="member">
<b><tt class="constant">HaruDoc::COMP_TEXT</tt></b> - compress the text data.
</li>
<li class="member">
<b><tt class="constant">HaruDoc::COMP_IMAGE</tt></b> - compress the image data.
</li>
<li class="member">
<b><tt class="constant">HaruDoc::COMP_METADATA</tt></b> - compress other data (fonts,
cmaps).
</li>
<li class="member">
<b><tt class="constant">HaruDoc::COMP_ALL</tt></b> - compress all data.
</li>
</ul><p>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.harudoc-setcompressionmode.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-setcompressionmode.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(); ?>
