1
0
mirror of https://github.com/php/doc-ru.git synced 2026-03-25 16:22:18 +01:00
Files
archived-doc-ru/reference/datetime/datetimeinterface/format.xml
2023-12-18 14:20:16 +03:00

523 lines
23 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ac397fd0da4d814b5a2f4ba49254f9b6093315e1 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="datetime.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeInterface::format</refname>
<refname>DateTimeImmutable::format</refname>
<refname>DateTime::format</refname>
<refname>date_format</refname>
<refpurpose>Возвращает дату, отформатированную согласно переданному формату</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="DateTimeInterface">
<modifier>public</modifier> <type>string</type><methodname>DateTimeInterface::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="DateTimeImmutable">
<modifier>public</modifier> <type>string</type><methodname>DateTimeImmutable::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<methodsynopsis role="DateTime">
<modifier>public</modifier> <type>string</type><methodname>DateTime::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>string</type><methodname>date_format</methodname>
<methodparam><type>DateTimeInterface</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает строку даты, преобразованной согласно переданному формату.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&date.datetime.description;
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Шаблон результирующей строки (<type>string</type>) с датой. Смотрите параметры
форматирования ниже. Также существует несколько <link
linkend="datetimeinterface.constants.types">предопределённых констант даты/времени</link>,
которые могут быть использованы вместо этих параметров. Например:
<constant>DATE_RSS</constant> заменяет шаблон <literal>'D, d M Y H:i:s'</literal>.
</para>
<para>
<table>
<title>В параметре <parameter>format</parameter> распознаются
следующие символы</title>
<tgroup cols="3">
<thead>
<row>
<entry>Символ в строке <parameter>format</parameter></entry>
<entry>Описание</entry>
<entry>Пример возвращаемого значения</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis>День</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>d</literal></entry>
<entry>День месяца, 2 цифры с ведущим нулём</entry>
<entry>От <literal>01</literal> до <literal>31</literal></entry>
</row>
<row>
<entry><literal>D</literal></entry>
<entry>Текстовое представление дня недели, 3 символа</entry>
<entry>От <literal>Mon</literal> до <literal>Sun</literal></entry>
</row>
<row>
<entry><literal>j</literal></entry>
<entry>День месяца без ведущего нуля</entry>
<entry>От <literal>1</literal> до <literal>31</literal></entry>
</row>
<row>
<entry><literal>l</literal> (строчная 'L')</entry>
<entry>Полное наименование дня недели</entry>
<entry>От <literal>Sunday</literal> до <literal>Saturday</literal></entry>
</row>
<row>
<entry><literal>N</literal></entry>
<entry>Порядковый номер дня недели в соответствии со
стандартом ISO 8601</entry>
<entry>От <literal>1</literal> (понедельник) до <literal>7</literal> (воскресенье)</entry>
</row>
<row>
<entry><literal>S</literal></entry>
<entry>Английский суффикс порядкового числительного дня месяца, 2 символа</entry>
<entry>
<literal>st</literal>, <literal>nd</literal>, <literal>rd</literal> или
<literal>th</literal>. Применяют совместно с <literal>j</literal>
</entry>
</row>
<row>
<entry><literal>w</literal></entry>
<entry>Порядковый номер дня недели</entry>
<entry>От <literal>0</literal> (воскресенье) до <literal>6</literal> (суббота)</entry>
</row>
<row>
<entry><literal>z</literal></entry>
<entry>Порядковый номер дня в году (начиная с 0)</entry>
<entry>От <literal>0</literal> до <literal>365</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Неделя</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>W</literal></entry>
<entry>Порядковый номер недели года в соответствии со стандартом
ISO 8601; недели начинаются с понедельника</entry>
<entry>Например: <literal>42</literal> (42-я неделя года)</entry>
</row>
<row>
<entry align="center"><emphasis>Месяц</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>F</literal></entry>
<entry>Полное наименование месяца, например, January или March</entry>
<entry>От <literal>January</literal> до <literal>December</literal></entry>
</row>
<row>
<entry><literal>m</literal></entry>
<entry>Порядковый номер месяца с ведущим нулём</entry>
<entry>От <literal>01</literal> до <literal>12</literal></entry>
</row>
<row>
<entry><literal>M</literal></entry>
<entry>Сокращённое наименование месяца, 3 символа</entry>
<entry>От <literal>Jan</literal> до <literal>Dec</literal></entry>
</row>
<row>
<entry><literal>n</literal></entry>
<entry>Порядковый номер месяца без ведущего нуля</entry>
<entry>От <literal>1</literal> до <literal>12</literal></entry>
</row>
<row>
<entry><literal>t</literal></entry>
<entry>Количество дней в указанном месяце</entry>
<entry>От <literal>28</literal> до <literal>31</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Год</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>L</literal></entry>
<entry>Признак високосного года</entry>
<entry><literal>1</literal>, если год високосный, иначе <literal>0</literal>.</entry>
</row>
<row>
<entry><literal>o</literal></entry>
<entry>Номер года в соответствии со стандартом ISO 8601. Имеет то же значение, что и
<literal>Y</literal>, кроме случая, когда номер недели ISO
(<literal>W</literal>) принадлежит предыдущему или следующему году; тогда
будет использован год этой недели.</entry>
<entry>Примеры: <literal>1999</literal> или <literal>2003</literal></entry>
</row>
<row>
<entry><literal>X</literal></entry>
<entry>
Расширенное полное числовое представление года,
не менее 4 цифр, с <literal>-</literal> для годов до нашей эры
и <literal>+</literal> для годов нашей эры.
</entry>
<entry>
Примеры: <literal>-0055</literal>, <literal>+0787</literal>,
<literal>+1999</literal>, <literal>+10191</literal>
</entry>
</row>
<row>
<entry><literal>x</literal></entry>
<entry>
Расширенное полное числовое представление, если требуется,
или стандартное полное числовое представление,
если возможно (например, <literal>Y</literal>). Не менее четырёх цифр.
Для годов до нашей эры указан префикс <literal>-</literal>.
У годов после (и включая) <literal>10000</literal> префикс <literal>+</literal>.
</entry>
<entry>
Примеры: <literal>-0055</literal>, <literal>0787</literal>,
<literal>1999</literal>, <literal>+10191</literal>
</entry>
</row>
<row>
<entry><literal>Y</literal></entry>
<entry>Полное числовое представление года, не менее 4 цифр, с <literal>-</literal> для годов до нашей эры.</entry>
<entry>
Примеры: <literal>-0055</literal>, <literal>0787</literal>,
<literal>1999</literal>, <literal>2003</literal>,
<literal>10191</literal>
</entry>
</row>
<row>
<entry><literal>y</literal></entry>
<entry>Номер года, 2 цифры</entry>
<entry>Примеры: <literal>99</literal>, <literal>03</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Время</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>a</literal></entry>
<entry>Ante meridiem (лат. «до полудня») или Post meridiem (лат. «после полудня»)
в нижнем регистре</entry>
<entry><literal>am</literal> или <literal>pm</literal></entry>
</row>
<row>
<entry><literal>A</literal></entry>
<entry>Ante meridiem или Post meridiem в верхнем регистре</entry>
<entry><literal>AM</literal> или <literal>PM</literal></entry>
</row>
<row>
<entry><literal>B</literal></entry>
<entry>Время в формате Интернет-времени (альтернативной системы отсчёта времени суток)</entry>
<entry>От <literal>000</literal> до <literal>999</literal></entry>
</row>
<row>
<entry><literal>g</literal></entry>
<entry>Часы в 12-часовом формате без ведущего нуля</entry>
<entry>От <literal>1</literal> до <literal>12</literal></entry>
</row>
<row>
<entry><literal>G</literal></entry>
<entry>Часы в 24-часовом формате без ведущего нуля</entry>
<entry>От <literal>0</literal> до <literal>23</literal></entry>
</row>
<row>
<entry><literal>h</literal></entry>
<entry>Часы в 12-часовом формате с ведущим нулём</entry>
<entry>От <literal>01</literal> до <literal>12</literal></entry>
</row>
<row>
<entry><literal>H</literal></entry>
<entry>Часы в 24-часовом формате с ведущим нулём</entry>
<entry>От <literal>00</literal> до <literal>23</literal></entry>
</row>
<row>
<entry><literal>i</literal></entry>
<entry>Минуты с ведущим нулём</entry>
<entry>От <literal>00</literal> до <literal>59</literal></entry>
</row>
<row>
<entry><literal>s</literal></entry>
<entry>Секунды с ведущим нулём</entry>
<entry>От <literal>00</literal> до <literal>59</literal></entry>
</row>
<row>
<entry><literal>u</literal></entry>
<entry>
Микросекунды. Учтите, что функция <function>date</function>
всегда будет возвращать значение <literal>000000</literal>, т. к. она принимает целочисленный (<type>int</type>)
параметр, тогда как метод <methodname>DateTime::format</methodname> поддерживает
микросекунды, если объект <classname>DateTime</classname> создан с ними.
</entry>
<entry>Например: <literal>654321</literal></entry>
</row>
<row>
<entry><literal>v</literal></entry>
<entry>
Миллисекунды. Замечание такое же, как и для
<literal>u</literal>.
</entry>
<entry>Пример: <literal>654</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Часовой пояс</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>e</literal></entry>
<entry>Идентификатор часового пояса</entry>
<entry>Примеры: <literal>UTC</literal>, <literal>GMT</literal>, <literal>Atlantic/Azores</literal></entry>
</row>
<row>
<entry><literal>I</literal> (заглавная i)</entry>
<entry>Признак летнего времени</entry>
<entry><literal>1</literal>, если дата соответствует летнему времени, <literal>0</literal> в противном случае</entry>
</row>
<row>
<entry><literal>O</literal></entry>
<entry>Разница со временем по Гринвичу без двоеточия между часами и минутами</entry>
<entry>Например: <literal>+0200</literal></entry>
</row>
<row>
<entry><literal>P</literal></entry>
<entry>Разница со временем по Гринвичу с двоеточием между часами и минутами</entry>
<entry>Например: <literal>+02:00</literal></entry>
</row>
<row>
<entry><literal>p</literal></entry>
<entry>
То же, что и <literal>P</literal>, но возвращает <literal>Z</literal> вместо <literal>+00:00</literal>
(доступен, начиная с PHP 8.0.0)
</entry>
<entry>Например: <literal>Z</literal> или <literal>+02:00</literal></entry>
</row>
<row>
<entry><literal>T</literal></entry>
<entry>Аббревиатура часового пояса, если известна; в противном случае смещение по Гринвичу.</entry>
<entry>Примеры: <literal>EST</literal>, <literal>MDT</literal>, <literal>+05</literal></entry>
</row>
<row>
<entry><literal>Z</literal></entry>
<entry>Смещение часового пояса в секундах. Для часовых поясов,
расположенных западнее UTC, возвращаются отрицательные числа,
а для расположенных восточнее UTC — положительные.</entry>
<entry>От <literal>-43200</literal> до <literal>50400</literal></entry>
</row>
<row>
<entry align="center"><emphasis>Полная дата/время</emphasis></entry>
<entry>---</entry>
<entry>---</entry>
</row>
<row>
<entry><literal>c</literal></entry>
<entry>Дата в формате стандарта ISO 8601</entry>
<entry>2004-02-12T15:19:21+00:00</entry>
</row>
<row>
<entry><literal>r</literal></entry>
<entry>Дата в формате <link xlink:href="&url.rfc;2822">RFC 222</link>/<link xlink:href="&url.rfc;5322">RFC 5322</link></entry>
<entry>Например: <literal>Thu, 21 Dec 2000 16:01:07 +0200</literal></entry>
</row>
<row>
<entry><literal>U</literal></entry>
<entry>Количество секунд, прошедших с начала Эпохи Unix (1 января 1970 00:00:00 GMT)</entry>
<entry>Смотрите также <function>time</function></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
Любые другие символы, встреченные в строке-шаблоне, будут выведены в результирующую
строку без изменений. <literal>Z</literal> всегда возвращает <literal>0</literal> при
использовании <function>gmdate</function>.
</para>
<note>
<para>
Поскольку эта функция принимает в качестве параметра
целочисленные (<type>int</type>) метки времени,
форматирующий символ <literal>u</literal> будет полезен
только при работе с функцией <function>date_format</function> и пользовательскими
метками времени, созданными функцией <function>date_create</function>.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает строку с отформатированной датой в случае успешного выполнения.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.2.0</entry>
<entry>
Добавлены символы форматирования <literal>X</literal> и <literal>x</literal>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Добавлен символ форматирования <literal>p</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>DateTimeInterface::format</function></title>
<para>&style.oop;</para>
<programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable('2000-01-01');
echo $date->format('Y-m-d H:i:s');
?>
]]>
</programlisting>
<para>&style.procedural;</para>
<programlisting role="php">
<![CDATA[
<?php
$date = date_create('2000-01-01');
echo date_format($date, 'Y-m-d H:i:s');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2000-01-01 00:00:00
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Больше примеров</title>
<programlisting role="php">
<![CDATA[
<?php
// установка часового пояса по умолчанию.
date_default_timezone_set('UTC');
// сейчас
$date = new DateTimeImmutable();
// Выведет что-то подобное: Wednesday
echo $date->format('l'), "\n";
// Выведет что-то подобное: Wednesday 19th of October 2022 08:40:48 AM
echo $date->format('l jS \o\f F Y h:i:s A'), "\n";
/* Использование констант в параметре format */
// Выведет что-то подобное: Wed, 19 Oct 2022 08:40:48 +0000
echo $date->format(DateTimeInterface::RFC2822), "\n";
?>
]]>
</programlisting>
</example>
</para>
<para>
Можно предотвратить расширение распознанного символа в строке формата,
экранировав его предшествующим обратным слешем.
Если символ с обратным слешем уже образует специальную последовательность,
его также может потребоваться экранировать.
<example>
<title>Экранирование символов во время форматирования</title>
<programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable();
// Выведет что-то подобное: Wednesday the 19th
echo $date->format('l \t\h\e jS');
?>
]]>
</programlisting>
</example>
</para>
<para>
Для форматирования дат на других языках, вместо метода <methodname>DateTimeInterface::format</methodname>
можно использовать метод <methodname>IntlDateFormatter::format</methodname>.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
Данный метод не использует настройки локали. Вывод производится на английском языке.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>date</function></member>
</simplelist>
</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
-->