1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.inflate-init" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>inflate_init</refname>
<refpurpose>Initialize an incremental inflate context</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
<type class="union"><type>InflateContext</type><type>false</type></type><methodname>inflate_init</methodname>
<methodparam><type>int</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
Initialize an incremental inflate context with the specified
<parameter>encoding</parameter>.
</para>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
One of the <constant>ZLIB_ENCODING_<replaceable>*</replaceable></constant> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array which may contain the following elements:
<variablelist>
<varlistentry>
<term><varname>level</varname></term>
<listitem>
<para>
The compression level in range -1..9; defaults to -1.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>memory</varname></term>
<listitem>
<para>
The compression memory level in range 1..9; defaults to 8.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>window</varname></term>
<listitem>
<para>
The zlib window size (logarithmic) in range 8..15; defaults to 15.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>strategy</varname></term>
<listitem>
<para>
One of <constant>ZLIB_FILTERED</constant>,
<constant>ZLIB_HUFFMAN_ONLY</constant>, <constant>ZLIB_RLE</constant>,
<constant>ZLIB_FIXED</constant> or
<constant>ZLIB_DEFAULT_STRATEGY</constant> (the default).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>dictionary</varname></term>
<listitem>
<para>
A <type>string</type> or an <type>array</type> of <type>strings</type>
of the preset dictionary (default: no preset dictionary).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Returns an inflate context resource (<literal>zlib.inflate</literal>) on
success, &return.falseforfailure;.
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If an invalid encoding or option is passed to <parameter>options</parameter>,
or the context couldn't be created, an error of level
<constant>E_WARNING</constant> is generated.
</para>
</refsect1><!-- }}} -->
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
On success, this function returns an <classname>InflateContext</classname> instance now;
previously, a <type>resource</type> was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<caution>
<simpara>
Unlike <function>gzinflate</function>, incremental inflate contexts do not
constrain the length of the decoded data, so provide no automatic protection
against Zip bombs.
</simpara>
</caution>
</refsect1>
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>inflate_add</function></member>
<member><function>deflate_init</function></member>
</simplelist>
</refsect1><!-- }}} -->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
