1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 15:12:22 +01:00
Files
2022-12-12 19:16:43 +09:00

93 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 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>
<refname>SessionHandlerInterface::gc</refname>
<refpurpose>古いセッションを削除する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SessionHandlerInterface">
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandlerInterface::gc</methodname>
<methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
</methodsynopsis>
<para>
有効期限を過ぎたセッションを削除します。
<link linkend="ini.session.gc-divisor">session.gc_divisor</link>
<link linkend="ini.session.gc-probability">session.gc_probability</link> および
<link linkend="ini.session.gc-maxlifetime">session.gc_maxlifetime</link> の設定に基づいて、
<function>session_start</function> からコールされます。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>max_lifetime</parameter></term>
<listitem>
<para>
直近の <parameter>max_lifetime</parameter> 秒の間に更新されていないセッションを削除します。
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功時に、削除したセッションの数を返します。
&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
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
-->