PHP Manual
Prev |  | Next

# session_cache_limiter

(PHP 4 >= 4.0.3)

session_cache_limiter -- Get and/or set the current cache limiter

## Description

string session_cache_limiter ( [string cache_limiter])

session_cache_limiter() returns the name of the current cache limiter. If `cache_limiter` is specified, the name of the current cache limiter is changed to the new value.

The cache limiter controls the cache control HTTP headers sent to the client. These headers determine the rules by which the page content may be cached. Setting the cache limiter to `nocache`, for example, would disallow any client-side caching. A value of `public`, however, would permit caching. It can also be set to `private`, which is slightly more restrictive than `public`.

In `private` mode, the Expire header sent to the client may cause confusion for some browsers, including Mozilla. You can avoid this problem by using `private_no_expire` mode. The expire header is never sent to the client in this mode.

> Note: `private_no_expire` was added in PHP 4.2.0dev.

The cache limiter is reset to the default value stored in `session.cache_limiter` at request startup time. Thus, you need to call session_cache_limiter() for every request (and before session_start() is called).

Example 1. session_cache_limiter() examples
    <?php

    # set the cache limiter to 'private'

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

    echo "The cache limiter is now set to $cache_limiter<p>";
    ?>

Prev | Home | Next
session_cache_expire | Up | session_decode