session-encode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 35b95a56ccc03b66af7117fc815ac7881e2e0ad3 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.session-encode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_encode</refname>
  <refpurpose>現在のセッションデータを、セッションエンコードされた文字列に変換する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>session_encode</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <function>session_encode</function> は、
   現在のセッションの内容をシリアライズした文字列を返します．
   現在のセッションの内容は、スーパーグローバル $_SESSION から取得します。
  </para>
  <para>
   デフォルトのアンシリアライズの方法は PHP が内部的に実装しているものであり、
   <function>unserialize</function> とは違います。
   シリアライズの方法は、<link linkend="ini.session.serialize-handler">session.serialize_handler</link>
   で設定できます。
  </para>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   現在のセッションの内容をエンコードしたものを返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
    <function>session_encode</function> を使う前には <function>session_start</function> を呼ぶ必要があります。
   </para>
  </warning>
 </refsect1> 
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>session_decode</function></member>
    <member><link linkend="ini.session.serialize-handler">session.serialize_handler</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
-->