gmstrftime.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gmstrftime" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gmstrftime</refname>
  <refpurpose>Format a GMT/UTC time/date according to locale settings</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-8-1-0.alternatives;
  <simplelist role="alternatives">
   <member><function>gmdate</function></member>
   <member><methodname>IntlDateFormatter::format</methodname></member>
  </simplelist>
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier role="attribute">#[\Deprecated(since: '8.1', message: 'use IntlDateFormatter::format() instead')]</modifier>
   <type class="union"><type>string</type><type>false</type></type><methodname>gmstrftime</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>
   Behaves the same as <function>strftime</function> except that the
   time returned is Greenwich Mean Time (GMT). For example, when run
   in Eastern Standard Time (GMT -0500), the first line below prints
   "Dec 31 1998 20:00:00", while the second prints "Jan 01 1999
   01:00:00".
  </para>
  <warning>
   <para>
    This function depends on operating system locale information, which might
    be inconsistent with each other, or not available at all. Instead use the
    <methodname>IntlDateFormatter::format</methodname> method.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       See description in <function>strftime</function>.
      </para>
     </listitem>
    </varlistentry>
    &date.timestamp.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a string formatted according to the given format string
   using the given <parameter>timestamp</parameter> or the current
   local time if no timestamp is given.  Month and weekday names and
   other language dependent strings respect the current locale set
   with <function>setlocale</function>.
   On failure, &false; is returned.
  </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.0.0</entry>
       <entry>
        <parameter>timestamp</parameter> is nullable now.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>gmstrftime</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php

setlocale(LC_TIME, 'es_ES.UTF-8');
date_default_timezone_set('EST');

echo strftime("%B %d %Y %H:%M:%S",   mktime(20, 0, 0, 12, 31, 98)) . "\n";
echo gmstrftime("%B %d %Y %H:%M:%S", mktime(20, 0, 0, 12, 31, 98));
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
Deprecated: Function strftime() is deprecated since 8.1, use IntlDateFormatter::format() instead in script on line 6
diciembre 31 1998 20:00:00

Deprecated: Function gmstrftime() is deprecated since 8.1, use IntlDateFormatter::format() instead in script on line 7
enero 01 1999 01:00:00
]]>
   </screen>
  </example>
 </refsect1>

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