doc-ja/reference/mbstring/functions/mb-str-pad.xml at master · php/doc-ja · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e4e09f45c91ede64c7b7834eda71e4dfcdd3fd85 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.mb-str-pad" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mb_str_pad</refname>
  <refpurpose>マルチバイト文字列を、特定の長さまで別のマルチバイト文字列で埋める</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_str_pad</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>pad_string</parameter><initializer>" "</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>pad_type</parameter><initializer><constant>STR_PAD_RIGHT</constant></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>
   の左、右または両側を指定した長さで埋めます。
   長さは Unicode のコードポイント単位で決まります。
  <parameter>pad_string</parameter> が指定されていない場合は、
  <parameter>string</parameter> は空白で埋められ、それ以外の場合は、
  <parameter>pad_string</parameter> からの文字で制限まで埋められます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       入力文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       <parameter>length</parameter> の値が負、
       または入力文字列の長さ以下である場合、埋める操作は行われません。
       <parameter>string</parameter> をそのまま返します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pad_string</parameter></term>
     <listitem>
      <note>
       <para>
        必要とされる埋める文字数が <parameter>pad_string</parameter>
        の長さで均等に分割できない場合、<parameter>pad_string</parameter>
        は切り捨てられます。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pad_type</parameter></term>
     <listitem>
      <para>
       オプションの引数 <parameter>pad_type</parameter> には、
       <constant>STR_PAD_RIGHT</constant>, <constant>STR_PAD_LEFT</constant>,
       <constant>STR_PAD_BOTH</constant>
       を指定可能です。
       <parameter>pad_type</parameter>が指定されない場合、
       <constant>STR_PAD_RIGHT</constant>
       を仮定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &mbstring.encoding.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   埋めた後の文字列を返します。
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mb_str_pad</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_RIGHT)); // string(18) "▶▶❤❓❇❤"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_LEFT));  // string(18) "❤❓❇❤▶▶"
var_dump(mb_str_pad('▶▶', 6, '❤❓❇', STR_PAD_BOTH));  // string(18) "❤❓▶▶❤❓"

var_dump(mb_str_pad("🎉", 3, "祝", STR_PAD_LEFT));   // string(10) "祝祝🎉"
?>
]]>
    </programlisting>
   </example>
  </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
-->