php-doc-en/reference/datetime/functions/strtotime.xml
Dave Barr 91e836093c - Standardize the Unix acronym. Unix is the preferred capitalization
as UNIX is a registered trademark by the Open Group. References to UNIX
  were left in where it made sense, like example outputs, and so forth.
  You can read the Trademark User Guide for "UNIX" at:
  http://www.unix.org/tmug2.ps or http://www.unix.org/tmug2.pdf


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147067 c90b9560-bf6c-de11-be94-00142212c4b1
2003-12-21 04:22:00 +00:00

101 lines
3.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/datetime.xml, last change in rev 1.8 -->
<refentry id="function.strtotime">
<refnamediv>
<refname>strtotime</refname>
<refpurpose>
Parse about any English textual datetime description into a Unix
timestamp
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>strtotime</methodname>
<methodparam><type>string</type><parameter>time</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>now</parameter></methodparam>
</methodsynopsis>
<simpara>
The function expects to be given a string containing an English date
format and will try to parse that format into a Unix timestamp relative
to the timestamp given in <parameter>now</parameter>, or the current time
if none is supplied. Upon failure, <literal>-1</literal> is returned.
</simpara>
<simpara>
Because <function>strtotime</function> behaves according to GNU
date syntax, have a look at the GNU manual page titled
<ulink url="&url.gnu.man.date-input;">Date Input Formats</ulink>.
Described there is valid syntax for the <parameter>time</parameter>
parameter.
</simpara>
<para>
<example>
<title><function>strtotime</function> examples</title>
<programlisting role="php">
<![CDATA[
<?php
echo strtotime("now"), "\n";
echo strtotime("10 September 2000"), "\n";
echo strtotime("+1 day"), "\n";
echo strtotime("+1 week"), "\n";
echo strtotime("+1 week 2 days 4 hours 2 seconds"), "\n";
echo strtotime("next Thursday"), "\n";
echo strtotime("last Monday"), "\n";
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Checking for failure</title>
<programlisting role="php">
<![CDATA[
<?php
$str = 'Not Good';
if (($timestamp = strtotime($str)) === -1) {
echo "The string ($str) is bogus";
} else {
echo "$str == " . date('l dS of F Y h:i:s A', $timestamp);
}
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
The valid range of a timestamp is typically from Fri, 13 Dec
1901 20:45:54 GMT to Tue, 19 Jan 2038 03:14:07 GMT. (These are
the dates that correspond to the minimum and maximum values for
a 32-bit signed integer.)
Additionally, not all platforms support negative timestamps, therefore
your date range may be limited to no earlier than the Unix epoch. This
means that e.g. dates prior to Jan 1, 1970 will not work on Windows,
some Linux distributions, and a few other operating systems.
</para>
</note>
</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
-->