mirror of
https://github.com/php/doc-ja.git
synced 2026-03-28 09:02:14 +01:00
9d9be2cc56
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@328106 c90b9560-bf6c-de11-be94-00142212c4b1
85 lines
2.9 KiB
XML
85 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 3a8dc25d68cb882feae6163cf5384356f31647ea Maintainer: takagi Status: ready -->
|
|
|
|
<refentry xml:id="sessionhandler.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>SessionHandler::gc</refname>
|
|
<refpurpose>古いセッションを削除する</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>SessionHandler::gc</methodname>
|
|
<methodparam><type>int</type><parameter>maxlifetime</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
有効期限を過ぎたセッションを削除します。PHP がセッションを開始したとき、あるいは
|
|
<function>session_start</function> を実行したときにコールされます。
|
|
コールされる頻度は、<link linkend="ini.session.gc-divisor">session.gc_divisor</link> および
|
|
<link linkend="ini.session.gc-probability">session.gc_probability</link> の設定に基づいて決まります。
|
|
</para>
|
|
<para>
|
|
このメソッドは、このハンドラが <function>session_set_save_handler</function>
|
|
で設定される前に ini 設定
|
|
<link linkend="ini.session.save-handler">session.save_handler</link>
|
|
で定義されていた PHP の保存ハンドラをラップします。
|
|
</para>
|
|
<para>
|
|
このクラスを継承して拡張する場合は、親の <parameter>gc</parameter>
|
|
メソッドをコールすればこのメソッドのラッパーを実行でき、それに付随する内部コールバックも実行されます。
|
|
こうすれば、メソッドをオーバーライドしたり処理を横取りしてフィルタを追加したりできます。
|
|
</para>
|
|
<para>
|
|
このメソッドに関する詳細は、
|
|
<function>SessionHandlerInterface::gc</function>
|
|
のドキュメントを参照ください。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>maxlifetime</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
直近の <parameter>maxlifetime</parameter> 秒の間に更新されていないセッションを削除します。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&returns.session.storage.retval;
|
|
</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
|
|
-->
|