session-destroy.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 682510e91d1f19fb59d2f7aef6ab370e8af842a1 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-destroy">
 <refnamediv>
  <refname>session_destroy</refname>
  <refpurpose>セッションに登録されたデータを全て破棄する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>session_destroy</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   <function>session_destroy</function>は、現在のセッションに
   関連づけられたすべてのデータを破棄します。この関数は、
   セッションに関するグローバル変数を破棄しません。
   また、セッションクッキーを破棄しません。
   セッション変数の利用を再開するには <function>session_start</function>
   をコールする必要があります。
  </simpara>
  <note>
   <simpara>
     通常のコードでは、<function>session_destroy</function> を呼ぶ必要はありません。
     セッションデータを破棄するよりも、 $_SESSION 配列をクリーンアップしてください。
   </simpara>
  </note>
  <para>
   セッションを切断するには、
   セッション ID の割り当ても解除する必要があります。セッション ID の受け渡しに
   クッキーが使用されている場合（デフォルト）には、セッションクッキーも
   削除されなければなりません。
   そのために <function>setcookie</function> が利用できます。
  </para>
  <para>
   <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link>
   が有効になっている場合、
   古くなった セッションID のクッキーを削除する必要はありません。
   なぜなら、セッションモジュールはセッションIDに紐付いたデータがないとき、
   セッションID のクッキーを受け入れないからです。
   全てのサイトで、
   <link linkend="ini.session.use-strict-mode">session.use_strict_mode</link>
   を有効にすることを推奨します。
  </para>
  <warning>
   <para>
    すぐにセッションを削除してしまうと、
    望まない結果が起こる可能性があります。
    並列にリクエストが行われたときに、
    他のリクエストの接続は突然データが消えたように見えるかもしれません。
    たとえば、JavaScript または/もしくは 
    URLリンクからのリクエストが同時に実行された場合です。
   </para>
   <para>
    現在のセッションモジュールは、空のセッションIDを受け入れません。
    しかし、すぐにセッションを削除してしまうと、
    クライアント(ブラウザ)サイドとの競合によって、
    空のセッションIDクッキーが発生するかもしれません。
    これにより、不必要なのにクライアント側が
    たくさんのセッションIDを作ってしまうことになります。
   </para>
   <para>
    こうした事象を防ぐためには、
    $_SESSION に削除時のタイムスタンプを設定し、
    それより後のアクセスを拒否するようにしなければなりません。
    もしくは、アプリケーションが同時に
    複数のリクエストを受け付けないようにすることです。
    同じことは、<function>session_regenerate_id</function>
    関数にも当てはまります。
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><varname>$_SESSION</varname>でセッションを破棄する</title>
    <programlisting role="php">
<![CDATA[
<?php
// セッションの初期化
// session_name("something")を使用している場合は特にこれを忘れないように!
session_start();

// セッション変数を全て解除する
$_SESSION = array();

// セッションを切断するにはセッションクッキーも削除する。
// Note: セッション情報だけでなくセッションを破壊する。
if (ini_get("session.use_cookies")) {
    $params = session_get_cookie_params();
    setcookie(session_name(), '', time() - 42000,
        $params["path"], $params["domain"],
        $params["secure"], $params["httponly"]
    );
}

// 最終的に、セッションを破壊する
session_destroy();
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="ini.session.use-strict-mode">session.use_strict_mode</link></member>
    <member><function>session_reset</function></member>
    <member><function>session_regenerate_id</function></member>
    <member><function>unset</function></member>
    <member><function>setcookie</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
-->