mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
18046e0224
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@325489 c90b9560-bf6c-de11-be94-00142212c4b1
94 lines
3 KiB
XML
94 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="sessionhandler.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>SessionHandler::read</refname>
|
|
<refpurpose>Read session data</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>string</type><methodname>SessionHandler::read</methodname>
|
|
<methodparam><type>string</type><parameter>session_id</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Reads the session data from the session storage, and returns the result back to PHP for internal processing.
|
|
This method is called automatically by PHP when a session is started (either automatically or explicity
|
|
with <function>session_start</function> and is preceeded by an internal call to the
|
|
<function>SessionHandler::open</function>.
|
|
</para>
|
|
<para>
|
|
This method wraps the internal PHP save handler defined in the
|
|
<link linkend="ini.session.save-handler">session.save_handler</link> ini setting that was set
|
|
before this handler was set by <function>session_set_save_handler</function>.
|
|
</para>
|
|
<para>
|
|
If this class is extended by inheritiance, calling the parent <parameter>read</parameter> method will invoke the
|
|
wrapper for this method and therefor invoke the associated internal callback. This allows the method to be
|
|
overidden and or intercepted and filtered (for example, decrypting <parameter>$data</parameter> value
|
|
returned by the parent <parameter>read</parameter> method).
|
|
</para>
|
|
<para>
|
|
For more information on what this method is expected to do, please refer to the documentation at
|
|
<function>SessionHandlerInterface::read</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>session_id</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The session id to read data for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an encoded string of the read data. If nothing was read, it must return an empty string. Note this value is returned internally to PHP for processing.
|
|
</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
|
|
-->
|