archived-doc-ru/reference/strings/functions/number-format.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 45042fef652f1b4e904e809fcbfcf31f6c60670b Maintainer: irker Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.number-format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>number_format</refname>
  <refpurpose>Форматирует число с группировкой классов многозначного числа</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>number_format</methodname>
   <methodparam><type>float</type><parameter>num</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>decimals</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>decimal_separator</parameter><initializer>"."</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>thousands_separator</parameter><initializer>","</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция форматирует число с группировкой классов многозначного числа,
   и, если требуется, с десятичными разрядами. Функция применяет
   правило математического округления в бо́льшую сторону.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       Форматируемое число.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>decimals</parameter></term>
     <listitem>
      <para>
       Задаёт количество десятичных разрядов.
       Значение параметра <parameter>decimal_separator</parameter>
       опускается в возвращаемом значении,
       если в параметр передали значение <literal>0</literal>.
       Начиная с PHP 8.3.0 при отрицательном значении аргумента число <parameter>num</parameter>
       округляется до заданного в параметре <parameter>decimals</parameter> количества значащих чисел
       перед десятичной точкой.
       До PHP 8.3.0 функция игнорировала отрицательные значения и обрабатывала
       их как <literal>0</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>decimal_separator</parameter></term>
     <listitem>
      <para>
       Устанавливает разделитель дробной части.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>thousands_separator</parameter></term>
     <listitem>
      <para>
       Устанавливает разделитель классов многозначного числа.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает отформатированное число <parameter>num</parameter>.
  </para>
 </refsect1>


 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        Добавили ​​обработку отрицательных значений для параметра <parameter>decimals</parameter>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        До этой версии функция <function>number_format</function> принимала один,
        два или четыре параметр, но не три.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Функцию <function>number_format</function> изменили, чтобы не возвращать
        значение <literal>-0</literal>. Раньше функция иногда возвращала значение <literal>-0</literal>,
        если параметр <parameter>num</parameter> равнялся <literal>-0.01</literal>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример округления числа функцией <function>number_format</function></title>
    <para>
     Во французской нотации указывают два знака: запятую «,» как десятичный разделитель
     и пробел « » как разделитель классов многозначных чисел. Следующий пример демонстрирует
     способы форматирования числа:
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$number = 1234.56;

// Английская нотация (по умолчанию)
echo number_format($number), PHP_EOL;
// 1,235

// Французская нотация
echo number_format($number, 2, ',', ' '), PHP_EOL;
// 1 234,56

$number = 1234.5678;

// Английская нотация без разделителя классов многозначного числа
echo number_format($number, 2, '.', ''), PHP_EOL;
// 1234.57

?>
]]>
    </programlisting>
   </example>
  </para>
  <example>
   <title>Пример форматирования числа с отрицательным значением в аргументе <parameter>decimals</parameter></title>
   <simpara>
    Начиная с PHP 8.3.0 отрицательное значение аргумента <parameter>decimals</parameter>
    округляет число до заданного количества значащих чисел перед десятичной точкой.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php

$number = "1234.5678";

var_dump(number_format($number, -1));
var_dump(number_format($number, -2));
var_dump(number_format($number, -3));

?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
string(5) "1,230"
string(5) "1,200"
string(5) "1,000"
]]>
   </screen>
  </example>
 </refsect1>

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