Most image writing functions accept also a stream as second argument

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339706 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2016-07-23 13:16:11 +00:00
parent c9279f4467
commit 3cb7b87445
9 changed files with 164 additions and 21 deletions

View file

@ -554,7 +554,7 @@ own font identifiers registered with <function>imageloadfont</function>.
<!ENTITY gd.source.width 'Source width.'>
<!ENTITY gd.image.path 'The path to save the file to. If not set or &null;, the raw image stream will be outputted directly.'>
<!ENTITY gd.image.path 'The path or an open stream resource (which is automatically being closed after this function returns) to save the file to. If not set or &null;, the raw image stream will be outputted directly.'>
<!ENTITY gd.image.new 'Create a new image from file or URL'>

View file

@ -10,10 +10,10 @@
<methodsynopsis>
<type>bool</type><methodname>imagegd</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
</methodsynopsis>
<para>
Outputs a GD image to the given <parameter>filename</parameter>.
Outputs a GD image to the given <parameter>to</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -22,7 +22,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
</listitem>
@ -36,6 +36,32 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

View file

@ -10,12 +10,12 @@
<methodsynopsis>
<type>bool</type><methodname>imagegd2</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IMG_GD2_RAW</initializer></methodparam>
</methodsynopsis>
<para>
Outputs a GD2 image to the given <parameter>filename</parameter>.
Outputs a GD2 image to the given <parameter>to</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -24,7 +24,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
</listitem>
@ -56,6 +56,32 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

View file

@ -10,11 +10,11 @@
<methodsynopsis>
<type>bool</type><methodname>imagegif</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagegif</function> creates the <acronym>GIF</acronym>
file in filename from the image <parameter>image</parameter>. The
file in <parameter>to</parameter> from the image <parameter>image</parameter>. The
<parameter>image</parameter> argument is the return from the
<function>imagecreate</function> or <literal>imagecreatefrom*</literal>
function.
@ -32,7 +32,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
</listitem>
@ -46,6 +46,32 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

View file

@ -10,7 +10,7 @@
<methodsynopsis>
<type>bool</type><methodname>imagejpeg</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam>
</methodsynopsis>
<para>
@ -24,7 +24,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
<para>
@ -120,7 +120,7 @@ imagestring($im, 1, 5, 5, 'A Simple Text String', $text_color);
// Set the content type header - in this case image/jpeg
header('Content-Type: image/jpeg');
// Skip the filename parameter using NULL, then set the quality to 75%
// Skip the to parameter using NULL, then set the quality to 75%
imagejpeg($im, NULL, 75);
// Free up memory
@ -157,7 +157,14 @@ imagedestroy($im);
<row>
<entry>5.4.0</entry>
<entry>
Disallowed passing an empty string to <parameter>filename</parameter> to
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
<row>
<entry>5.4.0</entry>
<entry>
Disallowed passing an empty string to <parameter>to</parameter> to
skip this argument.
</entry>
</row>

View file

@ -10,7 +10,7 @@
<methodsynopsis>
<type>bool</type><methodname>imagepng</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>filters</parameter></methodparam>
</methodsynopsis>
@ -25,7 +25,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
<note>
@ -78,6 +78,13 @@
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
<row>
<entry>5.1.3</entry>
<entry>

View file

@ -10,7 +10,7 @@
<methodsynopsis>
<type>bool</type><methodname>imagewbmp</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>foreground</parameter></methodparam>
</methodsynopsis>
<para>
@ -24,7 +24,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
</listitem>
@ -48,6 +48,32 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

View file

@ -11,7 +11,7 @@
<methodsynopsis>
<type>bool</type><methodname>imagewebp</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>to</parameter></methodparam>
</methodsynopsis>
<para>
Outputs or save an WebP version of the given <parameter>image</parameter>.
@ -24,7 +24,7 @@
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>&gd.image.path;</para>
</listitem>
@ -40,6 +40,31 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added support for passing a stream <type>resource</type> to
<parameter>to</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

View file

@ -33,7 +33,7 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>&gd.image.path;</para>
<para>The path to save the file to. If not set or &null;, the raw image stream will be outputted directly.</para>
<para>
The <parameter>filename</parameter> (without the .xbm extension) is also
used for the C identifiers of the <acronym>XBM</acronym>, whereby non