nl2br.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.nl2br">
 <refnamediv>
  <refname>nl2br</refname>
  <refpurpose>Inserts HTML line breaks before all newlines in a string</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>nl2br</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>use_xhtml</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns <parameter>string</parameter> with <code>&lt;br /&gt;</code> or 
   <code>&lt;br&gt;</code> inserted before all newlines (<literal>\r\n</literal>,
   <literal>\n\r</literal>, <literal>\n</literal> and <literal>\r</literal>).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       The input string.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>use_xhtml</parameter></term>
     <listitem>
      <para>
       Whether to use XHTML compatible line breaks or not.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the altered string.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>nl2br</function></title>
    <programlisting role="php">
<![CDATA[
<?php
echo nl2br("foo isn't\n bar");
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
foo isn't<br />
 bar
]]>
    </screen>
   </example>
   <example>
    <title>Generating valid HTML markup using the <parameter>use_xhtml</parameter> parameter</title>
    <programlisting role="php">
<![CDATA[
<?php
echo nl2br("Welcome\r\nThis is my HTML document", false);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Welcome<br>
This is my HTML document
]]>
    </screen>
   </example>
   <example>
    <title>Various newline separators</title>
    <programlisting role="php">
<![CDATA[
<?php
$string = "This\r\nis\n\ra\nstring\r";
echo nl2br($string);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
This<br />
is<br />
a<br />
string<br />
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>htmlspecialchars</function></member>
    <member><function>htmlentities</function></member>
    <member><function>wordwrap</function></member>
    <member><function>str_replace</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
-->