1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 290987 $ -->
<refentry xml:id="function.strptime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>strptime</refname>
<refpurpose>
Parse a time/date generated with <function>strftime</function>
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>strptime</methodname>
<methodparam><type>string</type><parameter>date</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
<function>strptime</function> returns an array with the
<parameter>date</parameter> parsed, or &false; on error.
</para>
<para>
Month and weekday names and other language dependent strings respect the
current locale set with <function>setlocale</function> (<constant>LC_TIME</constant>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>date</parameter> (<type>string</type>)</term>
<listitem>
<para>
The string to parse (e.g. returned from <function>strftime</function>)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter> (<type>string</type>)</term>
<listitem>
<para>
The format used in <parameter>date</parameter> (e.g. the same as
used in <function>strftime</function>).
</para>
<para>
For more information about the format options, read the
<function>strftime</function> page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array&return.falseforfailure;.
</para>
<para>
<table>
<title>The following parameters are returned in the array</title>
<tgroup cols="2">
<thead>
<row>
<entry>parameters</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>"tm_sec"</literal></entry>
<entry>Seconds after the minute (0-61)</entry>
</row>
<row>
<entry><literal>"tm_min"</literal></entry>
<entry>Minutes after the hour (0-59)</entry>
</row>
<row>
<entry><literal>"tm_hour"</literal></entry>
<entry>Hour since midnight (0-23)</entry>
</row>
<row>
<entry><literal>"tm_mday"</literal></entry>
<entry>Day of the month (1-31)</entry>
</row>
<row>
<entry><literal>"tm_mon"</literal></entry>
<entry>Months since January (0-11)</entry>
</row>
<row>
<entry><literal>"tm_year"</literal></entry>
<entry>Years since 1900</entry>
</row>
<row>
<entry><literal>"tm_wday"</literal></entry>
<entry>Days since Sunday (0-6)</entry>
</row>
<row>
<entry><literal>"tm_yday"</literal></entry>
<entry>Days since January 1 (0-365)</entry>
</row>
<row>
<entry><literal>"unparsed"</literal></entry>
<entry>the <parameter>date</parameter> part which was not
recognized using the specified <parameter>format</parameter></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>strptime</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$format = '%d/%m/%Y %H:%M:%S';
$strf = strftime($format);
echo "$strf\n";
print_r(strptime($strf, $format));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
03/10/2004 15:54:19
Array
(
[tm_sec] => 19
[tm_min] => 54
[tm_hour] => 15
[tm_mday] => 3
[tm_mon] => 9
[tm_year] => 104
[tm_wday] => 0
[tm_yday] => 276
[unparsed] =>
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
¬e.no-windows;
<note>
<para>
<literal>"tm_sec"</literal> includes any leap seconds (currently upto 2
a year). For more information on leap seconds, see the <link
xlink:href="&url.wiki.leap-seconds;">Wikipedia article
on leap seconds</link>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<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
-->
|