summaryrefslogtreecommitdiffstats
path: root/lib/public/isession.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/isession.php')
-rw-r--r--lib/public/isession.php16
1 files changed, 14 insertions, 2 deletions
diff --git a/lib/public/isession.php b/lib/public/isession.php
index 5f9ce32f3b1..0a77b0c823b 100644
--- a/lib/public/isession.php
+++ b/lib/public/isession.php
@@ -10,34 +10,46 @@
namespace OCP;
+/**
+ * Interface ISession
+ *
+ * wrap PHP's internal session handling into the ISession interface
+ */
interface ISession {
+
/**
+ * Set a value in the session
+ *
* @param string $key
* @param mixed $value
*/
public function set($key, $value);
/**
+ * Get a value from the session
+ *
* @param string $key
* @return mixed should return null if $key does not exist
*/
public function get($key);
/**
+ * Check if a named key exists in the session
+ *
* @param string $key
* @return bool
*/
public function exists($key);
/**
- * should not throw any errors if $key does not exist
+ * Remove a $key/$value pair from the session
*
* @param string $key
*/
public function remove($key);
/**
- * removes all entries within the cache namespace
+ * Reset and recreate the session
*/
public function clear();