php-doc-en/reference/ircg/functions/ircg-html-encode.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.ircg-html-encode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ircg_html_encode</refname>
  <refpurpose>Encodes HTML preserving output</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>ircg_html_encode</methodname>
   <methodparam><type>string</type><parameter>html_string</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>auto_links</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>conv_br</parameter></methodparam>
  </methodsynopsis>
  <para>
   Encodes a HTML string <parameter>html_string</parameter> for
   output. This exposes the interface which the IRCG extension
   uses internally to reformat data coming from an IRC link.
   The function causes IRC color/font codes to be encoded in
   HTML and escapes certain entities.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>html_string</parameter></term>
     <listitem>
      <para>
       The HTML string to be encoded.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>auto_links</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>conv_br</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the encoded HTML string.
  </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
-->