sprintf.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.sprintf" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sprintf</refname>
  <refpurpose>フォーマットされた文字列を返す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>sprintf</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <para>
   フォーマット文字列 <parameter>format</parameter>
   に基づき生成された文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &strings.parameter.format;
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   フォーマット文字列 <parameter>format</parameter>
   に基づき生成された文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &strings.errors.sprintf;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  &strings.changelog.sprintf;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>引数の交換</title>
   <para>
    フォーマット文字列における引数の 番号付け/交換
    をサポートしています。
   </para>
   <programlisting role="php">
    <![CDATA[
<?php
$num = 5;
$location = 'tree';

$format = 'There are %d monkeys in the %s';
echo sprintf($format, $num, $location);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
There are 5 monkeys in the tree
]]>
   </screen>
  </example>
  <para>
    ここで、フォーマット文字列が別のファイルにある場合を考えてみましょう。
    これは、出力を国際化したりする場合に行われる可能性があります。
    たとえばフォーマット文字列が次のように書き換えられたとすると、
  </para>
  <example>
   <title>間違った引数の順番</title>
   <para>
    フォーマット文字列における引数の 番号付け/交換
    をサポートしています。
   </para>
   <programlisting role="php">
    <![CDATA[
<?php
$num = 5;
$location = 'tree';

$format = 'The %s contains %d monkeys';
echo sprintf($format, $num, $location);
?>
]]>
   </programlisting>
  </example>
  <para>
    ここで、問題が発生します。フォーマット文字列における置換指示子の順番は、
    コードにおける引数の順番と一致していません。
    だからといってコードを変更するのではなく、
    むしろ置換指示子が参照するフォーマット文字列のほうで指示を行う方が望ましいでしょう。
    フォーマット文字列を次のように書き換えてみましょう。
  </para>

  <example>
   <title>順序付きの置換指示子</title>
   <programlisting role="php">
    <![CDATA[
<?php
$num = 5;
$location = 'tree';

$format = 'The %2$s contains %1$d monkeys';
echo sprintf($format, $num, $location);
?>
]]>
   </programlisting>
  </example>

  <para>
    こうすることによるもうひとつの利点は、
    同じ置換指示子を複数回使用する際にコードに引数を追加せずにすむことです。
  </para>

  <example>
   <title>置換指示子を繰り返し使う</title>
   <programlisting role="php">
    <![CDATA[
<?php
$num = 5;
$location = 'tree';

$format = 'The %2$s contains %1$d monkeys.
           That\'s a nice %2$s full of %1$d monkeys.';
echo sprintf($format, $num, $location);
?>
]]>
   </programlisting>
  </example>

  <para>
    引数の交換を使うときには、
    <emphasis>位置指定子</emphasis> <literal>n$</literal>
    をパーセント記号 (<literal>%</literal>) の直後に置かなければならず、
    間に他の指定を入れてはいけません。次に例を示します。
  </para>

  <example>
   <title>パディング文字を指定する</title>
   <programlisting role="php">
<![CDATA[
<?php
echo sprintf("%'.9d\n", 123);
echo sprintf("%'.09d\n", 123);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
......123
000000123
]]>
   </screen>
  </example>

  <example>
   <title>他の指定子と一緒に位置指定子を使う</title>
   <programlisting role="php">
<![CDATA[
<?php
$num = 5;
$location = 'tree';

$format = 'The %2$s contains %1$04d monkeys';
echo sprintf($format, $num, $location);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
The tree contains 0005 monkeys
]]>
   </screen>
  </example>

  <example>
   <title><function>sprintf</function>: 整数を0埋めする</title>
   <programlisting role="php">
<![CDATA[
<?php
$year = 2005;
$month = 5;
$day = 6;

$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
echo $isodate, PHP_EOL;
?>
]]>
   </programlisting>
  </example>

  <example>
   <title><function>sprintf</function>: 通貨をフォーマットする</title>
   <programlisting role="php">
<![CDATA[
<?php
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
echo $money, PHP_EOL;

$formatted = sprintf("%01.2f", $money);
echo $formatted, PHP_EOL;
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
123.1
123.10
]]>
   </screen>
  </example>
  <example>
   <title><function>sprintf</function>: 科学的記法</title>
   <programlisting role="php">
<![CDATA[
<?php
$number = 362525200;

echo sprintf("%.3e", $number), PHP_EOL;
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
3.625e+8
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>printf</function></member>
    <member><function>fprintf</function></member>
    <member><function>vprintf</function></member>
    <member><function>vsprintf</function></member>
    <member><function>vfprintf</function></member>
    <member><function>sscanf</function></member>
    <member><function>fscanf</function></member>
    <member><function>number_format</function></member>
    <member><function>date</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
-->