archived-doc-ja/reference/session/functions/session-gc.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 372350f3bfad45ba01db850a1a3be40c803e196b 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>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>session_gc</methodname>
   <void/>
  </methodsynopsis>
  <simpara>
   デフォルトで PHP は、
   <link linkend="ini.session.gc-probability">session.gc_probability</link>
   の設定をを使用して、
   各リクエストごとに確率的にセッションガベージコレクタを実行します。
   この方法には以下に示すいくつかの制限があります:
  </simpara>
  <simplelist>
   <member>トラフィックが少ないサイトのセッションデータは、望んだ期間内に削除されないことがあります</member>
   <member>トラフィックの多いサイトでは、GC が頻繁に行われる可能性があり、余計な処理が行われる可能性があります</member>
   <member>ガベージコレクションはユーザーのリクエストに基づいて行われるため、ユーザーが遅延を感じる可能性があります</member>
  </simplelist>
  <simpara>
   本番環境のシステムでは、
   確率ベースのガベージコレクションを
   <link linkend="ini.session.gc-probability">session.gc_probability</link>
   の値を <literal>0</literal> にすることで無効にし、
   定期的にガベージコレクタを明示的に実行させることをおすすめします。
   たとえば UNIX 系のシステムでは <function>session_gc</function>
   をコールするスクリプトを "cron" で実行する方法が挙げられます。
  </simpara>

  <note>
   <simpara>
    コマンドライン経由で実行する PHP スクリプトから
    <function>session_gc</function> を呼び出す場合、
    <link linkend="ini.session.save-path">session.save_path</link> については、
    Web からのリクエスト時のものと同じ値を設定し、
    PHP スクリプトはセッションファイルに対するアクセス権と削除権限が必須です。
    権限については、スクリプトを実行するユーザー、
    および systemd の <literal>PrivateTmp=</literal> オプションなどの
    コンテナやサンドボックス機能の影響を受ける可能性があります。
   </simpara>
  </note>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   <function>session_gc</function> は、
   成功時には削除されたセッションデータの数を返します。
   &return.falseforfailure;
  </simpara>
  <note>
   <simpara>
    古いセーブハンドラは、
    削除されたセッションデータの数を返さず、成功/失敗フラグのみを返します。
    この場合、実際に削除されたデータにかかわらず、
    削除されたセッションデータの数は <literal>1</literal> になります。
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>cron のようなタスクマネージャでの <function>session_gc</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
// 注 : このスクリプトは、Web サーバープロセスと同じユーザーで実行される必要があります。
// セッションデータストレージアクセスを初期化するには、アクティブセッションが必要です。
session_start();

// 直ちに GC を実行します
session_gc();

// session_start() によって作成されたセッション ID をクリーンアップします
session_destroy();
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>ユーザーがアクセス可能なスクリプトでの <function>session_gc</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
// 注 : session_gc() は、タスクマネージャスクリプトで使用することをお勧めしますが、次のように使用できます。

// 最後の GC 時間チェックに使用
$gc_time = '/tmp/php_session_last_gc';
$gc_period = 1800;

session_start();
// GC 期限が経過したときにのみ GC を実行します。 
// つまり、リクエストのたびに session_gc() をコールすることはリソースの無駄です。
if (file_exists($gc_time)) {
    if (filemtime($gc_time) < time() - $gc_period) {
        session_gc();
        touch($gc_time);
    }
} else {
    touch($gc_time);
}
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>session_start</function></member>
   <member><function>session_destroy</function></member>
   <member><link linkend="ini.session.gc-probability">session.gc_probability</link></member>
  </simplelist>
 </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
-->