archived-doc-ru/reference/strings/functions/wordwrap.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a6ee935b0e0416084509e2c82ecea0578c7f40cc Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<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>
   Функция переносит строку через заданное количество символов
   и вставляет в место переноса символ переноса строки.
   Строки переносятся после символа пробела, который в таблице Юникода назначили кодовой точке U+0020,
   если только параметру <parameter>cut_long_words</parameter>
   не установили значение &true;.
  </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>width</parameter> или раньше,
       если для параметра <parameter>cut_long_words</parameter> установили значение &true;.
       Поэтому слова, длина которых превышает ширину,
       разбиваются на части, как во втором примере. Функция не разбивает слово,
       даже если ширина <parameter>width</parameter> меньше длины слова,
       если для параметра установили значение &false;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает строку с символами переноса на заданной длине.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   Функция выбросит исключение <classname>ValueError</classname>,
   если параметр <parameter>break</parameter> окажется пустой строкой.
  </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>
       Функция выбросит исключение <classname>ValueError</classname>,
       если параметр <parameter>break</parameter> окажется пустой строкой;
       раньше выдавалась ошибка уровня <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
-->