1. sfStorage.class.php
  2. /**
 * sfStorage allows you to customize the way symfony stores its persistent data.
 *
 * @package    symfony
 * @subpackage storage
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfStorage.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfStorage
  4. {
  5.   protected
  6.     $options = array();
  8.   /**
  9.    * Class constructor.
  10.    *
  11.    * @see initialize()
  12.    */
  13.   public function __construct($options = array())
  14.   {
  15.     $this->initialize($options);
  17.     if ($this->options['auto_shutdown'])
  18.     {
  19.       register_shutdown_function(array($this, 'shutdown'));
  20.     }
  21.   }
  23.   /**
  24.    * Initializes this Storage instance.
  25.    *
  26.    * Available options:
  27.    *
  28.    *  * auto_shutdown: Whether to automatically save the changes to the session (true by default)
  29.    *
  30.    * @param  array $options  An associative array of options
  31.    *
  32.    * @return bool true, if initialization completes successfully, otherwise false
  33.    *
  34.    * @throws <b>sfInitializationException</b> If an error occurs while initializing this sfStorage
  35.    */
  36.   public function initialize($options = array())
  37.   {
  38.     $this->options = array_merge(array(
  39.       'auto_shutdown' => true,
  40.     ), $options);
  41.   }
  43.   /**
  44.    * Returns the option array.
  45.    *
  46.    * @return array The array of options
  47.    */
  48.   public function getOptions()
  49.   {
  50.     return $this->options;
  51.   }
  53.   /**
  54.    * Reads data from this storage.
  55.    *
  56.    * The preferred format for a key is directory style so naming conflicts can be avoided.
  57.    *
  58.    * @param  string $key  A unique key identifying your data
  59.    *
  60.    * @return mixed Data associated with the key
  61.    *
  62.    * @throws <b>sfStorageException</b> If an error occurs while reading data from this storage
  63.    */
  64.   abstract public function read($key);
  66.   /**
  67.    * Regenerates id that represents this storage.
  68.    *
  69.    * @param  boolean $destroy Destroy session when regenerating?
  70.    *
  71.    * @return boolean True if session regenerated, false if error
  72.    *
  73.    * @throws <b>sfStorageException</b> If an error occurs while regenerating this storage
  74.    */
  75.   abstract public function regenerate($destroy = false);
  77.   /**
  78.    * Removes data from this storage.
  79.    *
  80.    * The preferred format for a key is directory style so naming conflicts can be avoided.
  81.    *
  82.    * @param  string $key  A unique key identifying your data
  83.    *
  84.    * @return mixed Data associated with the key
  85.    *
  86.    * @throws <b>sfStorageException</b> If an error occurs while removing data from this storage
  87.    */
  88.   abstract public function remove($key);
  90.   /**
  91.    * Executes the shutdown procedure.
  92.    *
  93.    * @throws <b>sfStorageException</b> If an error occurs while shutting down this storage
  94.    */
  95.   abstract public function shutdown();
  97.   /**
  98.    * Writes data to this storage.
  99.    *
  100.    * The preferred format for a key is directory style so naming conflicts can be avoided.
  101.    *
  102.    * @param  string $key   A unique key identifying your data
  103.    * @param  mixed  $data  Data associated with your key
  104.    *
  105.    * @throws <b>sfStorageException</b> If an error occurs while writing to this storage
  106.    */
  107.   abstract public function write($key, $data);
  108. }
Debug toolbar