From f50b25ab8b099f1891df153859edbaa59d5e28a1 Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Fri, 22 Mar 2013 16:08:07 +0000
Subject: [PATCH] Documented imageflip(), available as of PHP 5.5.0 using LibGD

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329873 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/image/constants.xml                 |  37 ++++
 .../image/figures/imagefliphorizontal.png     | Bin 0 -> 2223 bytes
 reference/image/figures/imageflipvertical.png | Bin 0 -> 2237 bytes
 reference/image/functions/imageflip.xml       | 179 ++++++++++++++++++
 reference/image/versions.xml                  |   3 +
 5 files changed, 219 insertions(+)
 create mode 100644 reference/image/figures/imagefliphorizontal.png
 create mode 100644 reference/image/figures/imageflipvertical.png
 create mode 100644 reference/image/functions/imageflip.xml

diff --git a/reference/image/constants.xml b/reference/image/constants.xml
index e9ccba1967..7e755f3bf3 100644
--- a/reference/image/constants.xml
+++ b/reference/image/constants.xml
@@ -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
diff --git a/reference/image/figures/imagefliphorizontal.png b/reference/image/figures/imagefliphorizontal.png
new file mode 100644
index 0000000000000000000000000000000000000000..263f3191e4a7e10704682d4a79204fdfcd49a49c
GIT binary patch
literal 2223
zcmV;g2vGNlP)<h;3K|Lk000e1NJLTq004LZ002V>0{{R3U<Wad0004fP)t-s0RI4&
zn9FHwoX5%G#>e1`i@9!apr@$PXlIFLWQ3ZW$=lrPr>f7Io6NYn*SNXajEuT(bEj!*
zoSU4?-{9>>Mqi1Ewr6BzxwyGYNJ-=3<DQ(I@$m6<a&xSztAc=m_V)VK)Yb0p^~c7?
zSyoq&j*tKU{~{hAb9b(8Z<t?ReRg=KcYCzIz}(Kz<ZN%AA|4>s*XXvl*H>74iHf?6
zj=z|h$X;NHyuR8$Jy2(9mw|$>mYKz#p~_WOc$}QguCUWFE;*c^$Y^SsW@wg*jlW!5
zc5G^lv$WS!QD`nJFO-(WrKrwpZl7dkl9H0d*xBlmmBWRIyL5Q2yS>?!mdJ8;tZi_j
zq@~b%eXZi-?^;`aj*!80bC_~;qlk;WdU~UAbg52GYinzgxw_emjlr3m#^vVldw#Wb
zd9h(*jcRS3ZgHhMI6U3n>|0!eOiN>`tkA;5-jI^QQc`k)gR_H%xkEx&vb5CG)#st4
z%goK<C?zU6H%EVhxRL$R8vp<R0d!JMQvg8b*k%9#2H;6VK~z|U?V0Ic+DI73Debo1
zZEF`Ql~ckMu^vsOE`p*`v_}-Lf>foAPzx&eAy)!_`{tUEOcD-l`(i))d*eqkGv7SV
z{AT7E&}jbG$V$F!B!3es{<d*`{{8z_$>&>NU$4_j(<-N5ot@3jo~-Ww3M6szZPrh#
z#Oll^MVAc*L$lco)L(u0iTLE|T=1Hge{WB()h2X|@{AI+=%@bmI)@Gfy3P0BZ|)4;
zZ_EYvSOsZZYJQ+{!BV|UlNr7L`o|rpHxIWMMH0H>!AP+p{(7_94Tr<c54U2+X=*SS
z(I-+@qeFpo{xpNe1CPg@@#T|XB%;shK93It%GJAJ9H%~=kAXe<7SZdYccF69rn@*r
zbw7-XeW=&w@?*^EAo-gVMTJK}zh$txTg<DP5(Wyx!e57A_vf^^=xyvYNXKa!9e6p2
zd!x@qe`d5mi6(|&@72Torj6#WdhH^o))*rTohm8~f?W(Ns097?buK|$Dr0uDnnK3_
zXB=E7yHmAEox&)^nZC)<;W96e&Tz8UMhDldd?&Q0+9nuQO!tXkDyN$p!=;usC7}hb
zlOv<vCPmM5S;mbfz{+jgxiLJ|F~CLsZKq>{TGeG_n(GBmW7FIiQ^hgBRS(z6-X7S@
z2a#_?T-qqy7=>}%RWWj%-0JQEWYIh?_wzh|TX&g<yNi_p!_EOWo=8ZJc)?v+W@WZx
zu~<iVg&4nHI{-*>|C1=ryQ|-cP$YLTs>Xv?6FSKw;4Zg^m&IjulI$=wl>Z1!L(Ikf
zZ$$aGwTU}b71${X`^0ZpiM&_x2)Iiulf_ChNd$p`X=w3n-Ka;Q(==L@XP&k;w}oBi
zp;`*KODf!m(6B7D$c473QK?hGn3Wp^=bRnS!zaGrE=V?-Ou~yCv~`%3JJ}H#nRYfa
z%Y?jmbefb0nL=tUc#(q?OoK^KdR=IiF^s7UE>m6@+_rIjICt4hqCq<FA_q>i19!<f
z*|YHY0XEm4k7WmN%)*D|q*q0(=(Ku3G)7Wb<h)^Hu)92bC$r!-7rc$8u`mrz$-x<y
zG%TX+;K{fZ0q){gvdmp>KEO;7bSfZ_wXZRZ1|Q3d$sQcmJjuVxj0Xkoia~9GyKrHr
zZS#qfog6GU?o}vt5R){l{%%%4VRt!UcbUP-*h30n%9J8js-BBBX;}0|0hXy5xC;Ss
z!R|5&HB%LYY?ba{99XHg6Wk@7j0DK&^l*2Ppi>5{?SAG&;LFQP8Mp)7g$N&k?0ZlZ
zcj2(R=KH&gMLNlxtB(}Ggv?z+i7^G-Wr5vgmbpuqe~%Q*t>fgS!U-yO7XZ6~yKJz#
zj52qrfcc&4Uauh!8MsTxQ4dseHk41T2}}ccC6CNq1gJfwV1BRG5RHZm4BW+sRjW9G
zK|NKFT9loJOa&|&59F>|3*l#FW?FJN;7=z_yg|s44cuiySy_#I2IzgFBNQmyBi9so
zB~<V?E3?rJI+?}igm4~flEgL)CR9$w88;#<Tv(p0;yKRbO}v5hD-g}S?WBy1sGN+B
zm|}s#KB}m^Ep8SsV^Phei6;-?;;3j-9AmnuR-iEZV%Dwn0C$k0fyGs(MzeFc1{n;v
zOCq<U*i$P|?ADA>o=7{H#oROK{<O1}IZ||2UnaW?;Z}tc4h(mD%+6ZB@)J?*4yX7E
zc1FQ>n13=MNwx_Dh2(5kc=H2yS%ha<lAXmG+y`}%lAGT;Magb$e}y_b;*EsJNF;tM
z;4WL1eN<EJ1g+BJGERMhxf;!j&TdG)lPC!kC?;fhTamN@9DgO}YBU?WmC8uBrJi)}
z8d0TgSna!?XHPd<yQ2i{lpP^M6*YvzP4(|KzqFPnIzz5|^ZoMIGVm5IlCIwEhW}K>
zGU?u&Sc$!ppH@-{N66q?IFPs0>~_<C58^UGKVPU;D}xg*xNFEQoK?za2m}o0L$Hh<
ztvt9-F6|5$i$GnRhJ*D!L$g^P_JyK=ULY6S<fiQ85L8oG-3roO*UJV&eUxa0gkQAZ
z96V{amWPI<s??sZo=%q^kNf+?#z*p?IC)xJ=^PD*!15-xO1|}a{cLV$Of0L=(&FT4
zHk&<Id3rboR2SXz`%7m&|M?w$4-0)HS@!8EIZ;^~wy#}zQ~6wEYwy~BJ-d4MU*Wzy
ze{e84Su8#|c+(~)mUct$k_15<9UV0qjUFrJ4_%#qKGx+E+Q{p<)#W=wfi@}^)%$PS
zi;Lv_2i1jz*u+w6v+{Je6MDC{bC}#F8Z`LIdwg<v^CSM#pd$REM;|vYo-bWo(A>=m
x!_BN6)|P4VkL~3CuRtp4#m0+gzX|o9(7$c6f0Y)|g3bT{002ovPDHLkV1giQSWy4~

literal 0
HcmV?d00001

diff --git a/reference/image/figures/imageflipvertical.png b/reference/image/figures/imageflipvertical.png
new file mode 100644
index 0000000000000000000000000000000000000000..0f136c20d0ff2aace8daeb3628c2040313b797ba
GIT binary patch
literal 2237
zcmV;u2txOXP)<h;3K|Lk000e1NJLTq004LZ002V>0{{R3U<Wad0004fP)t-s0RI4&
zn9FHwoX5%G#>e1`i@9!apr@$PXlIFLWQ3ZW$=lrPr>f7Io6NYn*SNXajEuT(bEj!*
zoSU4?-{9>>Mqi1Ewr6BzxwyGYNJ-=3<DQ(I@$m6<a&xSztAc=m_V)VK)Yb0p^~c7?
zSyoq&j*tKU{~{hAb9b(8Z<t?ReRg=KcYCzIz}(Kz<ZN%AA|4>s*XXvl*H>74iHf?6
zj=z|h$X;NHyuR8$Jy2(9mw|$>mYKz#p~_WOc$}QguCUWFE;*c^$Y^SsW@wg*jlW!5
zc5G^lv$WS!QD`nJFO-(WrKrwpZl7dkl9H0d*xBlmmBWRIyL5Q2yS>?!mdJ8;tZi_j
zq@~b%eXZi-?^;`aj*!80bC_~;qlk;WdU~UAbg52GYinzgxw_emjlr3m#^vVldw#Wb
zd9h(*jcRS3ZgHhMI6U3n>|0!eOiN>`tkA;5-jI^QQc`k)gR_H%xkEx&vb5CG)#st4
z%goK<C?zU6H%EVhxRL$R8vp<R0d!JMQvg8b*k%9#2JT5jK~z|U?U?C9+DI72yY$>`
zYZodN0p$j*(WX)t!J|^NwkVzmt70S6a>yY83`c;!eM2%6a!eppyI*#nZ)A>N-glmP
zXTpOA|4X%AzW(_7UqYSiC$@eNTZyIW;cEKRT5Ffw*k~+XT`j)4+W7MH>BnDz{BfH-
zjm_k;*)GM94|i63+!rLn9gEJ-R~|j27Z#fDA6Bl&`@=7-%)JX~;stH&7-PWQF4bj4
zQPk1V5kU}%Piwo2V|4TV!ShmSeEi_itH19IO{~mb`>yvkL-|5-CWj4Hb(I{W&(1QL
z%-J~oW$g~sOP}}r#^>9MXlI5n1v-4Oe89377JrJpGk0FAt$S}a<0C+!j#|s5v+>da
z{bke@zkOCtrE1>2<mgbSrAG7l!TaXbDC>P$)9cH%Ywh5fi8QCGVvns2y178lKUImn
zDA((HuWo2ab_XXnF`(1VBK`2uvKsWI-tX6Y)uh-y>0#wa59~&fmCF3k4fbcM)2ZL6
zvr}`51Dm2lI%Ypbm&Y~++U)mWr&AlUw7jAw4m{Ny+O^vnTWlx?{kR?s>LV(#7}j!d
z;7PlR&eU#W<Hbuf_aYeV+^EJfu6A=^kGrd;dzB=2k?DRL4*NADa52oP&RtN{+HMPR
zj(%;2%Q11!ZdxS4uBoyQGQeHaLU$30gRtyQYwZsyx7=>83!x-!cT2@qiWZ&W9{_h*
zfV;Y6Q#Qyd+T_Gq`Y#C=Z=VaXcALfNk!ZTXgladsoMB0WlXF+p>aa{o2RT}zBp#(#
zcZA%}I4<PUMj5pi7>%XP7DNN<u5QVO8YJE1)as#te2L?FA=f62i3==)*(Xp99vkDX
z(loMZsw4(u#9`tDa;t5;BWP+Fkz6J)(uQte+!a-5nzTy5*j8feH)v?QEv(J<DfAp3
zTgHWMVBBRz<(Yk3*%7iuBslIH9IpwUSB-Ft(_rMR2_~I(L-2&d%r=19<+Qi>fTs*x
zlN)aGmK5A2s1xAmu<&^UE|$gG;Eq}v@LUjFw32Mi=+~|ad?k~e<OY?Lj}VF?*cHZc
zukdjc&S8d0Y8XIZ5bT7Gfwjx#2ACpWKKUa=>Mo{`P~F}tZ{xV=^o3w2U;EP_`C+#~
z(geerhO5E9QvV2%xr<45Ho<1vFM28mV{Tw`BV2wM7Yxhdo{)kGGwdtBpk%X03^<6V
z#9$K~!9U7?cnt6jY-w>={2~bAvlf-y#elO67{{+gPvK-9BY)`h-39#}m4*c!*^jR@
zq3A9Q%OSx0WTpyy)OQ!CnDAKO!?M9eFf{ngxfI=nVaEtCUl)s3=+M5qrlszhfbJ?v
zoiWH=xtS9LI11Bd;xALYyI`H*-37w3@U_K3OEZVKpd80g5qDw!!nP7v=DxeYWHNVI
z&0#pG36>cqL4HBW#gYhDGhsk`d0a+&Dayz`++8&AfhX)TgF%Y!%EgWm`?wci|J0qF
za`go3gUnqpEL+Pur7%c-{hdi>5tWNk)v9nn_1%>LU3qsks#f%2jkx|MwFIJ8b7bUA
zL+CEh6P^yt^+fS?rS3Y`7ETbS6GzS%il{kc?joVPGQHO|Ag>TMiMx`8Eb2Vw)UCLu
zWj8mWyFj6+0(XUbDd^H>6JpS`*j+P)_&)Lm0z_2oW{1fI1hVLK8@S&NIGG!C;4Z%e
zEgS@1(js=3Hok(sa|zfjW>+*zj50PD7+qpT!_V;+_q)VLRqYSrFDRl!$K(8MPjbsd
zs0-KDsQmpeQx#RaV)4k5=w2;zwpeypyGZrm{wD9cYbGAK6@N(#AveMPa#aR)6N}&E
z{5mk)Q|UJh!rB7Clf#KR<dnp3a_Fv@jLVYi1OE9)19uhO%6()a#qP=_BY7E@UFTpx
zaSq;H=AU*~t`N!J%DE37T(t4Fa=PsnCo5?g8YuS!H>h`uipBHqKA^Zv2`l1wM=59$
z?ANBM{~drD{2(S=&9{9tmrFNZkB>03O69bXybhUWK4?FVw^Om<Q;mdWOr@Dq4i~I+
zkU{J3G3uN)uhBhGSY45}gY9;^?z<mstkA<Aslc-6PP-lMq(=Mm387<cM5haVQ;Y5C
z@@qRB4t8q!yHNAGP$+P^G@K^V{xg3#7z}n&KDGaC3Y1I6b)i6D^U3YWaFSe)x9dH0
zr(W}g)I($1cxbbyC%40lJcxbqxzm&1U#{H*h9o|zjcWpXtO9e?9jHLJ-#^zGvcF!h
z>-DvD-}QAM&Zy9nwx_s8qubkKo^uM!tt9RYh1y@)ep}<v`f@qNsK#i0eckKzp5L(Y
zF`E5$O8nHS4#l6&&YqvYO^MMro8P}*UQ!=^1rntM_2&Lk`XA6g;y8bm$DHf#00000
LNkvXXu0mjf#1MfD

literal 0
HcmV?d00001

diff --git a/reference/image/functions/imageflip.xml b/reference/image/functions/imageflip.xml
new file mode 100644
index 0000000000..90c09e0a5e
--- /dev/null
+++ b/reference/image/functions/imageflip.xml
@@ -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;
+  &note.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
+-->
diff --git a/reference/image/versions.xml b/reference/image/versions.xml
index 6291467c6f..eb9e64d7f2 100644
--- a/reference/image/versions.xml
+++ b/reference/image/versions.xml
@@ -49,6 +49,8 @@
  <function name='imagecreatefromxbm' from='PHP 4 &gt;= 4.0.1, PHP 5'/>
  <function name='imagecreatefromxpm' from='PHP 4 &gt;= 4.0.1, PHP 5'/>
  <function name='imagecreatetruecolor' from='PHP 4 &gt;= 4.0.6, PHP 5'/>
+ <function name='imagecrop' from='PHP &gt;= 5.5.0'/>
+ <function name='imagecropauto' from='PHP &gt;= 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 &gt;= 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 &gt;= 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 &gt;= 4.0.7, PHP 5'/>