session-name.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d7a77b5f850d5077f75d0c8c0d22cd60f099965d Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.session-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_name</refname>
  <refpurpose>現在のセッション名を取得または設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>session_name</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>session_name</function> は、現在のセッション名を返します。
   <parameter>name</parameter> を渡すと、
   <function>session_name</function> はセッション名を上書きして
   <emphasis>元の</emphasis> セッション名を返します。
  </para>
  <para>
   新しいセッションの <parameter>name</parameter> を指定すると、
   <function>session_name</function> 関数は HTTPクッキー を
   変更します(そして、<link linkend="ini.session.use-trans-sid">session.use_trans_sid</link>
   が有効なときは、出力内容も変更します)。
   HTTPクッキー が一度送信されると、
   <function>session_name</function> 関数は
   <constant>E_WARNING</constant> を発生させます。
   セッションを適切に動作させるためには、
   <function>session_start</function>
   の前に <function>session_name</function> をコールしなければいけません。
  </para>
  <para>
   リクエストが開始された際にセッション名はリセットされ、
   <literal>session.name</literal>
   に保存されたデフォルト値に戻ります。
   よって、各リクエスト毎に(そして
   <function>session_start</function> をコールする前に)
   <function>session_name</function> をコールする必要があります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       セッションの名前を参照します。これは、クッキーや URL
       (例: <literal>PHPSESSID</literal>) で使われます。
       セッション名は英数字のみで構成されている必要があり、また、
       短く、その内容が分かるようなものである必要があります
       (これは、クッキー警告を有効にしているユーザー用です)。
       <parameter>name</parameter> が指定され、&null; でない場合、
       現在のセッションの名前が、指定された値に置き換えられます。
      </para>
      <para>
       <warning>
        <para>
         セッション名は数字だけで構成することはできません。
         少なくとも文字がひとつ以上現れる必要があります。そうでない場合、
         新規セッション ID が毎回生成されます。
        </para>
       </warning>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   現在のセッションの名前を返します。
   <parameter>name</parameter> を渡すと、
   <function>session_name</function> はセッション名を上書きして <emphasis>元の</emphasis>セッション名を返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.2.0</entry>
       <entry>
        <parameter>name</parameter> は、nullable になりました。
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        <function>session_name</function> 関数は、
        セッションの状態をチェックするようになりました。
        これより前のバージョンでは、
        クッキー の状態をチェックするだけでした。
        そのため、古い <function>session_name</function> 関数は
        <function>session_start</function> 関数の後に
        <function>session_name</function> 関数を呼び出すことを許して
        しまっており、それが PHP 
        のクラッシュや不具合を起こす可能性がありました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>session_name</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

/* セッション名をWebsiteIDに設定する */

$previous_name = session_name("WebsiteID");

echo "前回のセッション名は $previous_name でした<br />";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     設定ディレクティブ <link linkend="ini.session.name">session.name</link>
    </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
-->