php-doc-en/reference/session/sessionhandlerinterface/write.xml
Justin Martin 4eec43e52c Fixed the session handler return values, based on rev 321741.
Fixed the session handler prototypes to reflect correct return types.
Credit to Drak. Closes bug #60640.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323264 c90b9560-bf6c-de11-be94-00142212c4b1
2012-02-16 21:08:22 +00:00

73 lines
2 KiB
XML

<?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>sessionid</parameter></methodparam>
<methodparam><type>string</type><parameter>sessiondata</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, and during request shutdown.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>sessionid</parameter></term>
<listitem>
<para>
The session id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sessiondata</parameter></term>
<listitem>
<para>
The (<function>session_encode</function>d) session data.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&returns.session.storage.retval;
</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
-->