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

86 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="sessionhandler.destroy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SessionHandler::destroy</refname>
<refpurpose>セッションを破棄する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SessionHandler">
<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; にしたとき) や
<function>session_destroy</function> からコールされ、<function>session_decode</function>
が失敗したときにもコールされます。
</para>
<para>
このメソッドは、このハンドラが <function>session_set_save_handler</function>
で設定される前に ini 設定
<link linkend="ini.session.save-handler">session.save_handler</link>
で定義されていた PHP の保存ハンドラをラップします。
</para>
<para>
このクラスを継承して拡張する場合は、親の <parameter>destroy</parameter>
メソッドをコールすればこのメソッドのラッパーを実行でき、それに付随する内部コールバックも実行されます。
こうすれば、メソッドをオーバーライドしたり処理を横取りしてフィルタを追加したりできます。
</para>
<para>
このメソッドに関する詳細は、
<function>SessionHandlerInterface::destroy</function>
のドキュメントを参照ください。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
破棄するセッション ID。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</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
-->