Browse Source

Extracting the CakeSessionHandlerInterface into its own file

Jose Lorenzo Rodriguez 14 years ago
parent
commit
399c293b77

+ 1 - 59
lib/Cake/Model/Datasource/CakeSession.php

@@ -682,63 +682,5 @@ class CakeSession {
 	}
 }
 
-
-/**
- * Interface for Session handlers.  Custom session handler classes should implement
- * this interface as it allows CakeSession know how to map methods to session_set_save_handler()
- *
- * @package       Cake.Model.Datasource
- */
-interface CakeSessionHandlerInterface {
-/**
- * Method called on open of a session.
- *
- * @return boolean Success
- */
-	public function open();
-
-/**
- * Method called on close of a session.
- *
- * @return boolean Success
- */
-	public function close();
-
-/**
- * Method used to read from a session.
- *
- * @param mixed $id The key of the value to read
- * @return mixed The value of the key or false if it does not exist
- */
-	public function read($id);
-
-/**
- * Helper function called on write for sessions.
- *
- * @param integer $id ID that uniquely identifies session in database
- * @param mixed $data The value of the data to be saved.
- * @return boolean True for successful write, false otherwise.
- */
-	public function write($id, $data);
-
-/**
- * Method called on the destruction of a session.
- *
- * @param integer $id ID that uniquely identifies session in database
- * @return boolean True for successful delete, false otherwise.
- */
-	public function destroy($id);
-
-/**
- * Run the Garbage collection on the session storage.  This method should vacuum all
- * expired or dead sessions.
- *
- * @param integer $expires Timestamp (defaults to current time)
- * @return boolean Success
- */
-	public function gc($expires = null);
-}
-
-
 // Initialize the session
-CakeSession::init();
+CakeSession::init();

+ 1 - 0
lib/Cake/Model/Datasource/Session/CacheSession.php

@@ -18,6 +18,7 @@
  */
 
 App::uses('Cache', 'Cache');
+App::uses('CakeSessionHandlerInterface', 'Model/Datasource/Session');
 
 /**
  * CacheSession provides method for saving sessions into a Cache engine. Used with CakeSession

+ 70 - 0
lib/Cake/Model/Datasource/Session/CakeSessionHandlerInterface.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @package       Cake.Model.Datasource
+ * @since         CakePHP(tm) v 2.1
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+
+/**
+ * Interface for Session handlers.  Custom session handler classes should implement
+ * this interface as it allows CakeSession know how to map methods to session_set_save_handler()
+ *
+ * @package       Cake.Model.Datasource.Session
+ */
+interface CakeSessionHandlerInterface {
+/**
+ * Method called on open of a session.
+ *
+ * @return boolean Success
+ */
+	public function open();
+
+/**
+ * Method called on close of a session.
+ *
+ * @return boolean Success
+ */
+	public function close();
+
+/**
+ * Method used to read from a session.
+ *
+ * @param mixed $id The key of the value to read
+ * @return mixed The value of the key or false if it does not exist
+ */
+	public function read($id);
+
+/**
+ * Helper function called on write for sessions.
+ *
+ * @param integer $id ID that uniquely identifies session in database
+ * @param mixed $data The value of the data to be saved.
+ * @return boolean True for successful write, false otherwise.
+ */
+	public function write($id, $data);
+
+/**
+ * Method called on the destruction of a session.
+ *
+ * @param integer $id ID that uniquely identifies session in database
+ * @return boolean True for successful delete, false otherwise.
+ */
+	public function destroy($id);
+
+/**
+ * Run the Garbage collection on the session storage.  This method should vacuum all
+ * expired or dead sessions.
+ *
+ * @param integer $expires Timestamp (defaults to current time)
+ * @return boolean Success
+ */
+	public function gc($expires = null);
+}

+ 3 - 0
lib/Cake/Model/Datasource/Session/DatabaseSession.php

@@ -16,6 +16,9 @@
  * @since         CakePHP(tm) v 2.0
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
+
+App::uses('CakeSessionHandlerInterface', 'Model/Datasource/Session');
+
 /**
  * DatabaseSession provides methods to be used with CakeSession.
  *