symfony API

sfStorage Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.0 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.0 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.

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

Inheritence

sfSessionStorage, sfSessionTestStorage  <  sfStorage

Method Summary

  • mixed &()
    Removes data from this storage.
  • sfContext getContext()
    Retrieves the current application context.
  • mixed getParameter(, , )
    Retrieves a parameter from the validator.
  • sfParameterHolder getParameterHolder()
    Retrieves the parameters from the storage.
  • boolean hasParameter(, )
    Indicates whether or not a parameter exist for the storage instance.
  • boolean initialize(, )
    Initializes this Storage instance.
  • Storage newInstance()
    Retrieves a new Storage implementation instance.
  • setParameter(, , )
    Sets a parameter for the current storage instance.
  • shutdown()
    Executes the shutdown procedure.
  • write(, )
    Writes data to this storage.

Method Details

  • (mixed) & () Browse code

    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

  • (sfContext) getContext () Browse code

    Retrieves the current application context.

    returns A sfContext instance

  • (mixed) getParameter (, , ) Browse code

    Retrieves a parameter from the validator.

    returns A parameter value

  • (sfParameterHolder) getParameterHolder () Browse code

    Retrieves the parameters from the storage.

    returns List of parameters

  • (boolean) hasParameter (, ) Browse code

    Indicates whether or not a parameter exist for the storage instance.

    returns true, if parameter exists, otherwise false

  • (boolean) initialize (, ) Browse code

    Initializes this Storage instance.

    returns true, if initialization completes successfully, otherwise false

    throws sfInitializationException If an error occurs while initializing this sfStorage

  • (Storage) newInstance () Browse code

    Retrieves a new Storage implementation instance.

    returns A Storage implementation instance

    throws sfFactoryException If a storage implementation instance cannot be created

  • setParameter (, , ) Browse code

    Sets a parameter for the current storage instance.

  • shutdown () Browse code

    Executes the shutdown procedure.

    throws sfStorageException If an error occurs while shutting down this storage

  • write (, ) Browse code

    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