From 5c19b995db6dab9aae579274db82413117cce67b Mon Sep 17 00:00:00 2001
From: Thomas Tanghus <thomas@tanghus.net>
Date: Tue, 17 Sep 2013 18:31:14 +0200
Subject: Add interface for Session and add getter in server container.

---
 lib/public/isession.php | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 lib/public/isession.php

(limited to 'lib/public/isession.php')

diff --git a/lib/public/isession.php b/lib/public/isession.php
new file mode 100644
index 00000000000..5f9ce32f3b1
--- /dev/null
+++ b/lib/public/isession.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright (c) 2013 Thomas Tanghus (thomas@tanghus.net)
+ * @author Thomas Tanghus
+ * @author Robin Appelman
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP;
+
+interface ISession {
+	/**
+	 * @param string $key
+	 * @param mixed $value
+	 */
+	public function set($key, $value);
+
+	/**
+	 * @param string $key
+	 * @return mixed should return null if $key does not exist
+	 */
+	public function get($key);
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function exists($key);
+
+	/**
+	 * should not throw any errors if $key does not exist
+	 *
+	 * @param string $key
+	 */
+	public function remove($key);
+
+	/**
+	 * removes all entries within the cache namespace
+	 */
+	public function clear();
+
+}
-- 
cgit v1.2.3


From d3f88ceeb49b9b86d32124163b0cea82567a4911 Mon Sep 17 00:00:00 2001
From: Thomas Tanghus <thomas@tanghus.net>
Date: Wed, 18 Sep 2013 12:01:01 +0200
Subject: Add some docs to the sessions interface.

---
 lib/public/isession.php | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

(limited to 'lib/public/isession.php')

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();
 
-- 
cgit v1.2.3