Initial documentation. This also closes bug #20093

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@104690 c90b9560-bf6c-de11-be94-00142212c4b1

reference/strings/functions/html-entity-decode.xml

@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
+  <refentry id="function.html-entity-decode">
+   <refnamediv>
+    <refname>html_entity_decode</refname>
+    <refpurpose>
+     Convert all HTML entities to their applicable characters
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>string</type><methodname>html_entity_decode</methodname>
+      <methodparam><type>string</type><parameter>string</parameter></methodparam>
+      <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam>
+      <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
+     </methodsynopsis>
+    <para>
+     <function>html_entity_decode</function> is the opposite of
+     <function>htmlentities</function> in that it converts all HTML entities
+     to their applicable characters from <parameter>string</parameter>.
+    </para>
+    <para>
+     The optional second <parameter>quote_style</parameter> parameter lets 
+     you define what will be done with 'single' and "double" quotes.  It takes 
+     on one of three constants with the default being 
+     <constant>ENT_COMPAT</constant>:
+     <table>
+      <title>Available <parameter>quote_style</parameter> constants</title>
+      <tgroup cols="2">
+       <thead>
+        <row>
+         <entry>Constant Name</entry>
+         <entry>Description</entry>
+        </row>
+       </thead>
+       <tbody>
+        <row>
+         <entry><constant>END_COMPAT</constant></entry>
+         <entry>Will convert double-quotes and leave single-quotes alone.</entry>
+        </row>
+        <row>
+         <entry><constant>ENT_QUOTES</constant></entry>
+         <entry>Will convert both double and single quotes.</entry>
+        </row>
+        <row>
+         <entry><constant>END_NOQUOTES</constant></entry>
+         <entry>Will leave both double and single quotes unconverted.</entry>
+        </row>
+       </tbody>
+      </tgroup>
+     </table>
+    </para>
+    <para>
+     The ISO-8859-1 character set is used as default for the optional third
+     <parameter>charset</parameter>.  This defines the character set used in
+     conversion.
+    </para>
+    <para>
+     <example>
+      <title>Decoding html entities</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$orig = "I'll \"walk\" the <b>dog</b> now";
+
+$a = htmlentities($orig);
+
+$b = html_entity_decode($a);
+
+echo $a; // I'll &quot;walk&quot; the &lt;b&gt;dog&lt;/b&gt; now
+
+echo $b; // I'll "walk" the <b>dog</b> now
+
+
+// For users prior to PHP 4.3.0 you may do this:
+function unhtmlentities ($string)
+{
+	$trans_tbl = get_html_translation_table (HTML_ENTITIES);
+	$trans_tbl = array_flip ($trans_tbl);
+	return strtr ($string, $trans_tbl);
+}
+
+$c = unhtmlentities($a);
+
+echo $c; // I'll "walk" the <b>dog</b> now
+
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     See also <function>htmlentities</function>,
+     <function>htmlspecialchars</function>,
+     <function>get_html_translation_table</function>, 
+     <function>htmlspecialchars</function> and <function>urldecode</function>.
+    </para>
+   </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:"../../../../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
+-->