mb-strimwidth.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ca4b9d11a25fc9f8dde7561c504ed466ed1d6c63 Maintainer: daijie Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<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>
       要截断的 <type>string</type>。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       开始位置的偏移。从这些字符数开始的截取字符串。（默认是 0 个字符）
       如果 start 是负数，就是字符串结尾处的字符数。
      </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>
   截断后的 <type>string</type>。如果设置了 <parameter>trim_marker</parameter>，还将结尾处的字符替换为
   <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
-->