reference/image/functions/imagegd2.xml
18f17b3e03337b79205d5306b9de20da01c3ac75
18f17b3e03337b79205d5306b9de20da01c3ac75
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xml:id='function.imagegd2' xmlns="http://docbook.org/ns/docbook">
3
+
<refentry xml:id="function.imagegd2" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>imagegd2</refname>
6
6
<refpurpose>Output GD2 image to browser or file</refpurpose>
...
...
@@ -9,13 +9,13 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>bool</type><methodname>imagegd2</methodname>
12
-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
13
-
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter><initializer>NULL</initializer></methodparam>
12
+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>file</parameter><initializer>&null;</initializer></methodparam>
14
14
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>128</initializer></methodparam>
15
-
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IMG_GD2_RAW</initializer></methodparam>
15
+
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>IMG_GD2_RAW</constant></initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Outputs a GD2 image to the given <parameter>to</parameter>.
18
+
Outputs a GD2 image to the given <parameter>file</parameter>.
19
19
</para>
20
20
</refsect1>
21
21
<refsect1 role="parameters">
...
...
@@ -24,7 +24,7 @@
24
24
<variablelist>
25
25
&gd.image.description;
26
26
<varlistentry>
27
-
<term><parameter>to</parameter></term>
27
+
<term><parameter>file</parameter></term>
28
28
<listitem>
29
29
<para>&gd.image.path;</para>
30
30
</listitem>
...
...
@@ -38,7 +38,7 @@
38
38
</listitem>
39
39
</varlistentry>
40
40
<varlistentry>
41
-
<term><parameter>type</parameter></term>
41
+
<term><parameter>mode</parameter></term>
42
42
<listitem>
43
43
<para>
44
44
Either <constant>IMG_GD2_RAW</constant> or
...
...
@@ -55,31 +55,30 @@
55
55
<para>
56
56
&return.success;
57
57
</para>
58
+
&gd.return.trueonerror;
58
59
</refsect1>
59
60
60
61
<refsect1 role="changelog">
61
62
&reftitle.changelog;
62
-
<para>
63
-
<informaltable>
64
-
<tgroup cols="2">
65
-
<thead>
66
-
<row>
67
-
<entry>&Version;</entry>
68
-
<entry>&Description;</entry>
69
-
</row>
70
-
</thead>
71
-
<tbody>
72
-
<row>
73
-
<entry>5.4.0</entry>
74
-
<entry>
75
-
Added support for passing a stream <type>resource</type> to
76
-
<parameter>to</parameter>.
77
-
</entry>
78
-
</row>
79
-
</tbody>
80
-
</tgroup>
81
-
</informaltable>
82
-
</para>
63
+
<informaltable>
64
+
<tgroup cols="2">
65
+
<thead>
66
+
<row>
67
+
<entry>&Version;</entry>
68
+
<entry>&Description;</entry>
69
+
</row>
70
+
</thead>
71
+
<tbody>
72
+
<row>
73
+
<entry>8.0.3</entry>
74
+
<entry>
75
+
<parameter>file</parameter> is now nullable.
76
+
</entry>
77
+
</row>
78
+
&gd.changelog.image-param;
79
+
</tbody>
80
+
</tgroup>
81
+
</informaltable>
83
82
</refsect1>
84
83
85
84
<refsect1 role="examples">
...
...
@@ -136,17 +135,15 @@ imagedestroy($im);
136
135
Note that the GD2 format is only usable in GD2-compatible applications.
137
136
</para>
138
137
</note>
138
+
&gd.deprecated.gd-formats;
139
139
</refsect1>
140
140
<refsect1 role="seealso">
141
141
&reftitle.seealso;
142
-
<para>
143
-
<simplelist>
144
-
<member><function>imagegd</function></member>
145
-
</simplelist>
146
-
</para>
142
+
<simplelist>
143
+
<member><function>imagegd</function></member>
144
+
</simplelist>
147
145
</refsect1>
148
146
</refentry>
149
-
150
147
<!-- Keep this comment at the end of the file
151
148
Local variables:
152
149
mode: sgml
153
150