symfony API

sfCacheSessionStorage Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.2 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.2 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfCacheSessionStorage manages session storage via a signed cookie and cache backend.

Inheritence

sfCacheSessionStorage  <  sfStorage

Method Summary

  • expire()
    Expires the session storage instance.
  • bool initialize($options = array())
    Initialize this Storage.
  • mixed read($key)
    Read data from this storage.
  • boolean regenerate($destroy = false)
    Regenerates id that represents this storage.
  • mixed remove($key)
    Remove data from this storage.
  • shutdown()
    Executes the shutdown procedure.
  • write($key, $data)
    Write data to this storage.

Methods inherited from sfStorage

getOptions , initialize , read , regenerate , remove , shutdown , write , __construct

Method Details

  • expire () Browse code

    Expires the session storage instance.

  • (bool) initialize ($options = array()) Browse code

    $options An associative array of initialization parameters. session_name [required] name of session to use session_cookie_path [required] cookie path session_cookie_domain [required] cookie domain session_cookie_lifetime [required] liftime of cookie session_cookie_secure [required] send only if secure connection session_cookie_http_only [required] accessible only via http protocol

    Initialize this Storage.

    returns true, if initialization completes successfully, otherwise false.

    throws sfInitializationException If an error occurs while initializing this Storage.

  • (mixed) read ($key) Browse code

    $key A unique key identifying your data.

    Read data from this storage.


    The preferred format for a key is directory style so naming conflicts can be avoided.

    returns Data associated with the key.

  • (boolean) regenerate ($destroy = false) Browse code

    $destroy Destroy session when regenerating?

    Regenerates id that represents this storage.

    returns True if session regenerated, false if error

    throws sfStorageException If an error occurs while regenerating this storage

  • (mixed) remove ($key) Browse code

    $key A unique key identifying your data.

    Remove data from this storage.


    The preferred format for a key is directory style so naming conflicts can be avoided.

    returns Data associated with the key.

  • shutdown () Browse code

    Executes the shutdown procedure.

    throws sfStorageException If an error occurs while shutting down this storage

  • write ($key, $data) Browse code

    $key A unique key identifying your data.
    $data Data associated with your key.

    Write data to this storage.


    The preferred format for a key is directory style so naming conflicts can be avoided.