php/archived-doc-ja
1
0
Fork 0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 15:12:22 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
archived-doc-ja/reference/datetime/functions/idate.xml
Yoshinari Takaoka 572dc61203 Enable runnable (WASM) examples for datetime 
3a8c3e77df
2025-11-01 00:38:03 +09:00

259 lines
7.7 KiB
XML
Raw Permalink Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: elf Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.idate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>idate</refname>
<refpurpose>ローカルな時刻/日付の一部を整数として整形する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>idate</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
指定された引数 <parameter>timestamp</parameter> を、
与えられたフォーマット文字列によりフォーマットし、日付数値を返します。
タイムスタンプが与えられない場合は、現在のローカル時刻が使われます。
つまり、<parameter>timestamp</parameter> はオプションであり、
そのデフォルト値は <function>time</function> の値です。
</para>
<para>
関数 <function>date</function> と異なり、<function>idate</function>
は <parameter>format</parameter> パラメータ中は一文字しか受け取りません。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<table>
<title>以下の文字が <parameter>format</parameter>
パラメータ文字列として認識されます</title>
<tgroup cols="2">
<thead>
<row>
<entry><parameter>format</parameter> 文字</entry>
<entry>説明</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>B</literal></entry>
<entry>Swatch ビート/インターネット時間</entry>
</row>
<row>
<entry><literal>d</literal></entry>
<entry>月の日</entry>
</row>
<row>
<entry><literal>h</literal></entry>
<entry>時 (12 時間単位)</entry>
</row>
<row>
<entry><literal>H</literal></entry>
<entry>時 (24 時間単位)</entry>
</row>
<row>
<entry><literal>i</literal></entry>
<entry>分</entry>
</row>
<row>
<entry><literal>I</literal> (大文字の i)</entry>
<entry>夏時間の適用中は <literal>1</literal>、
そうでなければ <literal>0</literal> を返す</entry>
</row>
<row>
<entry><literal>L</literal> (大文字の l)</entry>
<entry>閏年なら <literal>1</literal>、
そうでなければ <literal>0</literal> を返す</entry>
</row>
<row>
<entry><literal>N</literal></entry>
<entry>ISO-8601 形式の曜日
(<literal>1</literal> は月曜日で、
<literal>7</literal> が日曜日)</entry>
</row>
<row>
<entry><literal>o</literal></entry>
<entry>ISO-8601 形式の年 (4 桁の数値)</entry>
</row>
<row>
<entry><literal>m</literal></entry>
<entry>月数</entry>
</row>
<row>
<entry><literal>s</literal></entry>
<entry>秒</entry>
</row>
<row>
<entry><literal>t</literal></entry>
<entry>現在の月の日数</entry>
</row>
<row>
<entry><literal>U</literal></entry>
<entry>Unix Epoch (January 1 1970 00:00:00 UTC) からの秒数。
これは <function>time</function> と同じです</entry>
</row>
<row>
<entry><literal>w</literal></entry>
<entry>曜日 (日曜日は <literal>0</literal>)</entry>
</row>
<row>
<entry><literal>W</literal></entry>
<entry>ISO-8601 形式。月曜日から始まる年単位の週番号</entry>
</row>
<row>
<entry><literal>y</literal></entry>
<entry>年 (1 桁あるいは 2 桁の数値 - 下の「注意」を確認ください)</entry>
</row>
<row>
<entry><literal>Y</literal></entry>
<entry>年 (4 桁)</entry>
</row>
<row>
<entry><literal>z</literal></entry>
<entry>年間の通算日</entry>
</row>
<row>
<entry><literal>Z</literal></entry>
<entry>タイムゾーンのオフセット秒数</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
&date.timestamp.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
整数値を返します。
&return.falseforfailure;
</para>
<para>
<function>idate</function> が返す値の型は常に <type>int</type> であり、
先頭に "0" がくることはありません。そのため、<function>idate</function>
の返す結果が予想より少ない桁数になることもあります。以下の例を参照ください。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&date.timezone.errors.description;
</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.2.0</entry>
<entry>
フォーマット文字
<literal>N</literal> (ISO-8601 形式の曜日) と
<literal>o</literal> (ISO-8601 形式の年) が追加されました。
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>timestamp</parameter> は、nullable になりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>idate</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$timestamp = strtotime('1st January 2004'); // 1072915200
// これは、年を 2 桁で表示します。
// しかし、ここでは年が "0" から始まるので、
// "4" だけが表示されます。
echo idate('y', $timestamp) . "\n";
$timestamp = strtotime('1st January 2024'); // 1704067200
echo idate('y', $timestamp);
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
4
24
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DateTimeInterface::format</methodname></member>
<member><function>date</function></member>
<member><function>getdate</function></member>
<member><function>time</function></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
-->
Reference in New Issue View Git Blame Copy Permalink