archived-doc-ru/reference/strings/functions/sprintf.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<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></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
-->