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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlcalendar.todatetime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::toDateTime</refname>
<refpurpose>Convert an IntlCalendar into a DateTime object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis role="IntlCalendar">
<modifier>public</modifier> <type class="union"><type>DateTime</type><type>false</type></type><methodname>IntlCalendar::toDateTime</methodname>
<void/>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type class="union"><type>DateTime</type><type>false</type></type><methodname>intlcal_to_date_time</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
</methodsynopsis>
<para>
Create a <classname>DateTime</classname> object that represents the same
instant (up to second precision, with a rounding error of less than 1
second) and has an analog timezone to this object (the difference being
<classname>DateTime</classname>ʼs timezone will be backed by PHPʼs timezone
while <classname>IntlCalendar</classname>ʼs timezone is backed by ICUʼs).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
&intl.parameter.intl-calendar;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A <classname>DateTime</classname> object with the same timezone as this
object (though using PHPʼs database instead of ICUʼs) and the same time,
except for the smaller precision (second precision instead of millisecond).
Returns &false; on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>IntlCalendar::toDateTime</function></title>
<programlisting role="php">
<![CDATA[
<?php
ini_set('date.timezone', 'UTC');
ini_set('intl.default_locale', 'pt_PT');
$cal = IntlCalendar::createInstance('Europe/Lisbon'); //current time
$dt = $cal->toDateTime();
print_r($dt);
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
DateTime Object
(
[date] => 2013-07-02 00:29:13
[timezone_type] => 3
[timezone] => Europe/Lisbon
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>IntlCalendar::fromDateTime</methodname></member>
<member><methodname>IntlCalendar::getTime</methodname></member>
<member><methodname>IntlCalendar::createInstance</methodname></member>
<member><methodname>DateTime::__construct</methodname></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
-->
|