Document createFromMutable.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333754 c90b9560-bf6c-de11-be94-00142212c4b1

reference/datetime/datetimeimmutable/createfrommutable.xml

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

reference/datetime/versions.xml

@@ -32,6 +32,7 @@
  <function name='datetimeimmutable::__construct' from='PHP 5 &gt;= 5.5.0'/>
  <function name='datetimeimmutable::__set_state' from='PHP 5 &gt;= 5.5.0'/>
  <function name='datetimeimmutable::createfromformat' from='PHP 5 &gt;= 5.5.0'/>
+ <function name='datetimeimmutable::createfrommutable' from='PHP 5 &gt;= 5.6.0'/>
  <function name='datetimeimmutable::getlasterrors' from='PHP 5 &gt;= 5.5.0'/>
  <function name='datetimeimmutable::modify' from='PHP 5 &gt;= 5.5.0'/>
  <function name='datetimeimmutable::add' from='PHP 5 &gt;= 5.5.0'/>