php-doc-en/reference/datetime/functions/date-format.xml
Ross Masters cd04e752b9 Added entities for procedural-only object parameters for DateTime and DateTimeZone.
&date.datetime.description:  date_* (except date_default_timezone_*, date_create)
    &date.datetimezone.description: timezone_*

Added examples for:
    reference\datetime\functions
        date-create.xml
        date-date-set.xml
        date-default-timezone-get.xml
        date-default-timezone-set.xml
        date-format.xml
        date-isodate-set.xml
        date-offset-get.xml
        date-time-set.xml
        date-timezone-get.xml
        date-timezone-set.xml

Added descriptions for:
    reference\datetime\functions
        date-create.xml
        date-date-set.xml
        date-isodate-set.xml
        date-modify.xml
        date-time-set.xml


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@268162 c90b9560-bf6c-de11-be94-00142212c4b1
2008-11-02 22:11:33 +00:00

119 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.date-format" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>date_format</refname>
<refpurpose>Returns date formatted according to given format</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>date_format</methodname>
<methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>DateTime::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&date.datetime.description;
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Format accepted by <function>date</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns formatted date on success or &false; on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Displaying the date and time using the procedural form</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('Europe/London');
$datetime = date_create('2008-08-03 14:52:10');
echo date_format($datetime, 'jS, F Y') . "\n";
echo date_format($datetime, DATE_ATOM);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Displaying the date and time using the object oriented form</title>
<programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('Europe/London');
$datetime = new DateTime('2008-08-03 14:52:10');
echo $datetime->format('jS, F Y') . "\n";
echo $datetime->format(DATE_ATOM);
?>
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
3rd, August 2008
2008-08-03T14:52:10+01:00
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>date</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
-->