archived-doc-ru/reference/datetime/functions/idate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.idate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>idate</refname>
  <refpurpose>Форматирует компонент даты или времени местного часового пояса как целое число</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>idate</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция обрабатывает значение параметра <parameter>timestamp</parameter>
   или получает метку текущего системного времени, если параметр опустили,
   и возвращает целочисленное значение компонента даты или времени в заданном формате.
   Поэтому параметр <parameter>timestamp</parameter> необязателен
   и по умолчанию равен значению, которое возвращает функция <function>time</function>.
  </para>
  <para>
   Функция <function>idate</function>, в отличие от функции <function>date</function>,
   принимает только один символ в аргументе <parameter>format</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       <table>
        <title>
         Допустимые символы в строке аргумента <parameter>format</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Символ в аргументе <parameter>format</parameter></entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>B</literal></entry>
           <entry>«Бит» времени в системе Swatch, или интернет-время</entry>
          </row>
          <row>
           <entry><literal>d</literal></entry>
           <entry>День месяца</entry>
          </row>
          <row>
           <entry><literal>h</literal></entry>
           <entry>Час в 12-часовом формате</entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>Час в 24-часовом формате</entry>
          </row>
          <row>
           <entry><literal>i</literal></entry>
           <entry>Минуты</entry>
          </row>
          <row>
           <entry><literal>I</literal> (i в верхнем регистре)</entry>
           <entry>
            Возвращает <literal>1</literal>, если действует летнее время,
            иначе <literal>0</literal>
           </entry>
          </row>
          <row>
           <entry><literal>L</literal> (l в верхнем регистре)</entry>
           <entry>
            Возвращает <literal>1</literal> для високосного года,
            иначе <literal>0</literal>
           </entry>
          </row>
          <row>
           <entry><literal>m</literal></entry>
           <entry>Номер месяца</entry>
          </row>
          <row>
           <entry><literal>N</literal></entry>
           <entry>
            День недели по стандарту ISO-8601, где <literal>1</literal> — понедельник,
            а <literal>7</literal> — воскресенье
           </entry>
          </row>
          <row>
           <entry><literal>o</literal></entry>
           <entry>Год по стандарту ISO-8601 — 4 цифры</entry>
          </row>
          <row>
           <entry><literal>s</literal></entry>
           <entry>Секунды</entry>
          </row>
          <row>
           <entry><literal>t</literal></entry>
           <entry>Количество дней в текущем месяце</entry>
          </row>
          <row>
           <entry><literal>U</literal></entry>
           <entry>
            Время в секундах с начала эпохи Unix — 00:00:00 1 января 1970 по времени UTC,
            аналогично значению, которое возвращает функция <function>time</function>
           </entry>
          </row>
          <row>
           <entry><literal>w</literal></entry>
           <entry>День недели, где <literal>0</literal> — воскресенье</entry>
          </row>
          <row>
           <entry><literal>W</literal></entry>
           <entry>Номер недели года по стандарту ISO-8601, неделя начинается с понедельника</entry>
          </row>
          <row>
           <entry><literal>y</literal></entry>
           <entry>Год в 1- или 2-значном формате, см. примечание в примере</entry>
          </row>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>Год в 4-значном формате</entry>
          </row>
          <row>
           <entry><literal>z</literal></entry>
           <entry>День года</entry>
          </row>
          <row>
           <entry><literal>Z</literal></entry>
           <entry>Смещение времени часового пояса в секундах</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>

    &date.timestamp.description;

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает значение <type>int</type>, если выполнилась успешно,&return.falseforfailure;.
  </para>
  <para>
   Функция <function>idate</function> иногда возвращает значение,
   разрядность которого меньшей ожидаемой, поскольку функция <function>idate</function>
   возвращает только значения <type>int</type>, которым нельзя начинаться с нуля.
   См. пример.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;

   &date.timezone.errors.description;

 </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.2.0</entry>
       <entry>
        Добавили символы форматирования:
        <literal>N</literal> — день недели по стандарту ISO-8601
        и <literal>o</literal> — год по стандарту ISO-8601.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Параметр <parameter>timestamp</parameter> теперь принимает значение &null;.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример форматирования компонента даты или времени функцией <function>idate</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$timestamp = strtotime('1st January 2004'); // 1072915200

// Символ 'y' форматирует год в 2-значном формате,
// но поскольку год выводился бы с символа 0,
// код выведет только цифру 4
echo idate('y', $timestamp) . "\n";

$timestamp = strtotime('1st January 2024'); // 1704067200
echo idate('y', $timestamp);
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
4
24
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DateTimeInterface::format</methodname></member>
    <member><function>date</function></member>
    <member><function>getdate</function></member>
    <member><function>time</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
-->