svn: /phpdoc/en/trunk/reference/image/ constants.xml figures/imagefliphorizontal.png figures/imageflipvertical.png functions/imageflip.xml
versions.xml
| From: | Kalle Sommer Nielsen | Date: | Fri, 22 Mar 2013 16:08:07 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/image/ constants.xml figures/imagefliphorizontal.png figures/imageflipvertical.png functions/imageflip.xml versions.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-11115@lists.php.net to get a copy of this message | ||
kalle Fri, 22 Mar 2013 16:08:07 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=329873
Log:
Documented imageflip(), available as of PHP 5.5.0 using LibGD
Changed paths:
U phpdoc/en/trunk/reference/image/constants.xml
A phpdoc/en/trunk/reference/image/figures/imagefliphorizontal.png
A phpdoc/en/trunk/reference/image/figures/imageflipvertical.png
A phpdoc/en/trunk/reference/image/functions/imageflip.xml
U phpdoc/en/trunk/reference/image/versions.xml
Modified: phpdoc/en/trunk/reference/image/constants.xml
===================================================================
--- phpdoc/en/trunk/reference/image/constants.xml 2013-03-22 15:52:00 UTC (rev 329872)
+++ phpdoc/en/trunk/reference/image/constants.xml 2013-03-22 16:08:07 UTC (rev 329873)
@@ -789,6 +789,43 @@
</simpara>
</listitem>
</varlistentry>
+
+ <varlistentry xml:id="constant.img-flip-vertical">
+ <term>
+ <constant>IMG_FLIP_VERTICAL</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used together with <function>imageflip</function>, available as of PHP 5.5.0.
+ </simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="constant.img-flip-horizontal">
+ <term>
+ <constant>IMG_FLIP_HORIZONTAL</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used together with <function>imageflip</function>, available as of PHP 5.5.0.
+ </simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry xml:id="constant.img-flip-both">
+ <term>
+ <constant>IMG_FLIP_BOTH</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ Used together with <function>imageflip</function>, available as of PHP 5.5.0.
+ </simpara>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Added: phpdoc/en/trunk/reference/image/figures/imagefliphorizontal.png
===================================================================
(Binary files differ)
Property changes on: phpdoc/en/trunk/reference/image/figures/imagefliphorizontal.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: phpdoc/en/trunk/reference/image/figures/imageflipvertical.png
===================================================================
(Binary files differ)
Property changes on: phpdoc/en/trunk/reference/image/figures/imageflipvertical.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: phpdoc/en/trunk/reference/image/functions/imageflip.xml
===================================================================
--- phpdoc/en/trunk/reference/image/functions/imageflip.xml (rev 0)
+++ phpdoc/en/trunk/reference/image/functions/imageflip.xml 2013-03-22 16:08:07 UTC (rev 329873)
@@ -0,0 +1,179 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $ -->
+<refentry xml:id="function.imageflip" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>imageflip</refname>
+ <refpurpose>Flips an image using a given mode</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>imageflip</methodname>
+
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
+
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Flips the <parameter>image</parameter> image using the given
+ <parameter>mode</parameter>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ &gd.image.description;
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ Flip mode, this can be one of the <constant>IMG_FLIP_*</constant> constants:
+ </para>
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Constant</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><constant>IMG_FLIP_HORIZONTAL</constant></entry>
+ <entry>
+ Flips the image horizontally.
+ </entry>
+ </row>
+ <row>
+ <entry><constant>IMG_FLIP_VERTICAL</constant></entry>
+ <entry>
+ Flips the image vertically.
+ </entry>
+ </row>
+ <row>
+ <entry><constant>IMG_FLIP_BOTH</constant></entry>
+ <entry>
+ Flips the image both horizontally and vertically.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Flips an image vertically</title>
+ <para>
+ This example uses the <constant>IMG_FLIP_VERTICAL</constant>.
+ </para>
+ <programlisting role="php">
+<![CDATA[
+<?php
+// File
+$filename = 'phplogo.png';
+
+// Content type
+header('Content-type: image/png');
+
+// Load
+$im = imagecreatefrompng($filename);
+
+// Flip it vertically
+imageflip($im, IMG_FLIP_VERTICAL);
+
+// Output
+imagejpeg($im);
+imagedestroy($im);
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <mediaobject>
+ <alt>Output of example: Vertically flipped image</alt>
+ <imageobject>
+ <imagedata fileref="en/reference/image/figures/imageflipvertical.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title>Flips the image horizontally</title>
+ <para>
+ This example uses the <constant>IMG_FLIP_HORIZONTAL</constant> constant.
+ </para>
+ <programlisting role="php">
+<![CDATA[
+<?php
+// File
+$filename = 'phplogo.png';
+
+// Content type
+header('Content-type: image/png');
+
+// Load
+$im = imagecreatefrompng($filename);
+
+// Flip it horizontally
+imageflip($im, IMG_FLIP_HORIZONTAL);
+
+// Output
+imagejpeg($im);
+imagedestroy($im);
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <mediaobject>
+ <alt>Output of example: Horizontally flipped image</alt>
+ <imageobject>
+ <imagedata fileref="en/reference/image/figures/imagefliphorizonal.jpg"/>
+ </imageobject>
+ </mediaobject>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ ¬e.bundled.gd;
+ </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
+-->
Modified: phpdoc/en/trunk/reference/image/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/image/versions.xml 2013-03-22 15:52:00 UTC (rev 329872)
+++ phpdoc/en/trunk/reference/image/versions.xml 2013-03-22 16:08:07 UTC (rev 329873)
@@ -49,6 +49,8 @@
<function name='imagecreatefromxbm' from='PHP 4 >= 4.0.1, PHP
5'/>
<function name='imagecreatefromxpm' from='PHP 4 >= 4.0.1, PHP
5'/>
<function name='imagecreatetruecolor' from='PHP 4 >= 4.0.6, PHP
5'/>
+ <function name='imagecrop' from='PHP >= 5.5.0'/>
+ <function name='imagecropauto' from='PHP >= 5.5.0'/>
<function name='imagedashedline' from='PHP 4, PHP 5'/>
<function name='imagedestroy' from='PHP 4, PHP 5'/>
<function name='imageellipse' from='PHP 4 >= 4.0.6, PHP 5'/>
@@ -59,6 +61,7 @@
<function name='imagefilledrectangle' from='PHP 4, PHP 5'/>
<function name='imagefilltoborder' from='PHP 4, PHP 5'/>
<function name='imagefilter' from='PHP 5'/>
+ <function name='imageflip' from='PHP >= 5.5.0'/>
<function name='imagefontheight' from='PHP 4, PHP 5'/>
<function name='imagefontwidth' from='PHP 4, PHP 5'/>
<function name='imageftbbox' from='PHP 4 >= 4.0.7, PHP 5'/>