archived-doc-de/reference/strings/functions/htmlentities.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: sammywg Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.htmlentities">
 <refnamediv>
  <refname>htmlentities</refname>
  <refpurpose>Wandelt alle geeigneten Zeichen in entsprechende HTML-Codes um</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>htmlentities</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter><initializer>ENT_COMPAT</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>double_encode</parameter><initializer>true</initializer></methodparam>
  </methodsynopsis>
  <para>
   Die Funktion ist komplett identisch zu <function>htmlspecialchars</function>,
   allerdings wandelt <function>htmlentities</function> wirklich alle Zeichen,
   die eine HTML-Code-Entsprechung haben, in diese Entsprechung um.
  </para>
  <para>
   Möchten Sie stattdessen die HTML Entities dekodieren, verwenden Sie
   bitte die Funktion <function>html_entity_decode</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Die Eingabezeichenkette.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>quote_style</parameter></term>
     <listitem>
      <para>
       Wie bei <function>htmlspecialchars</function> können Sie mit dem
       optionalen zweiten Parameter <parameter>quote_style</parameter>
       definieren, wie 'einfache' und "doppelte" Anführungszeichen
       behandelt werden. Es gibt drei Konstanten, wobei
       <constant>ENT_COMPAT</constant> voreingestellt ist:
       <table>
        <title>Verfügbare <parameter>quote_style</parameter> Konstanten</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Konstante</entry>
           <entry>&Description;</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>ENT_COMPAT</constant></entry>
           <entry>Konvertiert nur doppelte Anführungszeichen und lässt einfache
            Anführungszeichen unverändert.</entry>
          </row>
          <row>
           <entry><constant>ENT_QUOTES</constant></entry>
           <entry>Konvertiert sowohl doppelte als auch einfache Anführungszeichen.</entry>
          </row>
          <row>
           <entry><constant>ENT_NOQUOTES</constant></entry>
           <entry>Lässt doppelte und einfache Anführungszeichen unverändert.</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       Wie bei <function>htmlspecialchars</function> steht das optionale dritte
       Argument <parameter>charset</parameter> zur Verfügung, das den für die
       Konvertierung benötigten Zeichensatz definiert. Gegenwärtig
       wird standardmäßig der ISO-8859-1 Zeichensatz verwendet.
      </para>
      &reference.strings.charsets;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>double_encode</parameter></term>
     <listitem>
      <para>
       Wenn <parameter>double_encode</parameter> ausgeschaltet ist, verändert
       PHP keine bereits vorhandenen HTML-Entities. Standardmäßig wird jedoch
       alles konvertiert.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt die kodierte Zeichenkette zurück.
  </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.2.3</entry>
       <entry>
        Der Parameter <parameter>double_encode</parameter> wurde hinzugefügt.
       </entry>
      </row>
      <row>
       <entry>4.1.0</entry>
       <entry>
        Der Parameter <parameter>charset</parameter> wurde hinzugefügt.
       </entry>
      </row>
      <row>
       <entry>4.0.3</entry>
       <entry>
        Der Parameter <parameter>quote_style</parameter> wurde hinzugefügt.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ein <function>htmlentities</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$str = "Ein 'Anführungszeichen' ist <b>fett</b>";

// Gibt aus: Ein 'Anf&uuml;hrungszeichen' ist &lt;b&gt;fett&lt;/b&gt;
echo htmlentities($str);

// Gibt aus: Ein &#039;Anf&uuml;hrungszeichen&#039; ist &lt;b&gt;fett&lt;/b&gt;
echo htmlentities($str, ENT_QUOTES);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>html_entity_decode</function></member>
    <member><function>get_html_translation_table</function></member>
    <member><function>htmlspecialchars</function></member>
    <member><function>nl2br</function></member>
    <member><function>urlencode</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:"~/.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
-->