1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-24 07:22:16 +01:00
Files
2025-03-23 12:02:26 +01:00

106 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 601f6f4ce5827d441a7e110184708f0abe9fd447 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="sessionhandler.gc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SessionHandler::gc</refname>
<refpurpose>Limpia las sesiones antiguas</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SessionHandler">
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SessionHandler::gc</methodname>
<methodparam><type>int</type><parameter>max_lifetime</parameter></methodparam>
</methodsynopsis>
<para>
Limpia las sesiones expiradas. Se llama aleatoriamente en el interior de PHP cuando una
sesión comienza o cuando se llama a la función <function>session_start</function>.
La frecuencia de llamada se basa en las directivas de configuración
<link linkend="ini.session.gc-divisor">session.gc_divisor</link> y
<link linkend="ini.session.gc-probability">session.gc_probability</link>.
</para>
<para>
Este método reemplaza al gestor interno de almacenamiento de PHP definido a través de la opción
de configuración <link linkend="ini.session.save-handler">session.save_handler</link>
que se ha definido antes de que este último se defina a través de la función
<function>session_set_save_handler</function>.
</para>
<para>
Si esta clase se extiende por herencia, la llamada al método padre <parameter>gc</parameter>
invocará el envoltorio para este método, pero también invocará internamente la función de devolución de llamada
asociada. Este comportamiento permite que este método se sobreescriba o bien se intercepte y filtre.
</para>
<para>
Para más información sobre lo esperado de este método, consulte la documentación
sobre la función <function>SessionHandlerInterface::gc</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>max_lifetime</parameter></term>
<listitem>
<para>
Las sesiones que no se hayan actualizado durante las últimas
<parameter>max_lifetime</parameter> segundos serán eliminadas.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve el número de sesiones eliminadas en caso de éxito, &return.falseforfailure;.
Nota que este valor se devuelve internamente a PHP para su procesamiento.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.1.0</entry>
<entry>
Antes de esta versión, esta función devolvía &true; en caso de éxito.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->