archived-doc-ja/reference/datetime/datetimeimmutable/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<refentry xml:id="datetimeimmutable.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateTimeImmutable::__construct</refname>
  <refname>date_create_immutable</refname>
  <refpurpose>新しい DateTimeImmutable オブジェクトを返す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <constructorsynopsis role="DateTimeImmutable">
   <modifier>public</modifier> <methodname>DateTimeImmutable::__construct</methodname>
   <methodparam choice="opt"><type>string</type><parameter>datetime</parameter><initializer>"now"</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>DateTimeZone</type><type>null</type></type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
  </constructorsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>DateTimeImmutable</type><type>false</type></type><methodname>date_create_immutable</methodname>
   <methodparam choice="opt"><type>string</type><parameter>datetime</parameter><initializer>"now"</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>DateTimeZone</type><type>null</type></type><parameter>timezone</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   新しい DateTimeImmutable オブジェクトを返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>datetime</parameter></term>
    <listitem>
     <para>&date.formats.parameter;</para>
     <para>
      ここに <literal>"now"</literal> を指定して
      <parameter>$timezone</parameter> パラメータを使うと、現在時刻を取得できます。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timezone</parameter></term>
    <listitem>
     <para>
      <parameter>$datetime</parameter> のタイムゾーンを表す
      <classname>DateTimeZone</classname> オブジェクト。
     </para>
     <para>
      <parameter>$timezone</parameter> を省略した場合、
      または &null; の場合、
      現在のタイムゾーンを使います。
     </para>
     <note>
      <para>
       <parameter>$datetime</parameter> パラメータが UNIX タイムスタンプ
       (<literal>@946684800</literal> など)
       であったりタイムゾーン付きで指定した場合
       (<literal>2010-01-28T15:00:00+02:00</literal> や
       <literal>2010-07-05T06:00:00Z</literal> など) は、
       <parameter>$timezone</parameter> パラメータや現在のタイムゾーンは無視されます。
      </para>
     </note>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   新しい DateTimeImmutable のインスタンスを返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   無効な日付/時刻の文字列が渡された場合、
   <exceptionname>DateMalformedStringException</exceptionname> がスローされます。
   PHP 8.3 より前のバージョンでは、
   <exceptionname>Exception</exceptionname> がスローされていました。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        無効な文字列が渡された場合、
        <exceptionname>Exception</exceptionname> ではなく
        <exceptionname>DateMalformedStringException</exceptionname>
        がスローされるようになりました。
       </entry>
      </row>
      <row>
       <entry>7.1.0</entry>
       <entry>
        マイクロ秒が '00000' ではなく、実際の値で埋められるようになりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>DateTimeImmutable::__construct</function> の例</title>
   <para>&style.oop;</para>
   <programlisting role="php">
<![CDATA[
<?php
try {
    $date = new DateTimeImmutable('2000-01-01');
} catch (Exception $e) {
    echo $e->getMessage();
    exit(1);
}

echo $date->format('Y-m-d');
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
2000-01-01
]]>
   </screen>
   <para>&style.procedural;</para>
   <programlisting role="php">
<![CDATA[
<?php
$date = date_create('2000-01-01');
if (!$date) {
    $e = date_get_last_errors();
    foreach ($e['errors'] as $error) {
        echo "$error\n";
    }
    exit(1);
}

echo date_format($date, 'Y-m-d');
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
2000-01-01
]]>
   </screen>
  </example>
  <example>
   <title><function>DateTimeImmutable::__construct</function> の複雑な例</title>
   <programlisting role="php">
<![CDATA[
<?php
date_default_timezone_set('America/Jamaica');

// PHP のデフォルトのタイムゾーンでの日時の指定
$date = new DateTimeImmutable('2000-01-01');
echo $date->format('Y-m-d H:i:sP') . "\n";

// 指定したタイムゾーンでの日時の指定
$date = new DateTimeImmutable('2000-01-01', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";

// PHP のデフォルトのタイムゾーンでの現在日時
$date = new DateTimeImmutable();
echo $date->format('Y-m-d H:i:sP') . "\n";

// 指定したタイムゾーンでの現在日時
$date = new DateTimeImmutable('now', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";

// UNIX タイムスタンプの使用例。結果のタイムゾーンは UTC となることに注意しましょう。
$date = new DateTimeImmutable('@946684800');
echo $date->format('Y-m-d H:i:sP') . "\n";

// 存在しない値は繰り上がります
$date = new DateTimeImmutable('2000-02-30');
echo $date->format('Y-m-d H:i:sP') . "\n";
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
2000-01-01 00:00:00-05:00
2000-01-01 00:00:00+12:00
2010-04-24 10:24:16-04:00
2010-04-25 02:24:16+12:00
2000-01-01 00:00:00+00:00
2000-03-01 00:00:00-05:00
]]>
   </screen>
   <note>
    <para>
     繰り上がった日付は、
     <function>DateTimeImmutable::getLastErrors</function>
     の警告をチェックすることで検知できます。
    </para>
   </note>
  </example>

  <example>
   <title>関連付けられたタイムゾーンを変更する</title>
   <programlisting role="php">
<![CDATA[
<?php
$timeZone = new \DateTimeZone('Asia/Tokyo');

$time = new \DateTimeImmutable();
$time = $time->setTimezone($timeZone);

echo $time->format('Y/m/d H:i:s e'), "\n";
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
2022/08/12 23:49:23 Asia/Tokyo
]]>
   </screen>
  </example>

  <example>
   <title>相対日付/時刻 の文字列を使う</title>
   <programlisting role="php">
<![CDATA[
<?php
$time = new \DateTimeImmutable("-1 year");

echo $time->format('Y/m/d H:i:s'), "\n";
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
2021/08/12 15:43:51
]]>
   </screen>
  </example>
 </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
-->