<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: ca4b9d11a25fc9f8dde7561c504ed466ed1d6c63 Maintainer: hirokawa Status: ready -->

<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>

文字列 <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> にマッチする最後の文字を <parameter>trim_marker</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>

<function>mb_strimwidth</function>

に負の <parameter>width</parameter> を渡すことは、推奨されなくなりました。

</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

-->