wordwrap.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a6ee935b0e0416084509e2c82ecea0578c7f40cc Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.wordwrap" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wordwrap</refname>
  <refpurpose>打断字符串为指定数量的字串</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>
   使用字符串断点将字符串打断为指定数量的字串。除非 <parameter>cut_long_words</parameter>
   设置为 &true;，否则字符串将会在空格（U+0020）后换行。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       输入字符串。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       列宽度。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>break</parameter></term>
     <listitem>
      <para>
       使用可选的 <parameter>break</parameter> 参数打断字符串。不能是空字符串。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cut_long_words</parameter></term>
     <listitem>
      <para>
       如果 <parameter>cut_long_words</parameter> 设置为 &true;，字符串总是在指定的 <parameter>width</parameter>
       或者之前位置被打断。因此，如果有的单词宽度超过了给定的宽度，它将被分隔开来。（参见第二个示例）。当它是
       &false;，函数不会分割单词，哪怕 <parameter>width</parameter> 小于单词宽度。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   如果 <parameter>break</parameter> 是空字符串，抛出 <classname>ValueError</classname>。
  </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>
       如果 <parameter>break</parameter> 是空字符串，抛出 <classname>ValueError</classname>；之前此情况会触发
       <constant>E_WARNING</constant> 并且返回  &false;。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>wordwrap</function> 示例</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> 示例</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> 例子</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
-->