symfony API

sfSessionTestStorage 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.

sfSessionTestStorage is a fake sfSessionStorage implementation to allow easy testing.

Inheritence

sfSessionTestStorage  <  sfStorage

Method Summary

  • clear()
    Clears all test sessions.
  • string getSessionId()
    Gets session id for the current session storage instance.
  • initialize($options = null)
    Available options:
  • mixed read($key)
    Reads data from this storage.
  • boolean regenerate($destroy = false)
    Regenerates id that represents this storage.
  • mixed remove($key)
    Removes data from this storage.
  • shutdown()
    Executes the shutdown procedure.
  • write($key, $data)
    Writes data to this storage.

Methods inherited from sfStorage

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

Method Details

  • clear () Browse code

    Clears all test sessions.

  • (string) getSessionId () Browse code

    Gets session id for the current session storage instance.

    returns Session id

  • initialize ($options = null) Browse code

    $options An associative array of options

    Available options:

    * session_path: The path to store the session files
    * session_id: The session identifier

  • (mixed) read ($key) Browse code

    $key A unique key identifying your data

    Reads 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

  • (mixed) remove ($key) Browse code

    $key A unique key identifying your data

    Removes 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.

  • write ($key, $data) Browse code

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

    Writes data to this storage.


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