new function

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

reference/strings/functions/htmlspecialchars-decode.xml

@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry id="function.htmlspecialchars-decode">
+ <refnamediv>
+  <refname>htmlspecialchars_decode</refname>
+  <refpurpose>
+   Convert special HTML entities back to characters
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>htmlspecialchars_decode</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam>
+  </methodsynopsis>
+
+  <para>
+   This function is the opposite of <function>htmlspecialchars</function>. It
+   converts special HTML entities back to characters.
+  </para>
+  <para>
+   The converted entities are: <literal>&amp;amp;</literal>,
+   <literal>&amp;quot;</literal> (when ENT_NOQUOTES is not set),
+   <literal>&amp;#039;</literal> (when ENT_QUOTES is set),
+   <literal>&amp;lt;</literal> and <literal>&amp;gt;</literal>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>string</parameter></term>
+     <listitem>
+      <para>
+       The string to decode
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>quote_style</parameter></term>
+     <listitem>
+      <para>
+       The quote style. One of the following constants:
+       <table>
+        <tgroup cols="2">
+         <thead>
+          <row>
+           <entry>Constant Name</entry>
+           <entry>Description</entry>
+          </row>
+         </thead>
+         <tbody>
+          <row>
+           <entry><constant>ENT_COMPAT</constant></entry>
+           <entry>Will convert double-quotes and leave single-quotes alone
+            (default)</entry>
+          </row>
+          <row>
+           <entry><constant>ENT_QUOTES</constant></entry>
+           <entry>Will convert both double and single quotes</entry>
+          </row>
+          <row>
+           <entry><constant>ENT_NOQUOTES</constant></entry>
+           <entry>Will leave both double and single quotes unconverted</entry>
+          </row>
+         </tbody>
+        </tgroup>
+       </table>
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the decoded string.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>htmlspecialchars_decode</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$str = '<p>this -&gt; &quot;</p>';
+
+echo htmlspecialchars_decode($str);
+
+// note that here the quotes aren't converted
+echo htmlspecialchars_decode($str, ENT_NOQUOTES);
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+<p>this -> "</p>
+<p>this -> &quot;</p>
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>htmlspecialchars</function></member>
+    <member><function>html_entity_decode</function></member>
+    <member><function>get_html_translation_table</function></member>
+   </simplelist>
+  </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
+-->