<!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>Incrementally inflate encoded data</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.gzwrite.html">gzwrite</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.inflate-get-read-len.html">inflate_get_read_len</a></div> <div class="up"><a href="ref.zlib.html">Zlib Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.inflate-add" class="refentry"> <div class="refnamediv"> <h1 class="refname">inflate_add</h1> <p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">inflate_add</span> — <span class="dc-title">Incrementally inflate encoded data</span></p> </div> <div class="refsect1 description" id="refsect1-function.inflate-add-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>inflate_add</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoded_data</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flush_mode</code><span class="initializer"> = ZLIB_SYNC_FLUSH</span></span> ] )</div> <p class="para rdfs-comment"> Incrementally inflates encoded data in the specified <code class="parameter">context</code>. </p> <p class="para"> Limitation: header information from GZIP compressed data are not made available. </p> </div> <div class="refsect1 parameters" id="refsect1-function.inflate-add-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">context</code></dt> <dd> <p class="para"> A context created with <span class="function"><a href="function.inflate-init.html" class="function">inflate_init()</a></span>. </p> </dd> <dt> <code class="parameter">encoded_data</code></dt> <dd> <p class="para"> A chunk of compressed data. </p> </dd> <dt> <code class="parameter">flush_mode</code></dt> <dd> <p class="para"> One of <strong><code>ZLIB_BLOCK</code></strong>, <strong><code>ZLIB_NO_FLUSH</code></strong>, <strong><code>ZLIB_PARTIAL_FLUSH</code></strong>, <strong><code>ZLIB_SYNC_FLUSH</code></strong> (default), <strong><code>ZLIB_FULL_FLUSH</code></strong>, <strong><code>ZLIB_FINISH</code></strong>. Normally you will want to set <strong><code>ZLIB_NO_FLUSH</code></strong> to maximize compression, and <strong><code>ZLIB_FINISH</code></strong> to terminate with the last chunk of data. See the <a href="http://www.zlib.net/manual.html" class="link external">» zlib manual</a> for a detailed description of these constants. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-function.inflate-add-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a chunk of uncompressed data, or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 errors" id="refsect1-function.inflate-add-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> If invalid parameters are given, inflating the data requires a preset dictionary, but none is specified, the compressed stream is corrupt or has an invalid checksum, an error of level <strong><code>E_WARNING</code></strong> is generated. </p> </div> <div class="refsect1 seealso" id="refsect1-function.inflate-add-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="function"><a href="function.inflate-init.html" class="function" rel="rdfs-seeAlso">inflate_init()</a> - Initialize an incremental inflate context</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.gzwrite.html">gzwrite</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.inflate-get-read-len.html">inflate_get_read_len</a></div> <div class="up"><a href="ref.zlib.html">Zlib Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>