php-doc-en/reference/datetime/functions/getdate.xml
Nuno Lopes bd57b3fc03 fix : wrong yday range
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@162668 c90b9560-bf6c-de11-be94-00142212c4b1
2004-07-05 10:23:02 +00:00

157 lines
4.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/datetime.xml, last change in rev 1.2 -->
<refentry id="function.getdate">
<refnamediv>
<refname>getdate</refname>
<refpurpose>Get date/time information</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>getdate</methodname>
<methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative <type>array</type> containing the date
information of the <parameter>timestamp</parameter>, or the current
local time if no <parameter>timestamp</parameter> is given, as the
following associative array elements:
</para>
<para>
<table>
<title>Key elements of the returned associative array</title>
<tgroup cols="3">
<thead>
<row>
<entry>Key</entry>
<entry>Description</entry>
<entry>Example returned values</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>"seconds"</literal></entry>
<entry>Numeric representation of seconds</entry>
<entry><literal>0</literal> to <literal>59</literal></entry>
</row>
<row>
<entry><literal>"minutes"</literal></entry>
<entry>Numeric representation of minutes</entry>
<entry><literal>0</literal> to <literal>59</literal></entry>
</row>
<row>
<entry><literal>"hours"</literal></entry>
<entry>Numeric representation of hours</entry>
<entry><literal>0</literal> to <literal>23</literal></entry>
</row>
<row>
<entry><literal>"mday"</literal></entry>
<entry>Numeric representation of the day of the month</entry>
<entry><literal>1</literal> to <literal>31</literal></entry>
</row>
<row>
<entry><literal>"wday"</literal></entry>
<entry>Numeric representation of the day of the week</entry>
<entry><literal>0</literal> (for Sunday) through <literal>6</literal> (for Saturday)</entry>
</row>
<row>
<entry><literal>"mon"</literal></entry>
<entry>Numeric representation of a month</entry>
<entry><literal>1</literal> through <literal>12</literal></entry>
</row>
<row>
<entry><literal>"year"</literal></entry>
<entry>A full numeric representation of a year, 4 digits</entry>
<entry>Examples: <literal>1999</literal> or <literal>2003</literal></entry>
</row>
<row>
<entry><literal>"yday"</literal></entry>
<entry>Numeric representation of the day of the year</entry>
<entry><literal>0</literal> through <literal>365</literal></entry>
</row>
<row>
<entry><literal>"weekday"</literal></entry>
<entry>A full textual representation of the day of the week</entry>
<entry><literal>Sunday</literal> through <literal>Saturday</literal></entry>
</row>
<row>
<entry><literal>"month"</literal></entry>
<entry>A full textual representation of a month, such as January or March</entry>
<entry><literal>January</literal> through <literal>December</literal></entry>
</row>
<row>
<entry><literal>0</literal></entry>
<entry>Seconds since the Unix Epoch, similar to the values returned by
<function>time</function> and used by <function>date</function>.</entry>
<entry>System Dependent, typically <literal>-2147483648</literal> through
<literal>2147483647</literal>.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<example>
<title>
<function>getdate</function> example
</title>
<programlisting role="php">
<![CDATA[
<?php
$today = getdate();
print_r($today);
?>
]]>
</programlisting>
<para>
The output will look similar to:
</para>
<screen>
<![CDATA[
Array
(
[seconds] => 40
[minutes] => 58
[hours] => 21
[mday] => 17
[wday] => 2
[mon] => 6
[year] => 2003
[yday] => 167
[weekday] => Tuesday
[month] => June
[0] => 1055901520
)
]]>
</screen>
</example>
</para>
<para>
See also <function>date</function>,
<function>time</function>, and
<function>setlocale</function>.
</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:"../../../../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
-->