doc-zh/reference/strings/functions/nl2br.xml at master · php/doc-zh · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e095023e408c8cb6378ae16bb6870343a3946919 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.nl2br">
 <refnamediv>
  <refname>nl2br</refname>
  <refpurpose>在字符串所有新行之前插入 HTML 换行标记</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>
   在字符串 <parameter>string</parameter> 所有新行之前插入 <code>'&lt;br /&gt;'</code> 或 <code>'&lt;br&gt;'</code>，并返回。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       输入字符串。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>use_xhtml</parameter></term>
     <listitem>
      <para>
       是否使用 XHTML 兼容换行符。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回调整后的字符串。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><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>使用 <parameter>use_xhtml</parameter> 生成合法的 HTML 标记</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>各种换行分隔符</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
-->