From: Thomas Tanghus <thomas@tanghus.net>
Date: Wed, 18 Sep 2013 10:01:01 +0000 (+0200)
Subject: Add some docs to the sessions interface.
X-Git-Tag: v6.0.0alpha2~121^2~15^2
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=d3f88ceeb49b9b86d32124163b0cea82567a4911;p=nextcloud-server.git

Add some docs to the sessions interface.
---

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();