1
0
mirror of https://github.com/php/doc-ja.git synced 2026-04-27 01:48:12 +02:00
Files
archived-doc-ja/reference/mbstring/functions/mb-strcut.xml
T
Yoshinari Takaoka 5e7aab1712 Generate ext/mbstring methodsynopses based on stubs
Closes GH-190.


git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@352036 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-12 18:33:55 +00:00

148 lines
5.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 92f1b8b177eb5730382abf9f27bae868f1bb636f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.mb-strcut" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_strcut</refname>
<refpurpose>文字列の一部を得る</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mb_strcut</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strcut</function> は、ある文字列からの部分文字列の抽出を
<function>mb_substr</function> と同じ方法で行います。ただし、
処理は文字単位ではなくバイト単位で行います。
切り出し位置がたまたまマルチバイト文字の 2 バイト目以降だった場合、
切り出しはその文字の最初のバイトから行われます。この挙動もまた
<function>substr</function> 関数と異なるところです。
<function>substr</function> の場合は、
マルチバイト文字の 2 バイト目以降であってもその位置から切り出しを行い、
結果的に壊れたバイト列を返すことになります。
</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>
<parameter>start</parameter> が非負である場合に返される文字列は、
<parameter>string</parameter><parameter>start</parameter> <emphasis>バイト</emphasis>目以降の文字列となります (ゼロから数えます)。
たとえば、文字列 '<literal>abcdef</literal>' の
<literal>0</literal> バイト目は '<literal>a</literal>' で、
<literal>2</literal> バイト目は '<literal>c</literal>' のようになります。
</para>
<para>
<parameter>start</parameter> が負の場合に返される文字列は、
<parameter>string</parameter> の後ろから数えて <parameter>start</parameter> バイト目以降となります。
負の <parameter>start</parameter> の絶対値が文字列の長さよりも大きい場合、
返される文字列は、<parameter>string</parameter> の先頭から始まります。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<emphasis>バイト</emphasis>単位での長さ。
省略したり <literal>NULL</literal> を指定したりした場合は、
文字列の最後までの全バイトを取り出します。
</para>
<para>
<parameter>length</parameter> が負の場合、返される文字列は
<parameter>string</parameter> の後ろから数えて
<parameter>length</parameter> バイト目で終了します。
しかし、負の <parameter>length</parameter> の絶対値が
<parameter>start</parameter> の位置を超える場合、空の文字列が返されます。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
&mbstring.encoding.parameter;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>mb_strcut</function> は、
<parameter>start</parameter> および
<parameter>length</parameter> パラメータで指定した
<parameter>string</parameter> の一部を返します。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_substr</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
-->