mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
e41806c30b
Document false and null return types Cf. <https://news-web.php.net/php.doc.cvs/17645>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351730 c90b9560-bf6c-de11-be94-00142212c4b1
126 lines
3.2 KiB
XML
126 lines
3.2 KiB
XML
<?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>
|
||
<modifier>public</modifier> <type>DateTime</type><methodname>IntlCalendar::toDateTime</methodname>
|
||
<void />
|
||
</methodsynopsis>
|
||
<para>
|
||
&style.procedural;
|
||
</para>
|
||
<methodsynopsis>
|
||
<type>DateTime</type><methodname>intlcal_to_date_time</methodname>
|
||
<methodparam><type>IntlCalendar</type><parameter>cal</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>cal</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
The IntlCalendar resource.
|
||
</para>
|
||
</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
|
||
-->
|