Files
2024-03-03 15:47:25 -03:00

92 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: leonardolara Status: ready --><!-- CREDITS: marcosmarcolin -->
<refentry xml:id="sessionhandlerinterface.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SessionHandlerInterface::read</refname>
<refpurpose>Lê os dados de sessão</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SessionHandlerInterface">
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandlerInterface::read</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
Lê os dados de sessão do armazenamento de sessão e retorna os resultados.
Chamada logo depois que a sessão inicia ou quando <function>session_start</function> é chamada.
Note que antes desse método ser chamado, o método <function>SessionHandlerInterface::open</function> é invocado.
</para>
<para>
Este método é chamado pelo próprio PHP quando uma sessão é iniciada.
Este método deve recuperar os dados de sessão do armazenamento de sessão relacionados ao
ID de sessão fornecido. A string retornada por este método deve estar no mesmo
formato de serialização de quando ela foi originalmente passada para <function>SessionHandlerInterface::write</function>.
Se a informação não for encontrada, retorna &false;
</para>
<para>
Os dados retornados por este método serão decodificados internamente pelo PHP usando o
método de deserialização especificado em <link linkend="ini.session.serialize-handler">session.serialize_handler</link>.
Os dados resultantes serão usados para preencher a super global <varname>$_SESSION</varname>.
</para>
<para>
Note que o esquema de serialização não é o mesmo que <function>unserialize</function>
e pode ser acessado por <function>session_decode</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
O id da sessão.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna uma string codificada dos dados lidos. Se nada foi lido, então deve retornar &false;. Note que este valor é retornado internamente para o PHP para processamento.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<link linkend="ini.session.serialize-handler">session.serialize_handler</link>
(diretiva de configuração).
</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
-->