mb-strimwidth.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ca4b9d11a25fc9f8dde7561c504ed466ed1d6c63 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-strimwidth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_strimwidth</refname>
  <refpurpose>Получает строку, обрезанную до заданной ширины</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_strimwidth</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>start</parameter></methodparam>
   <methodparam><type>int</type><parameter>width</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>trim_marker</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Обрезает строку (<type>string</type>), переданную в параметр <parameter>string</parameter>,
   до заданой в параметре <parameter>width</parameter> ширины символов,
   где символы половинной ширины рассчитываются как <literal>1</literal>, а символы полной
   ширины — как <literal>2</literal>.
   Подробнее о ширине восточноазиатских символов рассказано в приложении <link xlink:href="&url.unicode.reports.tr;11/">&url.unicode.reports.tr;11/</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Исходная строка.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Смещение от начала строки. Количество символов от начала строки (первый символ стоит
       в позиции 0). Если указано отрицательное число, то отсчёт будет идти с конца строки.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       Ширина, до которой необходимо обрезать строку.
       Если задано отрицательное значение ширины, отсчёт будет идти с конца строки.
       <note>
        <para>
         Передача отрицательного значения ширины устарела с PHP 8.3.0.
        </para>
       </note>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>trim_marker</parameter></term>
     <listitem>
      <para>
       Строка, которая заместит конец обрезанной строки.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает обрезанную строку. Если задан четвёртый параметр <parameter>trim_marker</parameter>,
   то его значением замещаются символы в конце строки, так, чтобы суммарный размер был не более
   ширины <parameter>width</parameter>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Передача отрицательного значения в параметр <parameter>width</parameter>
       функции <function>mb_strimwidth</function> устарела.
      </entry>
     </row>
     &mbstring.changelog.encoding-nullable;
     <row>
      <entry>7.1.0</entry>
      <entry>
       Добавлена поддержка отрицательных значений для параметров <parameter>start</parameter>
       и <parameter>width</parameter>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>mb_strimwidth</function></title>
    <programlisting role="php">
<![CDATA[
<?php
echo mb_strimwidth("Hello World", 0, 10, "...");
// Выведет "Hello W..."
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_strwidth</function></member>
    <member><function>mb_internal_encoding</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
-->