mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 13:28:56 +00:00
91e836093c
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
358 lines
10 KiB
XML
358 lines
10 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<!-- splitted from ./en/functions/datetime.xml, last change in rev 1.2 -->
|
|
<refentry id="function.strftime">
|
|
<refnamediv>
|
|
<refname>strftime</refname>
|
|
<refpurpose>
|
|
Format a local time/date according to locale settings
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>strftime</methodname>
|
|
<methodparam><type>string</type><parameter>format</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>
|
|
timestamp
|
|
</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a string formatted according to the given format string
|
|
using the given <parameter>timestamp</parameter> or the current
|
|
local time if no timestamp is given. Month and weekday names and
|
|
other language dependent strings respect the current locale set
|
|
with <function>setlocale</function>.
|
|
</para>
|
|
<para>
|
|
The following conversion specifiers are recognized in the format
|
|
string:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
%a - abbreviated weekday name according to the current locale
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%A - full weekday name according to the current locale
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%b - abbreviated month name according to the current locale
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%B - full month name according to the current locale
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%c - preferred date and time representation for the current
|
|
locale
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%C - century number (the year divided by 100 and truncated to
|
|
an integer, range 00 to 99)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%d - day of the month as a decimal number (range 01 to 31)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%D - same as %m/%d/%y
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%e - day of the month as a decimal number, a single digit is
|
|
preceded by a space (range ' 1' to '31')
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%g - like %G, but without the century.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%G - The 4-digit year corresponding to the ISO week number (see %V).
|
|
This has the same format and value as %Y, except that if the ISO week
|
|
number belongs to the previous or next year, that year is used
|
|
instead.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%h - same as %b
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%H - hour as a decimal number using a 24-hour clock (range 00
|
|
to 23)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%I - hour as a decimal number using a 12-hour clock (range 01
|
|
to 12)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%j - day of the year as a decimal number (range 001 to 366)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%m - month as a decimal number (range 01 to 12)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%M - minute as a decimal number
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%n - newline character
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%p - either `am' or `pm' according to the given time value, or
|
|
the corresponding strings for the current locale
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%r - time in a.m. and p.m. notation
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%R - time in 24 hour notation
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%S - second as a decimal number
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%t - tab character
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%T - current time, equal to %H:%M:%S
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%u - weekday as a decimal number [1,7], with 1 representing
|
|
Monday
|
|
</simpara>
|
|
<warning>
|
|
<simpara>
|
|
Sun Solaris seems to start with Sunday as 1
|
|
although ISO 9889:1999 (the current C standard) clearly
|
|
specifies that it should be Monday.
|
|
</simpara>
|
|
</warning>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%U - week number of the current year as a decimal number,
|
|
starting with the first Sunday as the first day of the first
|
|
week
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%V - The ISO 8601:1988 week number of the current year as a
|
|
decimal number, range 01 to 53, where week 1 is the first
|
|
week that has at least 4 days in the current year, and with
|
|
Monday as the first day of the week. (Use %G or %g for the year
|
|
component that corresponds to the week number for the specified
|
|
timestamp.)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%W - week number of the current year as a decimal number,
|
|
starting with the first Monday as the first day of the first
|
|
week
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%w - day of the week as a decimal, Sunday being 0
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%x - preferred date representation for the current locale
|
|
without the time
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%X - preferred time representation for the current locale
|
|
without the date
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%y - year as a decimal number without a century (range 00 to
|
|
99)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%Y - year as a decimal number including the century
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%Z - time zone or name or abbreviation
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
%% - a literal `%' character
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<note>
|
|
<para>
|
|
Not all conversion specifiers may be supported by your C
|
|
library, in which case they will not be supported by PHP's
|
|
<function>strftime</function>. 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. %e, %T, %R and %D (there might be more) and dates prior to
|
|
<literal>Jan 1, 1970</literal> will not work on Windows, some Linux
|
|
distributions, and a few other operating systems. For Windows systems a
|
|
complete overview of supported conversion specifiers can be found at this
|
|
<ulink url="&url.strftime.win32;"><acronym>MSDN</acronym> website</ulink>.
|
|
</para>
|
|
</note>
|
|
<example>
|
|
<title><function>strftime</function> locale examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
setlocale(LC_TIME, "C");
|
|
echo strftime("%A");
|
|
setlocale(LC_TIME, "fi_FI");
|
|
echo strftime(" in Finnish is %A,");
|
|
setlocale(LC_TIME, "fr_FR");
|
|
echo strftime(" in French %A and");
|
|
setlocale(LC_TIME, "de_DE");
|
|
echo strftime(" in German %A.\n");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
This example works if you have the respective locales installed
|
|
in your system.
|
|
<note>
|
|
<simpara>
|
|
%G and %V, which are based on ISO 8601:1988 week numbers can
|
|
give unexpected (albeit correct) results if the numbering system
|
|
is not thoroughly understood. See %V above and example below.
|
|
</simpara>
|
|
</note>
|
|
<example>
|
|
<title>ISO 8601:1988 week number example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* December 2002 / January 2003
|
|
ISOWk M Tu W Thu F Sa Su
|
|
----- ----------------------------
|
|
51 16 17 18 19 20 21 22
|
|
52 23 24 25 26 27 28 29
|
|
1 30 31 1 2 3 4 5
|
|
2 6 7 8 9 10 11 12
|
|
3 13 14 15 16 17 18 19 */
|
|
|
|
// Outputs: 12/28/2002 - %V,%G,%Y = 52,2002,2002
|
|
echo "12/28/2002 - %V,%G,%Y = " . strftime("%V,%G,%Y", strtotime("12/28/2002")) . "\n";
|
|
|
|
// Outputs: 12/30/2002 - %V,%G,%Y = 1,2003,2002
|
|
echo "12/30/2002 - %V,%G,%Y = " . strftime("%V,%G,%Y", strtotime("12/30/2002")) . "\n";
|
|
|
|
// Outputs: 1/3/2003 - %V,%G,%Y = 1,2003,2003
|
|
echo "1/3/2003 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/3/2003")) . "\n";
|
|
|
|
// Outputs: 1/10/2003 - %V,%G,%Y = 2,2003,2003
|
|
echo "1/10/2003 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/10/2003")) . "\n";
|
|
|
|
|
|
|
|
/* December 2004 / January 2005
|
|
ISOWk M Tu W Thu F Sa Su
|
|
----- ----------------------------
|
|
51 13 14 15 16 17 18 19
|
|
52 20 21 22 23 24 25 26
|
|
53 27 28 29 30 31 1 2
|
|
1 3 4 5 6 7 8 9
|
|
2 10 11 12 13 14 15 16 */
|
|
|
|
// Outputs: 12/23/2004 - %V,%G,%Y = 52,2004,2004
|
|
echo "12/23/2004 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("12/23/2004")) . "\n";
|
|
|
|
// Outputs: 12/31/2004 - %V,%G,%Y = 53,2004,2004
|
|
echo "12/31/2004 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("12/31/2004")) . "\n";
|
|
|
|
// Outputs: 1/2/2005 - %V,%G,%Y = 53,2004,2005
|
|
echo "1/2/2005 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/2/2005")) . "\n";
|
|
|
|
// Outputs: 1/3/2005 - %V,%G,%Y = 1,2005,2005
|
|
echo "1/3/2005 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/3/2005")) . "\n";
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>setlocale</function>,
|
|
<function>mktime</function>, and the <ulink url="&spec.strftime;">
|
|
Open Group specification of
|
|
<function>strftime</function></ulink>.
|
|
</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
|
|
-->
|