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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wordwrap" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>wordwrap</refname>
<refpurpose>Wraps a string to a given number of characters</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>wordwrap</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width</parameter><initializer>75</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>break</parameter><initializer>"\n"</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>cut_long_words</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Wraps a string to a given number of characters using a string break
character.
Strings wrap after a space (U+0020) character unless <parameter>cut_long_words</parameter>
is set to &true;.
</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>width</parameter></term>
<listitem>
<para>
The number of characters at which the string will be wrapped.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>break</parameter></term>
<listitem>
<para>
The line is broken using the optional <parameter>break</parameter> parameter.
It must not be an empty string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cut_long_words</parameter></term>
<listitem>
<para>
If the <parameter>cut_long_words</parameter> is set to &true;, the string is
always wrapped at or before the specified <parameter>width</parameter>. So if you have
a word that is larger than the given width, it is broken apart.
(See second example). When &false; the function does not split the word
even if the <parameter>width</parameter> is smaller than the word width.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the given string wrapped at the specified length.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
If <parameter>break</parameter> is an empty string,
a <classname>ValueError</classname> is thrown.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
If <parameter>break</parameter> is empty string,
a <classname>ValueError</classname> is thrown;
previously in this case it emitted an <constant>E_WARNING</constant> and returned &false;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>wordwrap</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$text = "The quick brown fox jumped over the lazy dog.";
$newtext = wordwrap($text, 20, "<br />\n");
echo $newtext;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The quick brown fox<br />
jumped over the lazy<br />
dog.
]]>
</screen>
</example>
<example>
<title><function>wordwrap</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$text = "A very long woooooooooooord.";
$newtext = wordwrap($text, 8, "\n", true);
echo "$newtext\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
A very
long
wooooooo
ooooord.
]]>
</screen>
</example>
<example>
<title><function>wordwrap</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$text = "A very long woooooooooooooooooord. and something";
$newtext = wordwrap($text, 8, "\n", false);
echo "$newtext\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
A very
long
woooooooooooooooooord.
and
something
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>nl2br</function></member>
<member><function>chunk_split</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
-->
|
