Files
André L F S Bacci a5be3453f4 Update translation.
2023-08-27 10:37:55 -03:00

93 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: ae Status: ready -->
<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>Lê os dados de sessão</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SessionHandler">
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandler::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 o resultado de volta para o PHP para processamento interno.
Este método é chamado automaticamente pelo PHP quando uma sessão é iniciada (quer seja de forma automática ou explicitamente
com <function>session_start</function>) e é precedida por uma chamada interna de
<function>SessionHandler::open</function>.
</para>
<para>
Este método envolve o manipulador interno de gravação do PHP definido na configuração ini
<link linkend="ini.session.save-handler">session.save_handler</link> que foi definido
antes deste manipulador ser ativado por <function>session_set_save_handler</function>.
</para>
<para>
Se esta classe for estendida por herança, chamar o método <parameter>read</parameter> da classe pai invocará a função
que envolve este método, portanto invocará o callback interno. Isto permite que esse método seja
substituído ou interceptado e filtrado (por exemplo, descriptografar o valor de <parameter>$data</parameter>
retornado pelo método <parameter>read</parameter> da classe pai).
</para>
<para>
Para mais informações relacionadas ao que é esperado que este método faça, por favor leia a documentação de
<function>SessionHandlerInterface::read</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
O id da sessão onde deve ser feita a leitura dos dados.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna uma string, codificada, dos dados lidos. Se nada foi lido, deve retornar &false;. Note que este valor é retornado internamente ao 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
-->