localtime.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 8ddf539e5993e427cb1385c5a01b6d2ce971b418 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="intldateformatter.localtime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlDateFormatter::localtime</refname>
  <refname>datefmt_localtime</refname>
  <refpurpose>Разбирает строку на отдельные составляющие времени, которые возвращает в ассоциативном массиве</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="IntlDateFormatter">
   <modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>IntlDateFormatter::localtime</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">offset</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>datefmt_localtime</methodname>
   <methodparam><type>IntlDateFormatter</type><parameter>formatter</parameter></methodparam>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">offset</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция преобразовывает строку $value в массив полей, каждое из которых представляет отдельный компонент времени.
   Функция начинает с позиции, которую определили в параметре $parse_pos, с захватом как можно большей части входного значения.
  </para>
  </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>formatter</parameter></term>
     <listitem>
      <para>
       Средство форматирования.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Строка, которую требуется преобразовать в массив отдельных составляющих времени.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Позиция, с которой функция начнёт разбор значения $value, в котором индексация символов начинается с нуля.
       Функция присвоит параметру $parse_pos значение -1, если до конца разбора строки $value не возникло ошибок,
       иначе присвоит позицию, на которой закончился синтаксический анализ.
       Разбор немедленно завершается ошибкой,
       если выполняется условие выражения $parse_pos &gt; <code>strlen($value)</code>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает массив целочисленных значений. Структура массива совместима с форматом представления местного времени функцией localtime:
   содержит 24-часовое значение в поле tm_hour&return.falseforfailure;.
   </para>
 </refsect1>

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

$fmt = datefmt_create(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);

$arr = datefmt_localtime($fmt, 'Wednesday, December 31, 1969 at 4:00:00 PM Pacific Standard Time', $offset);

echo 'Результат разбора: ';
if ($arr) {
    foreach ($arr as $key => $value) {
        echo "$key : $value, ";
    }
}

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Пример использования в объектно-ориентированном стиле</title>
    <programlisting role="php">
<![CDATA[
<?php

$fmt = new IntlDateFormatter(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);

$arr = $fmt->localtime('Wednesday, December 31, 1969 at 4:00:00 PM Pacific Standard Time', $offset);

echo 'Результат разбора: ';
if ($arr) {
    foreach ($arr as $key => $value) {
        echo "$key: $value, ";
    }
}

?>
]]>
    </programlisting>
   </example>
     &example.outputs;
     <screen>
<![CDATA[
Результат разбора: tm_sec: 0, tm_min: 0, tm_hour: 16, tm_year: 69, tm_mday: 31, tm_wday: 3, tm_yday: 365, tm_mon: 11, tm_isdst: 0,
]]>
     </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
    <simplelist>
    <member><function>datefmt_create</function></member>
    <member><function>datefmt_format</function></member>
    <member><function>datefmt_parse</function></member>
    <member><function>datefmt_get_error_code</function></member>
    <member><function>datefmt_get_error_message</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
-->