php-doc-en/reference/datetime/functions/gmmktime.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gmmktime" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gmmktime</refname>
  <refpurpose>Get Unix timestamp for a GMT date</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>gmmktime</methodname>
   <methodparam choice="opt"><type>int</type><parameter>hour</parameter><initializer>gmdate("H")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>minute</parameter><initializer>gmdate("i")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>gmdate("s")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>month</parameter><initializer>gmdate("n")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>day</parameter><initializer>gmdate("j")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>year</parameter><initializer>gmdate("Y")</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>isDST</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para>
   Identical to <function>mktime</function> except the passed parameters represents a 
   GMT date. <function>gmmktime</function> internally uses <function>mktime</function>
   so only times valid in derived local time can be used.
  </para>
  <para>
   Like <function>mktime</function>, arguments may be left out in order
   from right to left, with any omitted arguments being set to the
   current corresponding GMT value.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hour</parameter></term>
     <listitem>
      <para>
       The number of the hour relative to the start of the day determined by
       <parameter>month</parameter>, <parameter>day</parameter> and <parameter>year</parameter>.
       Negative values reference the hour before midnight of the day in question.
       Values greater than 23 reference the appropriate hour in the following day(s).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>minute</parameter></term>
     <listitem>
      <para>
       The number of the minute relative to the start of the <parameter>hour</parameter>.
       Negative values reference the minute in the previous hour.
       Values greater than 59 reference the appropriate minute in the following hour(s).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>second</parameter></term>
     <listitem>
      <para>
       The number of seconds relative to the start of the <parameter>minute</parameter>.
       Negative values reference the second in the previous minute.
       Values greater than 59 reference the appropriate second in the following minute(s).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>month</parameter></term>
     <listitem>
      <para>
       The number of the month relative to the end of the previous year.
       Values 1 to 12 reference the normal calendar months of the year in question.
       Values less than 1 (including negative values) reference the months in the previous year in reverse order, so 0 is December, -1 is November, etc.
       Values greater than 12 reference the appropriate month in the following year(s).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>day</parameter></term>
     <listitem>
      <para>
       The number of the day relative to the end of the previous month.
       Values 1 to 28, 29, 30 or 31 (depending upon the month) reference the normal days in the relevant month.
       Values less than 1 (including negative values) reference the days in the previous month, so 0 is the last day of the previous month, -1 is the day before that, etc.
       Values greater than the number of days in the relevant month reference the appropriate day in the following month(s).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>year</parameter></term>
     <listitem>
      <para>
       The year
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>isDST</parameter></term>
     <listitem>
      <para>
       Parameters always represent a GMT date so <parameter>isDST</parameter>
       doesn't influence the result.
      </para>
      <note>
       <para>
        This parameter has been removed in PHP 7.0.0.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a <type>int</type> Unix timestamp.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gmmktime</function> basic example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Prints: July 1, 2000 is on a Saturday
echo "July 1, 2000 is on a " . date("l", gmmktime(0, 0, 0, 7, 1, 2000));
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mktime</function></member>
    <member><function>date</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
-->