php-doc-en/reference/http/HttpResponse/setCacheControl.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.HttpResponse-setCacheControl">
 <refnamediv>
  <refname>HttpResponse::setCacheControl</refname>
  <refpurpose>Set cache control</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>static</modifier>
   <type>bool</type><methodname>HttpResponse::setCacheControl</methodname>
   <methodparam choice="opt"><type>string</type><parameter>control</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>max_age = 0</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>must_revalidate = TRUE</parameter></methodparam>
  </methodsynopsis>

  <para>
   Define a custom cache-control header, usually being <emphasis>private</emphasis> or <emphasis>public</emphasis>;
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>control</parameter></term>
     <listitem>
      <para>
       the primary cache control setting
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max_age</parameter></term>
     <listitem>
      <para>
       the max-age in seconds, suggesting how long the cache entry is valid on the client side
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>must_revalidate</parameter></term>
     <listitem>
      <para>
       whether the cached entity should be revalidated by the client for every request
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns TRUE on success, or FALSE if control does not match one of <emphasis>public</emphasis>, <emphasis>private</emphasis> or <emphasis>no-cache</emphasis>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws HttpInvalidParamException.
  </para>
 </refsect1>


 <!-- Use when a CHANGELOG exists
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>Enter the PHP version of change here</entry>
       <entry>Description of change</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 -->


 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>HttpResponse::setCacheControl</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->


 <!-- Use when adding See Also links
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function></function></member>
    <member>Or <link linkend="somethingelse">something else</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:"../../../../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
-->