<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.easter-date" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>easter_date</refname>

<refpurpose>指定した年におけるローカルの復活祭の真夜中のUnix時を得る</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>easter_date</methodname>

<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>year</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>CAL_EASTER_DEFAULT</constant></initializer></methodparam>

</methodsynopsis>

<para>

指定した年yearにおける復活祭の真夜中のUnix時を返します。

</para>

<para>

復活祭の日付は、西暦325年の Nicaea 会議で春分の日の後の

最初の満月の後の日曜日として定められました。

満月とその次の日曜日の日付の計算を簡単にするために

春分の日は常に3月21日になるとして計算されます。

ここで用いるアルゴリズムは、532年頃、Dionysius Exiguus により

導出されたものです。(1753年より前の年に関して)ユリウス暦の元では

月の周期を追うために簡単な19年周期が用いられます。グレゴリウス暦

(1753年以降。この暦は、ClaviusとLiliusにより考案され、

教皇グレゴリウス13世により1582年10月に導入、イギリス及びその植民地に

1752年9月に導入された。)

のもとで、二つの補正係数が周期をより正確に作成するために追加されました。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>year</parameter></term>

<listitem>

<para>

年の値。32ビットのシステムでは、

1970 から 2037 までである必要があります。

64ビットのシステムでは、

1970 から 2,000,000,000 までである必要があります。

省略した場合、もしくは &null; の場合は、

デフォルトとしてローカルタイムにおける現在の年を使います。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>mode</parameter></term>

<listitem>

<para>

<constant>CAL_EASTER_ALWAYS_JULIAN</constant> を設定すると、

ユリウス暦のカレンダをベースにして復活祭の日付が計算できます。

<link

linkend="calendar.constants">calendar の定数</link> を参照ください。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

復活祭の日を Unix タイムスタンプで返します。

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

32ビットのシステムでは、year の値が 1970 より前か 2037 より後の場合、

<classname>ValueError</classname> がスローされます。

64ビットのシステムでは、year の値が 1970 より前か 2,000,000,000 より後の場合、

<classname>ValueError</classname> がスローされます。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.3.0</entry>

<entry>

64ビットのシステムでは、

<parameter>year</parameter> の値として

1970 から 2,000,000,000 までの値を受け入れるようになりました。

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>year</parameter> は、nullable になりました。

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>year</parameter> が範囲外の値の場合、

<classname>ValueError</classname> がスローされるようになりました。

これより前のバージョンでは、

<constant>E_WARNING</constant> が発生して &false; を返していました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>easter_date</function> の例</title>

<programlisting role="php">

</programlisting>

</example>

<example>

<title><function>easter_date</function> を <classname>DateTime</classname> と一緒に使う</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

<function>easter_date</function> は、システムの C ライブラリの関数を利用します。

PHP 組み込みの日付・時刻関数を使うわけではなりません。

つまり、<function>easter_date</function> が利用するタイムゾーンは環境変数

<literal>TZ</literal> の値であり、PHP の

<link linkend="ini.date.timezone">デフォルトのタイムゾーン</link>は考慮しません。

その結果、PHP の他の日付関数と組み合わせて使ったときに予期せぬ結果になる可能性があります。

</para>

<para>

回避策として、<function>easter_days</function> を

<classname>DateTime</classname> や <classname>DateInterval</classname>

と組み合わせて使えば、PHP で設定したタイムゾーンにおける復活祭の開始時刻を算出できます。

</para>

<informalexample>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</informalexample>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member>

1970年以前または2037年以降の復活祭の計算に関しては、

<function>easter_days</function> を参照ください。

</member>

</simplelist>

</para>

</refsect1>

</refentry>