Add DateTime::createFromImmutable docs

Patch provided by anonymous user.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347532 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2019-06-03 12:40:11 +00:00
parent 1cbdddb45b
commit 961158904b
2 changed files with 83 additions and 0 deletions

View file

@ -0,0 +1,82 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetime.createfromimmutable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTime::createFromImmutable</refname>
<refpurpose>Returns new DateTime object encapsulating the given DateTimeImmutable object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type>DateTime</type><methodname>DateTime::createFromImmutable</methodname>
<methodparam><type>DateTimeImmutable</type><parameter>datetime</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>datetime</parameter></term>
<listitem>
<para>
The immutable <classname>DateTimeImmutable</classname> object that you want to
convert to a mutable version. This object is not modified, but
instead a new <classname>DateTime</classname> object is
created containing the same date time and timezone information.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Creating a mutable date time object</title>
<programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable("2014-06-20 11:45 Europe/London");
$immutable = DateTime::createFromImmutable( $date );
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>DateTime</classname> instance.
</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
-->

View file

@ -11,6 +11,7 @@
<function name="datetime::__wakeup" from="PHP 5 >= 5.3.0, PHP 7"/>
<function name="datetime::add" from="PHP 5 &gt;= 5.3.0, PHP 7"/>
<function name="datetime::createfromformat" from="PHP 5 &gt;= 5.3.0, PHP 7"/>
<function name="datetime::createfromimmutable" from="PHP 7 &gt;= 7.3.0"/>
<function name="datetime::diff" from="PHP 5 &gt;= 5.3.0, PHP 7"/>
<function name="datetime::format" from="PHP 5 &gt;= 5.2.1, PHP 7"/>
<function name="datetime::getlasterrors" from="PHP 5 &gt;= 5.3.0, PHP 7"/>