svn: /phpdoc/ja/trunk/reference/session/ functions/session-cache-expire.xml functions/session-cache-limiter.xml functions/session-create-id.xml functions/session-encode.xml functions/session-gc.xml functions/session-id.xml functions/session-module-name.xml functions/session-name.xml functions/session-save-path.xml functions/session-set-cookie-params.xml functions/session-start.xml functions/session-status.xml sessionhandler/destroy.xml sessionhandler/gc.xml sessionhandler/open.xml sessionhandler
[email protected] (Yoshinari Takaoka)
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
mumumu Mon, 30 Nov 2020 01:46:59 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=351763
Log:
Generate session methodsynopses based on stubs
Closes GH-236.
Changed paths:
U phpdoc/ja/trunk/reference/session/functions/session-cache-expire.xml
U phpdoc/ja/trunk/reference/session/functions/session-cache-limiter.xml
U phpdoc/ja/trunk/reference/session/functions/session-create-id.xml
U phpdoc/ja/trunk/reference/session/functions/session-encode.xml
U phpdoc/ja/trunk/reference/session/functions/session-gc.xml
U phpdoc/ja/trunk/reference/session/functions/session-id.xml
U phpdoc/ja/trunk/reference/session/functions/session-module-name.xml
U phpdoc/ja/trunk/reference/session/functions/session-name.xml
U phpdoc/ja/trunk/reference/session/functions/session-save-path.xml
U phpdoc/ja/trunk/reference/session/functions/session-set-cookie-params.xml
U phpdoc/ja/trunk/reference/session/functions/session-start.xml
U phpdoc/ja/trunk/reference/session/functions/session-status.xml
U phpdoc/ja/trunk/reference/session/sessionhandler/destroy.xml
U phpdoc/ja/trunk/reference/session/sessionhandler/gc.xml
U phpdoc/ja/trunk/reference/session/sessionhandler/open.xml
U phpdoc/ja/trunk/reference/session/sessionhandler/read.xml
U phpdoc/ja/trunk/reference/session/sessionhandler/write.xml
U phpdoc/ja/trunk/reference/session/sessionhandlerinterface/close.xml
U phpdoc/ja/trunk/reference/session/sessionhandlerinterface/destroy.xml
U phpdoc/ja/trunk/reference/session/sessionhandlerinterface/gc.xml
U phpdoc/ja/trunk/reference/session/sessionhandlerinterface/open.xml
U phpdoc/ja/trunk/reference/session/sessionhandlerinterface/read.xml
U phpdoc/ja/trunk/reference/session/sessionhandlerinterface/write.xml
U phpdoc/ja/trunk/reference/session/sessionidinterface/create-sid.xml
U phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/updatetimestamp.xml
U phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/validateid.xml
svn-diffs-351763.txt
(text/x-diff, 56.3 KB)
Modified: phpdoc/ja/trunk/reference/session/functions/session-cache-expire.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-cache-expire.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-cache-expire.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 350930 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.session-cache-expire'>
<refnamediv>
@@ -11,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>int</type><methodname>session_cache_expire</methodname>
- <methodparam choice="opt"><type>string</type><parameter>new_cache_expire</parameter></methodparam>
+ <type class="union"><type>int</type><type>false</type></type><methodname>session_cache_expire</methodname>
+ <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_cache_expire</function> は現在の
@@ -33,12 +33,12 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>new_cache_expire</parameter></term>
+ <term><parameter>value</parameter></term>
<listitem>
<para>
- <parameter>new_cache_expire</parameter> が指定された場合、
+ <parameter>value</parameter> が指定され、&null; でない場合、
現在のキャッシュの有効期限は、
- <parameter>new_cache_expire</parameter> で置換されます。
+ <parameter>value</parameter> で置換されます。
</para>
<para>
<note>
@@ -45,7 +45,7 @@
<simpara>
<literal>session.cache_limiter</literal>が
<literal>nocache</literal><emphasis>以外の</emphasis>値にセットされている場合にのみ
- <parameter>new_cache_expire</parameter>が有効となります。
+ <parameter>value</parameter>が有効となります。
</simpara>
</note>
</para>
@@ -60,9 +60,32 @@
<para>
<literal>session.cache_expire</literal> の現在の設定を返します。
返り値は分単位で、デフォルトは 180 です。
+ 値の変更に失敗した場合は、&false; を返します。
</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.0.0</entry>
+ <entry>
+ <parameter>value</parameter> は、nullable になりました。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -106,7 +129,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-cache-limiter.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-cache-limiter.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-cache-limiter.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,7 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 334605 Maintainer: hirokawa Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-cache-limiter">
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.session-cache-limiter" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_cache_limiter</refname>
<refpurpose>現在のキャッシュリミッタを取得または設定する</refpurpose>
@@ -10,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_cache_limiter</methodname>
- <methodparam choice="opt"><type>string</type><parameter>cache_limiter</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_cache_limiter</methodname>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_cache_limiter</function> は、
@@ -53,11 +54,12 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>cache_limiter</parameter></term>
+ <term><parameter>value</parameter></term>
<listitem>
<para>
- <parameter>cache_limiter</parameter>
- が指定された場合、現在のキャッシュリミッタは新しい値に変更されます。
+ <parameter>value</parameter>
+ が指定され、&null; でない場合、
+ 現在のキャッシュリミッタは新しい値に変更されます。
</para>
<table>
<title>取り得る値</title>
@@ -129,9 +131,32 @@
&reftitle.returnvalues;
<para>
現在のキャッシュリミッタの名前を返します。
+ 値の変更に失敗した場合は、&false; を返します。
</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.0.0</entry>
+ <entry>
+ <parameter>value</parameter> は、nullable になりました。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -164,7 +189,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-create-id.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-create-id.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-create-id.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 346848 Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: mumumu Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-create-id">
+<refentry xml:id="function.session-create-id" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_create_id</refname>
<refpurpose>新しいセッションIDを作成する</refpurpose>
@@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_create_id</methodname>
- <methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_create_id</methodname>
+ <methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_create_id</function> 関数は、
@@ -59,6 +59,7 @@
現在のセッションのための、衝突しない新しいセッションIDを返します。
セッションがアクティブでない時に使われると、
衝突しているかどうかのチェックは省略されます。
+ 失敗した場合は、&false; を返します。
</para>
</refsect1>
@@ -137,8 +138,6 @@
</para>
</refsect1>
</refentry>
-
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-encode.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-encode.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-encode.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,7 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 339181 Maintainer: hirokawa Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-encode">
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.session-encode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_encode</refname>
<refpurpose>現在のセッションデータを、セッションエンコードされた文字列に変換する</refpurpose>
@@ -10,7 +11,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_encode</methodname>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_encode</methodname>
<void/>
</methodsynopsis>
<para>
@@ -30,6 +31,7 @@
&reftitle.returnvalues;
<para>
現在のセッションの内容をエンコードしたものを返します。
+ &return.falseforfailure;
</para>
</refsect1>
@@ -53,7 +55,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-gc.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-gc.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-gc.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,7 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 342892 Maintainer: satoruyoshida Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-gc">
+<!-- EN-Revision: 351750 Maintainer: satoruyoshida Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.session-gc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_gc</refname>
<refpurpose>セッションデータのガベージコレクションを実行する</refpurpose>
@@ -9,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>int</type><methodname>session_gc</methodname>
- <void />
+ <type class="union"><type>int</type><type>false</type></type><methodname>session_gc</methodname>
+ <void/>
</methodsynopsis>
<para>
<function>session_gc</function> は、セッションデータの GC (ガベージコレクション)
Modified: phpdoc/ja/trunk/reference/session/functions/session-id.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-id.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-id.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 334621 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
<refentry xml:id="function.session-id" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_id</refname>
@@ -9,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_id</methodname>
- <methodparam choice="opt"><type>string</type><parameter>id</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_id</methodname>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>id</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_id</function> は現在のセッション ID を取得
@@ -32,7 +33,7 @@
<term><parameter>id</parameter></term>
<listitem>
<para>
- <parameter>id</parameter> が指定された場合、現在の
+ <parameter>id</parameter> が指定され、&null; でない場合、現在の
セッション ID を置換します。その際、
この関数は <function>session_start</function>
より前にコールされている必要があります。
@@ -65,9 +66,32 @@
<function>session_id</function> は現在のセッションのセッション ID を返します。
現在のセッションが存在しない (現在のセッション ID が存在しない)
場合は空文字列 (<literal>""</literal>) を返します。
+ 失敗時には、&false; を返します。
</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.0.0</entry>
+ <entry>
+ <parameter>id</parameter> は、nullable になりました。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -82,8 +106,6 @@
</para>
</refsect1>
</refentry>
-
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-module-name.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-module-name.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-module-name.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 347994 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-module-name">
+<refentry xml:id="function.session-module-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_module_name</refname>
<refpurpose>現在のセッションモジュールを取得または設定する</refpurpose>
@@ -11,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_module_name</methodname>
- <methodparam choice="opt"><type>string</type><parameter>module</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_module_name</methodname>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>module</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_module_name</function>は、
@@ -29,7 +29,7 @@
<term><parameter>module</parameter></term>
<listitem>
<para>
- <parameter>module</parameter> が指定された場合、
+ <parameter>module</parameter> が指定され、&null; でない場合、
そのモジュールを代わりに使用します。
このパラメーターに <literal>"user"</literal> を渡すことは禁止されています。
ユーザー定義のセッションハンドラを設定するには、この関数のかわりに
@@ -45,6 +45,7 @@
&reftitle.returnvalues;
<para>
現在のセッションモジュールの名前を返します。
+ &return.falseforfailure;
</para>
</refsect1>
@@ -60,6 +61,12 @@
</thead>
<tbody>
<row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>module</parameter> は、nullable になりました。
+ </entry>
+ </row>
+ <row>
<entry>7.2.0</entry>
<entry>
モジュール名に <literal>"user"</literal> を設定することは、
@@ -74,7 +81,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-name.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-name.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-name.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 345196 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351762 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-name">
+<refentry xml:id="function.session-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_name</refname>
<refpurpose>現在のセッション名を取得または設定する</refpurpose>
@@ -11,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_name</methodname>
- <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_name</methodname>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_name</function> は、現在のセッション名を返します。
@@ -55,6 +55,8 @@
セッション名は英数字のみで構成されている必要があり、また、
短く、その内容が分かるようなものである必要があります
(これは、クッキー警告を有効にしているユーザー用です)。
+ <parameter>name</parameter> が指定され、&null; でない場合、
+ 現在のセッションの名前が、指定された値に置き換えられます。
</para>
<para>
<warning>
@@ -76,7 +78,8 @@
<para>
現在のセッションの名前を返します。
<parameter>name</parameter> を渡すと、
- <function>session_name</function> はセッション名を上書きして元のセッション名を返します。
+ <function>session_name</function> はセッション名を上書きして <emphasis>元の</emphasis>セッション名を返します。
+ &return.falseforfailure;
</para>
</refsect1>
@@ -116,6 +119,12 @@
<row>
<entry>7.2.0</entry>
<entry>
+ <parameter>name</parameter> は、nullable になりました。
+ </entry>
+ </row>
+ <row>
+ <entry>7.2.0</entry>
+ <entry>
<function>session_name</function> 関数は、
セッションの状態をチェックするようになりました。
これより前のバージョンでは、
@@ -145,7 +154,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-save-path.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-save-path.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-save-path.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,7 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-save-path">
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.session-save-path" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_save_path</refname>
<refpurpose>現在のセッションデータ保存パスを取得または設定する</refpurpose>
@@ -10,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>string</type><methodname>session_save_path</methodname>
- <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam>
+ <type class="union"><type>string</type><type>false</type></type><methodname>session_save_path</methodname>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>path</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_save_path</function> は、
@@ -27,7 +28,7 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
- セッションデータのパス。これを指定すると、
+ セッションデータのパス。これに &null; でない値を指定すると、
データを保存するパスが変更されます。ただしそのためには
<function>session_start</function> がコールされる前に
<function>session_save_path</function> がコールされている必要があります。
@@ -52,9 +53,32 @@
&reftitle.returnvalues;
<para>
現在のデータ保存先ディレクトリのパスを返します。
+ &return.falseforfailure;
</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.0.0</entry>
+ <entry>
+ <parameter>path</parameter> は、nullable になりました。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -67,7 +91,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-set-cookie-params.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-set-cookie-params.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-set-cookie-params.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 350654 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-set-cookie-params">
+<refentry xml:id="function.session-set-cookie-params" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_set_cookie_params</refname>
<refpurpose>セッションクッキーパラメータを設定する</refpurpose>
@@ -10,17 +10,17 @@
<refsect1 role="description">
&reftitle.description;
- <methodsynopsis role="procedural">
+ <methodsynopsis>
<type>bool</type><methodname>session_set_cookie_params</methodname>
- <methodparam><type>int</type><parameter>lifetime</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>path</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>domain</parameter></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>secure</parameter><initializer>&false;</initializer></methodparam>
- <methodparam choice="opt"><type>bool</type><parameter>httponly</parameter><initializer>&false;</initializer></methodparam>
+ <methodparam><type>int</type><parameter>lifetime_or_options</parameter></methodparam>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>path</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>domain</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>secure</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>httponly</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
- <methodsynopsis role="procedural">
+ <methodsynopsis>
<type>bool</type><methodname>session_set_cookie_params</methodname>
- <methodparam><type>array</type><parameter>options</parameter></methodparam>
+ <methodparam><type>array</type><parameter>lifetime_or_options</parameter></methodparam>
</methodsynopsis>
<para>
ファイル &php.ini; で定義されたクッキーパラメータを設定します。
@@ -40,11 +40,25 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>lifetime</parameter></term>
+ <term><parameter>lifetime_or_options</parameter></term>
<listitem>
<para>
- セッションクッキーの <link linkend="ini.session.cookie-lifetime">有効期限</link>。秒数で定義します。
+ 最初のシグネチャを使う場合、セッションクッキーの <link linkend="ini.session.cookie-lifetime">有効期限</link>。秒数で定義します。
</para>
+ <para>
+ 二番目のシグネチャを使う場合、
+ 以下に示すキーを持つことができる連想配列です。
+ <literal>lifetime</literal>, <literal>path</literal>, <literal>domain</literal>,
+ <literal>secure</literal>, <literal>httponly</literal> および <literal>samesite</literal>.
+
+ 対応する値は、キーと同じ名前のパラメータで説明されているものと同じ意味です。
+ <literal>samesite</literal> 要素の値は、
+ <literal>Lax</literal> または <literal>Strict</literal> になるはずです。
+
+ 上記の許可されているオプションがいずれも設定されなかった場合、
+ デフォルト値は、明示的なパラメーターのデフォルト値と同じです。
+ <literal>samesite</literal> 要素が省略されると、SameSite クッキー属性は設定されません。
+ </para>
</listitem>
</varlistentry>
<varlistentry>
@@ -85,25 +99,6 @@
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
- 以下に示すキーを持つことができる連想配列です。
-
- <literal>lifetime</literal>, <literal>path</literal>, <literal>domain</literal>,
- <literal>secure</literal>, <literal>httponly</literal> および <literal>samesite</literal>.
-
- 対応する値は、キーと同じ名前のパラメータで説明されているものと同じ意味です。
- <literal>samesite</literal> 要素の値は、
- <literal>Lax</literal> または <literal>Strict</literal> になるはずです。
-
- 上記の許可されているオプションがいずれも設定されなかった場合、
- デフォルト値は、明示的なパラメーターのデフォルト値と同じです。
- <literal>samesite</literal> 要素が省略されると、SameSite クッキー属性は設定されません。
- </para>
- </listitem>
- </varlistentry>
</variablelist>
</para>
</refsect1>
@@ -128,9 +123,17 @@
</thead>
<tbody>
<row>
+ <entry>8.0.0</entry>
+ <entry>
+ <parameter>path</parameter>, <parameter>domain</parameter>,
+ <parameter>secure</parameter>, <parameter>httponly</parameter> は、
+ nullable になりました。
+ </entry>
+ </row>
+ <row>
<entry>7.3.0</entry>
<entry>
- 連想配列 <parameter>options</parameter> をサポートする、
+ 連想配列 <parameter>lifetime_or_options</parameter> をサポートする、
別のシグナチャが追加されました。
このシグナチャは、SameSite クッキー属性の設定もサポートします。
</entry>
@@ -175,7 +178,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-start.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-start.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-start.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 350655 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-start">
+<refentry xml:id="function.session-start" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>session_start</refname>
<refpurpose>新しいセッションを開始、あるいは既存のセッションを再開する</refpurpose>
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>session_start</methodname>
- <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
+ <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
<function>session_start</function> は、セッションを作成します。
@@ -239,7 +239,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/functions/session-status.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/functions/session-status.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/functions/session-status.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 320272 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<refentry xml:id="function.session-status" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -10,9 +10,9 @@
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
- <methodsynopsis role="procedural">
+ <methodsynopsis>
<type>int</type><methodname>session_status</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
<function>session_status</function> を使うと、現在のセッションの状態を取得できます。
@@ -44,7 +44,6 @@
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -65,4 +64,3 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
Modified: phpdoc/ja/trunk/reference/session/sessionhandler/destroy.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandler/destroy.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandler/destroy.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 349708 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="sessionhandler.destroy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -12,8 +12,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> <type>bool</type><methodname>SessionHandler::destroy</methodname>
- <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
+ <modifier>public</modifier> <type>bool</type><methodname>SessionHandler::destroy</methodname>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
セッションを破棄します。<function>session_regenerate_id</function> (<parameter>$destory</parameter> を &true; にしたとき) や
@@ -43,7 +43,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>session_id</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
破棄するセッション ID。
@@ -63,7 +63,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandler/gc.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandler/gc.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandler/gc.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 349708 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="sessionhandler.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -12,8 +12,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> <type>int</type><methodname>SessionHandler::gc</methodname>
- <methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>
+ <modifier>public</modifier> <type class="union"><type>int</type><type>bool</type></type><methodname>SessionHandler::gc</methodname>
+ <methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
</methodsynopsis>
<para>
有効期限を過ぎたセッションを削除します。PHP がセッションを開始したとき、あるいは
@@ -43,10 +43,10 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>maxlifetime</parameter></term>
+ <term><parameter>max_lifetime</parameter></term>
<listitem>
<para>
- 直近の <parameter>maxlifetime</parameter> 秒の間に更新されていないセッションを削除します。
+ 直近の <parameter>max_lifetime</parameter> 秒の間に更新されていないセッションを削除します。
</para>
</listitem>
</varlistentry>
@@ -56,13 +56,35 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &returns.session.storage.retval;
+ 成功時には、削除されたセッションの数を返します。
+ &return.falseforfailure;
+ この値は、処理を続けるために PHP の内部にも返される点に注意して下さい。
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>7.1.0</entry>
+ <entry>
+ これより前のバージョンでは、この関数は成功時に &true; を返していました。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandler/open.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandler/open.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandler/open.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 349708 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="sessionhandler.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -13,8 +13,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::open</methodname>
- <methodparam><type>string</type><parameter>save_path</parameter></methodparam>
- <methodparam><type>string</type><parameter>session_name</parameter></methodparam>
+ <methodparam><type>string</type><parameter>path</parameter></methodparam>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
新しいセッションを作成するか、あるいは既存のセッションを再度初期化します。
@@ -42,7 +42,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>save_path</parameter></term>
+ <term><parameter>path</parameter></term>
<listitem>
<para>
セッションを格納/取得するパス。
@@ -50,7 +50,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>session_name</parameter></term>
+ <term><parameter>name</parameter></term>
<listitem>
<para>
セッション名。
@@ -80,7 +80,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandler/read.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandler/read.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandler/read.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 349708 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="sessionhandler.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SessionHandler::read</methodname>
- <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
セッションのデータをセッションストレージから読み込み、その結果を PHP の内部処理用に返します。
@@ -44,7 +44,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>session_id</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
データを読み込むセッションの id。
@@ -75,7 +75,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandler/write.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandler/write.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandler/write.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 349708 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="sessionhandler.write" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -13,8 +13,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::write</methodname>
- <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
- <methodparam><type>string</type><parameter>session_data</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
セッションのデータをセッションストレージに書き込みます。
@@ -46,7 +46,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>session_id</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
セッション id。
@@ -54,7 +54,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>session_data</parameter></term>
+ <term><parameter>data</parameter></term>
<listitem>
<para>
エンコードされたセッションのデータ。
@@ -87,7 +87,6 @@
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandlerinterface/close.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandlerinterface/close.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandlerinterface/close.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 325727 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<refentry xml:id="sessionhandlerinterface.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionHandlerInterface::close</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
現在のセッションを閉じます。この関数はセッションを閉じるときに自動的に実行されます。
@@ -34,7 +34,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandlerinterface/destroy.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandlerinterface/destroy.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandlerinterface/destroy.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 323401 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<refentry xml:id="sessionhandlerinterface.destroy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionHandlerInterface::destroy</methodname>
- <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
セッションを破棄します。<function>session_regenerate_id</function> ($destroy = &true;) や
@@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>session_id</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
破棄するセッション ID。
@@ -45,7 +45,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandlerinterface/gc.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandlerinterface/gc.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandlerinterface/gc.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 343898 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
+<!-- Credits: mumumu -->
<refentry xml:id="sessionhandlerinterface.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -11,8 +12,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>abstract</modifier> <modifier>public</modifier> <type>int</type><methodname>SessionHandlerInterface::gc</methodname>
- <methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>
+ <modifier>abstract</modifier> <modifier>public</modifier> <type class="union"><type>int</type><type>bool</type></type><methodname>SessionHandlerInterface::gc</methodname>
+ <methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
</methodsynopsis>
<para>
有効期限を過ぎたセッションを削除します。
@@ -27,10 +28,10 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>maxlifetime</parameter></term>
+ <term><parameter>max_lifetime</parameter></term>
<listitem>
<para>
- 直近の <parameter>maxlifetime</parameter> 秒の間に更新されていないセッションを削除します。
+ 直近の <parameter>max_lifetime</parameter> 秒の間に更新されていないセッションを削除します。
</para>
</listitem>
</varlistentry>
@@ -40,12 +41,35 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- &returns.session.storage.retval;
+ 成功時に、削除したセッションの数を返します。
+ &return.falseforfailure;
+ この値は、処理を続けるために PHP の内部にも返される点に注意して下さい。
</para>
</refsect1>
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>7.1.0</entry>
+ <entry>
+ これより前のバージョンでは、この関数は成功時に &true; を返していました。
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </refsect1>
+
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandlerinterface/open.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandlerinterface/open.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandlerinterface/open.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 339638 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<refentry xml:id="sessionhandlerinterface.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,8 +12,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionHandlerInterface::open</methodname>
- <methodparam><type>string</type><parameter>save_path</parameter></methodparam>
- <methodparam><type>string</type><parameter>session_name</parameter></methodparam>
+ <methodparam><type>string</type><parameter>path</parameter></methodparam>
+ <methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
既存のセッションを再度初期化するか、あるいは新しいセッションを作成します。
@@ -25,7 +25,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>save_path</parameter></term>
+ <term><parameter>path</parameter></term>
<listitem>
<para>
セッションを格納/取得するパス。
@@ -33,7 +33,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>session_name</parameter></term>
+ <term><parameter>name</parameter></term>
<listitem>
<para>
セッション名。
@@ -63,7 +63,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandlerinterface/read.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandlerinterface/read.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandlerinterface/read.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 338890 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<refentry xml:id="sessionhandlerinterface.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>SessionHandlerInterface::read</methodname>
- <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
セッションのデータをセッションストレージから読み込み、その結果を返します。
@@ -42,7 +42,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>session_id</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
セッション id。
@@ -73,7 +73,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionhandlerinterface/write.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionhandlerinterface/write.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionhandlerinterface/write.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 323626 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: takagi Status: ready -->
<refentry xml:id="sessionhandlerinterface.write" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,8 +12,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionHandlerInterface::write</methodname>
- <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
- <methodparam><type>string</type><parameter>session_data</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
セッションのデータをセッションストレージに書き込みます。
@@ -38,7 +38,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>session_id</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
セッション id。
@@ -46,7 +46,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>session_data</parameter></term>
+ <term><parameter>data</parameter></term>
<listitem>
<para>
エンコードされたセッションデータ。
@@ -78,7 +78,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionidinterface/create-sid.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionidinterface/create-sid.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionidinterface/create-sid.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 350221 Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: mumumu Status: ready -->
<refentry xml:id="sessionidinterface.create-sid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>SessionIdInterface::create_sid</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
新しい セッションID を生成します。
@@ -43,7 +43,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/updatetimestamp.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/updatetimestamp.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/updatetimestamp.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 350221 Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: mumumu Status: ready -->
<refentry xml:id="sessionupdatetimestamphandlerinterface.updatetimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,8 +12,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionUpdateTimestampHandlerInterface::updateTimestamp</methodname>
- <methodparam><type>string</type><parameter>key</parameter></methodparam>
- <methodparam><type>string</type><parameter>val</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
セッションが最後に変更されたタイムスタンプを更新します。
@@ -25,7 +25,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>key</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
セッションID
@@ -33,7 +33,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>val</parameter></term>
+ <term><parameter>data</parameter></term>
<listitem>
<para>
セッションデータ
@@ -53,7 +53,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/validateid.xml
===================================================================
--- phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/validateid.xml 2020-11-30 01:26:22 UTC (rev 351762)
+++ phpdoc/ja/trunk/reference/session/sessionupdatetimestamphandlerinterface/validateid.xml 2020-11-30 01:46:59 UTC (rev 351763)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 350221 Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: 351750 Maintainer: mumumu Status: ready -->
<refentry xml:id="sessionupdatetimestamphandlerinterface.validateid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionUpdateTimestampHandlerInterface::validateId</methodname>
- <methodparam><type>string</type><parameter>key</parameter></methodparam>
+ <methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
与えられた セッションID を検証します。
@@ -28,7 +28,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
- <term><parameter>key</parameter></term>
+ <term><parameter>id</parameter></term>
<listitem>
<para>
セッションID
@@ -47,7 +47,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml