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

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
  <refentry xml:id="function.strptime" xmlns="http://docbook.org/ns/docbook">
   <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> (LC_TIME).
    </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, or &false; on failure.
   </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>tm_sec</entry>
         <entry>Seconds after the minute (0-61)</entry>
        </row>
        <row>
         <entry>tm_min</entry>
         <entry>Minutes after the hour (0-59)</entry>
        </row>
        <row>
         <entry>tm_hour</entry>
         <entry>Hour since midnight (0-23)</entry>
        </row>
        <row>
         <entry>tm_mday</entry>
         <entry>Day of the month (1-31)</entry>
        </row>
        <row>
         <entry>tm_mon</entry>
         <entry>Months since January (0-11)</entry>
        </row>
        <row>
         <entry>tm_year</entry>
         <entry>Years since 1900</entry>
        </row>
        <row>
         <entry>tm_wday</entry>
         <entry>Days since Sunday (0-6)</entry>
        </row>
        <row>
         <entry>tm_yday</entry>
         <entry>Days since January 1 (0-365)</entry>
        </row>
        <row>
         <entry>unparsed</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;
     &note.no-windows;
    </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:"../../../../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
-->