SessionHandler: Rename getSessionId to getCookieSessionId.

git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@2494 44740490-163a-0410-bde0-09ae8108e29a

lib/SimpleSAML/SessionHandler.php

@@ -47,12 +47,12 @@ abstract class SimpleSAML_SessionHandler {
 	}
 
 
-	/* This function retrieves the session id of the current session.
+	/**
+	 * Retrieve the session id of saved in the session cookie.
 	 *
-	 * Returns:
-	 *  The session id of the current session.
+	 * @return string  The session id saved in the cookie.
 	 */
-	abstract public function getSessionId();
+	abstract public function getCookieSessionId();
 
 
 	/**

lib/SimpleSAML/SessionHandlerCookie.php

@@ -55,12 +55,12 @@ extends SimpleSAML_SessionHandler {
 	}
 
 
-	/* This function retrieves the session id of the current session.
+	/**
+	 * Retrieve the session id of saved in the session cookie.
 	 *
-	 * Returns:
-	 *  The session id of the current session.
+	 * @return string  The session id saved in the cookie.
 	 */
-	public function getSessionId() {
+	public function getCookieSessionId() {
 		return $this->session_id;
 	}
 

lib/SimpleSAML/SessionHandlerPHP.php

@@ -65,12 +65,12 @@ class SimpleSAML_SessionHandlerPHP extends SimpleSAML_SessionHandler {
 	}
 
 
-	/* This function retrieves the session id of the current session.
+	/**
+	 * Retrieve the session id of saved in the session cookie.
 	 *
-	 * Returns:
-	 *  The session id of the current session.
+	 * @return string  The session id saved in the cookie.
 	 */
-	public function getSessionId() {
+	public function getCookieSessionId() {
 		return session_id();
 	}