str-pad.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1f0319dfed1968563fe4a3445c88cfc80cf71df0 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.str-pad" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>str_pad</refname>
  <refpurpose>文字列を固定長の他の文字列で埋める</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>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>
  </methodsynopsis>
  <para>
   この関数は文字列 <parameter>string</parameter>
   の左、右または両側を指定した長さで埋めます。オプションの引数
   <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>
   </variablelist>
  </para>
 </refsect1>

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


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>str_pad</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$input = "Alien";
echo str_pad($input, 10);                      // 結果は "Alien     "
echo str_pad($input, 10, "-=", STR_PAD_LEFT);  // 結果は "-=-=-Alien"
echo str_pad($input, 10, "_", STR_PAD_BOTH);   // 結果は "__Alien___"
echo str_pad($input,  6, "___");               // 結果は "Alien_"
echo str_pad($input,  3, "*");                 // 結果は "Alien"
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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