reference/session/functions/session-cache-limiter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 927c3d9ef797f572473754d0ed8488d34986f0ca Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.session-cache-limiter" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_cache_limiter</refname>
  <refpurpose>Lee y/o modifica el limitador de caché de sesión</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>session_cache_limiter</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>session_cache_limiter</function> devuelve la configuración
   actual del limitador de caché.
  </para>
  <para>
   El limitador de caché controla los encabezados HTTP enviados al cliente.
   Algunos encabezados determinan las reglas de almacenamiento en caché de la página
   en el navegador. Al configurar este limitador a <literal>nocache</literal>,
   por ejemplo, el navegador no almacenará la página en su caché. El valor
   <literal>public</literal>, en cambio, permitirá el almacenamiento en caché. El valor
   <literal>private</literal> desactiva la caché para el proxy y autoriza al
   cliente a almacenar en caché el contenido.
  </para>
  <para>
   En modo <literal>private</literal>, el encabezado Expire enviado al cliente
   puede causar problemas en algunos navegadores, como, por ejemplo,
   <productname>Mozilla</productname>. Este problema puede evitarse con el modo
   <literal>private_no_expire</literal>. El encabezado <literal>Expire</literal>
   nunca se envía al navegador para este modo.
  </para>
  <para>
   El hecho de definir el limitador de caché a
   la valor <literal>''</literal> desactivará
   automáticamente y por completo el envío de los encabezados de caché.
  </para>
  <para>
   El limitador de caché se restablece al valor por defecto de
   <link linkend="ini.session.cache-limiter"><option>session.cache_limiter</option></link> en cada
   inicio de script PHP. Por lo tanto, deberá llamarse a <function>session_cache_limiter</function> en
   cada página, y antes de <function>session_start</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Si <parameter>value</parameter> se proporciona y no es &null;,
       el limitador de caché se reconfigura con este valor.
      </para>
      <table>
       <title>Valores posibles</title>
       <tgroup cols="2">
        <thead>
         <row>
          <entry>Valores</entry>
          <entry>Encabezados enviados</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry><literal>public</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Expires: (Algo en el futuro, según session.cache_expire)
Cache-Control: public, max-age=(Algo en el futuro, según session.cache_expire)
Last-Modified: (el timestamp correspondiente al último guardado de la sesión)
]]>
           </programlisting>
          </entry>
         </row>
         <row>
          <entry><literal>private_no_expire</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Cache-Control: private, max-age=(session.cache_expire en el futuro)
Last-Modified: (el timestamp correspondiente al último guardado de la sesión)
]]>
           </programlisting>
          </entry>
         </row>
         <row>
          <entry><literal>private</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: private, max-age=(session.cache_expire en el futuro)
Last-Modified: (el timestamp correspondiente al último guardado de la sesión)
]]>
           </programlisting>
          </entry>
         </row>
         <row>
          <entry><literal>nocache</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate
Pragma: no-cache
]]>
           </programlisting>
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el nombre del limitador de caché actual.
   En caso de error, se devuelve &false;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>value</parameter> ahora es nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>session_cache_limiter</function></title>
    <programlisting role="php">
<![CDATA[
<?php

/* configura el limitador de caché a 'private' */

session_cache_limiter('private');
$cache_limiter = session_cache_limiter();

echo "El limitador de caché ahora vale $cache_limiter<br />";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="ini.session.cache-limiter">session.cache_limiter</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
-->