1. sfDatabaseSessionStorage.class.php
  2. /**
 * Base class for all sfStorage that uses a sfDatabase object as a storage.
 *
 * @package    symfony
 * @subpackage storage
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfDatabaseSessionStorage.class.php 22037 2009-09-15 11:00:20Z fabien $
 */
  3. abstract class sfDatabaseSessionStorage extends sfSessionStorage
  4. {
  5.   protected
  6.     $db = null,
  7.     $con = null;
  9.   /**
  10.    * Available options:
  11.    *
  12.    *   * db_table:    The database table in which session data will be stored
  13.    *   * database:    The sfDatabase object to use
  14.    *   * db_id_col:   The database column in which the session id will be stored (sess_id by default)
  15.    *   * db_data_col: The database column in which the session data will be stored (sess_data by default)
  16.    *   * db_time_col: The database column in which the session timestamp will be stored (sess_time by default)
  17.    *
  18.    * @param  array $options  An associative array of options
  19.    *
  20.    * @see sfSessionStorage
  21.    */
  22.   public function initialize($options = array())
  23.   {
  24.     $options = array_merge(array(
  25.       'db_id_col'   => 'sess_id',
  26.       'db_data_col' => 'sess_data',
  27.       'db_time_col' => 'sess_time',
  28.     ), $options);
  30.     // disable auto_start
  31.     $options['auto_start'] = false;
  33.     // initialize the parent
  34.     parent::initialize($options);
  36.     if (!isset($this->options['db_table']))
  37.     {
  38.       throw new sfInitializationException('You must provide a "db_table" option to sfDatabaseSessionStorage.');
  39.     }
  41.     if (!isset($this->options['database']))
  42.     {
  43.       throw new sfInitializationException('You must provide a "database" option to sfDatabaseSessionStorage.');
  44.     }
  46.     // use this object as the session handler
  47.     session_set_save_handler(array($this, 'sessionOpen'),
  48.                              array($this, 'sessionClose'),
  49.                              array($this, 'sessionRead'),
  50.                              array($this, 'sessionWrite'),
  51.                              array($this, 'sessionDestroy'),
  52.                              array($this, 'sessionGC'));
  54.     // start our session
  55.     session_start();
  56.   }
  58.   /**
  59.    * Closes a session.
  60.    *
  61.    * @return boolean true, if the session was closed, otherwise false
  62.    */
  63.   public function sessionClose()
  64.   {
  65.     // do nothing
  66.     return true;
  67.   }
  69.   /**
  70.    * Opens a session.
  71.    *
  72.    * @param  string $path  (ignored)
  73.    * @param  string $name  (ignored)
  74.    *
  75.    * @return boolean true, if the session was opened, otherwise an exception is thrown
  76.    *
  77.    * @throws <b>DatabaseException</b> If a connection with the database does not exist or cannot be created
  78.    */
  79.   public function sessionOpen($path = null, $name = null)
  80.   {
  81.     // what database are we using?
  82.     $database = $this->options['database'];
  84.     // get the database and connection
  85.     $databaseClass = get_class($database);
  86.     if($databaseClass == 'sfPropelDatabase')
  87.     {
  88.       $this->db = Propel::getConnection($database->getParameter('name'));
  89.     }
  90.     elseif($databaseClass == 'sfDoctrineDatabase')
  91.     {
  92.       $this->db = $database->getConnection();
  93.     }
  94.     else
  95.     {
  96.       $this->db = $database->getResource();
  97.     }
  98.     
  99.     $this->con = $database->getConnection();
  101.     if (null === $this->db && null === $this->con)
  102.     {
  103.       throw new sfDatabaseException('Database connection does not exist. Unable to open session.');
  104.     }
  106.     return true;
  107.   }
  109.   /**
  110.    * Destroys a session.
  111.    *
  112.    * @param  string $id  A session ID
  113.    *
  114.    * @return bool true, if the session was destroyed, otherwise an exception is thrown
  115.    *
  116.    * @throws <b>DatabaseException</b> If the session cannot be destroyed
  117.    */
  118.   abstract public function sessionDestroy($id);
  120.   /**
  121.    * Cleans up old sessions.
  122.    *
  123.    * @param  int $lifetime  The lifetime of a session
  124.    *
  125.    * @return bool true, if old sessions have been cleaned, otherwise an exception is thrown
  126.    *
  127.    * @throws <b>DatabaseException</b> If any old sessions cannot be cleaned
  128.    */
  129.   abstract public function sessionGC($lifetime);
  131.   /**
  132.    * Reads a session.
  133.    *
  134.    * @param  string $id  A session ID
  135.    *
  136.    * @return bool true, if the session was read, otherwise an exception is thrown
  137.    *
  138.    * @throws <b>DatabaseException</b> If the session cannot be read
  139.    */
  140.   abstract public function sessionRead($id);
  142.   /**
  143.    * Writes session data.
  144.    *
  145.    * @param  string $id    A session ID
  146.    * @param  string $data  A serialized chunk of session data
  147.    *
  148.    * @return bool true, if the session was written, otherwise an exception is thrown
  149.    *
  150.    * @throws <b>DatabaseException</b> If the session data cannot be written
  151.    */
  152.   abstract public function sessionWrite($id, $data);
  154.   /**
  155.    * Regenerates id that represents this storage.
  156.    *
  157.    * @param  boolean $destroy Destroy session when regenerating?
  158.    *
  159.    * @return boolean True if session regenerated, false if error
  160.    *
  161.    */
  162.   public function regenerate($destroy = false)
  163.   {
  164.     if (self::$sessionIdRegenerated)
  165.     {
  166.       return;
  167.     }
  169.     $currentId = session_id();
  171.     parent::regenerate($destroy);
  173.     $newId = session_id();
  174.     $this->sessionRead($newId);
  176.     return $this->sessionWrite($newId, $this->sessionRead($currentId));
  177.   }
  179.   /**
  180.    * Executes the shutdown procedure.
  181.    *
  182.    */
  183.   public function shutdown()
  184.   {
  185.     parent::shutdown();
  186.   }
  187. }
Debug toolbar