symfony API

sfStorage Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.4 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.4 version. Switch to:

sfStorage allows you to customize the way symfony stores its persistent data.

Inheritence

sfCacheSessionStorage, sfNoStorage, sfSessionStorage, sfSessionTestStorage  <  sfStorage

Method Summary

  • array getOptions()
    Returns the option array.
  • bool initialize($options)
    Initializes this Storage instance.
  • mixed read($key)
    Reads data from this storage.
  • boolean regenerate($destroy)
    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.
  • __construct()
    Class constructor.

Method Details

  • (array) getOptions () Browse code

    Returns the option array.

    returns The array of options

  • (bool) initialize ($options) Browse code

    $options An associative array of options

    Initializes this Storage instance.


    Available options:

    * auto_shutdown: Whether to automatically save the changes to the session (true by default)

    returns true, if initialization completes successfully, otherwise false

    throws sfInitializationException If an error occurs while initializing this sfStorage

  • (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

    throws sfStorageException If an error occurs while reading data from this storage

  • (boolean) regenerate ($destroy) 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

    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

    throws sfStorageException If an error occurs while removing data from this storage

  • 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

    Writes data to this storage.


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

    throws sfStorageException If an error occurs while writing to this storage

  • __construct () Browse code

    Class constructor.