Files
doc-fr/reference/session/sessionhandler/read.xml
2021-05-25 18:58:36 +01:00

97 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1367cac761756ee4fce7c63be945b115f2924795 Maintainer: jpauli Status: ready -->
<!-- Reviewed: no -->
<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>Lit les données de session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<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>
Lit les données de session depuis son lieu de stockage,
et retourne le résultat pour que PHP le traite. Cette fonction est appelée par PHP lorsque
la session est démarrée automatiquement ou au moyen de <function>session_start</function>,
elle est précédée d'un appel à <function>SessionHandler::open</function>.
</para>
<para>
Cette méthode se substitue au gestionnaire interne de sauvegarde de PHP, défini via
l'option de configuration <link linkend="ini.session.save-handler">session.save_handler</link>
qui a été définie avant que ce gestionnaire ne soit modifié via la fonction
<function>session_set_save_handler</function>.
</para>
<para>
Si cette classe est étendue par héritage, l'appel de la méthode parente
<parameter>read</parameter> invoquera ce gestionnaire pour cette méthode, mais
aussi, la fonction de rappel interne associée. Ce mécanisme permet à cette méthode
de surcharger, intercepter et/ou filtrer les données (par exemple,
le décryptage de la valeur <parameter>$data</parameter> retournée par la méthode parente
<parameter>read</parameter>).
</para>
<para>
Pour plus d'informations sur cette méthode, référez-vous à la documentation
sur la fonction <function>SessionHandlerInterface::read</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
L'ID de la session depuis laquelle les données seront lues.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne les données lues sous forme encodée. Si rien n'a été lu &false; doit être retournée.
Cette valeur est utilisée en interne par PHP.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
La directive de configuration <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
-->