<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="sessionhandlerinterface.write" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SessionHandlerInterface::write</refname>
  <refpurpose>Write session data</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>SessionHandlerInterface::write</methodname>
   <methodparam><type>string</type><parameter>session_id</parameter></methodparam>
   <methodparam><type>string</type><parameter>session_data</parameter></methodparam>
  </methodsynopsis>
  <para>
   Writes the session data to the session storage. Called by
   <function>session_write_close</function>, when <function>session_register_shutdown</function> fails, or during a normal shutdown.
   Note: <function>SessionHandlerInterface::close</function> is called immediately after this function.
  </para>
  <para>
   PHP will call this method when the session is ready to be saved and closed. It encodes
   the session data from the <varname>$_SESSION</varname> superglobal to a serialized string and passes this
   along with the session ID to this method for storage.  The serialization method used
   is specified in the <link linkend="ini.session.serialize-handler">session.serialize_handler</link> setting.
  </para>
  <para>
   Note this method is normally called by PHP after the output buffers have been closed unless explicitly
   called by <function>session_write_close</function>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>session_id</parameter></term>
    <listitem>
     <para>
      The session id.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>session_data</parameter></term>
    <listitem>
     <para>
      The encoded session data.  This data is the result of the PHP internally encoding the <varname>$_SESSION</varname> superglobal to a serialized
      string and passing it as this parameter.  Please note sessions use an alternative serialization method.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &returns.session.storage.retval;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member>
     The <link linkend="ini.session.serialize-handler">session.serialize_handler</link>
     configuration directive.
    </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
-->