mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
fcef2ea0d9
* imagedashedline * imagestringup And added example usage for is_xhtml parameter on nl2br() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@264826 c90b9560-bf6c-de11-be94-00142212c4b1
158 lines
3.5 KiB
XML
158 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<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><type>bool</type><parameter>is_xhtml</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns <parameter>string</parameter> with '<br />' or
|
|
'<br>' inserted before all newlines.
|
|
</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>is_xhtml</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Whenever to use XHTML compatible line breaks or not (defaults to &true;)
|
|
</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>is_xhtml</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>
|
|
</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.3.0</entry>
|
|
<entry>
|
|
Added the <parameter>is_xhtml</parameter> parameter.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.0.5</entry>
|
|
<entry>
|
|
<function>nl2br</function> is now XHTML compliant. All older versions
|
|
will return <parameter>string</parameter> with '<br>' inserted
|
|
before newlines instead of '<br />'.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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:"../../../../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
|
|
-->
|