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

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5c951013ca04161992efed8b86fb40f55669958e 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>format</parameter>. Если аргумент
   <parameter>timestamp</parameter> задан, расчёт будет произведён для
   этой временной метки, если нет — будет использовано локальное время.
   Другими словами, метка времени <parameter>timestamp</parameter> — это необязательный
   аргумент и по умолчанию равен значению <function>time</function>.
  </para>
  <para>
   В отличие от функции <function>date</function>, функция <function>idate</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>Эталонное время/Время Интернета</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>, если активировано DST, или
            <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 - 1 января 1970 00:00:00 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> всегда возвращает тип
   <type>int</type> и не может начинаться с нуля, поэтому
   <function>idate</function> может вернуть меньше цифр, чем вы
   ожидаете. Смотрите примеры ниже.
  </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>
        Добавлены символы для параметра format:
        <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

// это выведет год в 2-х знаковом представлении
// поскольку первая цифра "0", будет выведено
// только "4"
echo idate('y', $timestamp);
?>
]]>
    </programlisting>
   </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
-->