1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-24 15:32:36 +01:00
Files
2024-11-08 09:48:03 +00:00

94 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<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>Leer información de la sesión</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>
Lee la información de la sesión desde el almacén de sesiones, y devuelve los resultados a PHP para su procesamiento interno.
Este método es llamado automáticamente por PHP cuando se inicia una sesión (automáticamente o explícitamente
con <function>session_start</function>) y está precedido por una llamada interna a la función
<function>SessionHandler::open</function>.
</para>
<para>
Este método envuelve el gestor de almacenamiento interno de PHP definido en el
ajuste ini <link linkend="ini.session.save-handler">session.save_handler</link> que fue establecido
antes de que este gestor fuese establecido mediante <function>session_set_save_handler</function>.
</para>
<para>
Si esta clase se extiende por herencia, al llamar al método padre <parameter>read</parameter> invocará a la
envoltura para este método y así invocará a la llamada de retorno interna asociada. Esto permite que el método sea
sobrescrito y/o interceptado y filtrado (por ejemplo, desencriptando el valor de <parameter>$data</parameter>
devuelto por el método padre <parameter>read</parameter>).
</para>
<para>
Para más información sobre lo que se espera que haga este método, consulte la documentación de
<function>SessionHandlerInterface::close</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
El id de sesión de donde leer la información.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve una cadena codificada de la información leída. Si no se leyó nada, debe devolver &false;. Observe que este valor es devuelto internamente a PHP para su procesamiento.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
La directiva de configuración
<link linkend="ini.session.serialize-handler">session.serialize_handler</link>.
</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
-->