Reformat SimpleSAML_SessionHandler.

lib/SimpleSAML/SessionHandler.php

 <?php
 
+
 /**
  * This file is part of SimpleSAMLphp. See the file COPYING in the
  * root of the distribution for licence information.
@@ -9,157 +10,165 @@
  * the class method getSessionHandler().
  *
  * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
- * @package simpleSAMLphp
+ * @package SimpleSAMLphp
  */
-abstract class SimpleSAML_SessionHandler {
-
-
-	/**
-	 * This static variable contains a reference to the current
-	 * instance of the session handler. This variable will be NULL if
-	 * we haven't instantiated a session handler yet.
-	 *
-	 * @var SimpleSAML_SessionHandler
-	 */
-	private static $sessionHandler = NULL;
-
-
-
-	/**
-	 * This function retrieves the current instance of the session handler.
-	 * The session handler will be instantiated if this is the first call
-	 * to this fuunction.
-	 *
-	 * @return SimpleSAML_SessionHandler The current session handler.
-	 */
-	public static function getSessionHandler() {
-		if(self::$sessionHandler === NULL) {
-			self::createSessionHandler();
-		}
-
-		return self::$sessionHandler;
-	}
-
-
-	/**
-	 * This constructor is included in case it is needed in the the
-	 * future. Including it now allows us to write parent::__construct() in
-	 * the subclasses of this class.
-	 */
-	protected function __construct() {
-	}
-
-
-	/**
-	 * Create and set new session id.
-	 *
-	 * @return string The new session id.
-	 */
-	abstract public function newSessionId();
-
-
-	/**
-	 * Retrieve the session id of saved in the session cookie.
-	 *
-	 * @return string The session id saved in the cookie.
-	 */
-	abstract public function getCookieSessionId();
-
-
-	/**
-	 * Retrieve the session cookie name.
-	 *
-	 * @return string The session cookie name.
-	 */
-	abstract public function getSessionCookieName();
-
-
-	/**
-	 * Save the session.
-	 *
-	 * @param SimpleSAML_Session $session The session object we should save.
-	 */
-	abstract public function saveSession(SimpleSAML_Session $session);
-
-
-	/**
-	 * Load the session.
-	 *
-	 * @param string|NULL $sessionId The ID of the session we should load, or null to use the default.
-	 * @return SimpleSAML_Session|null The session object, or null if it doesn't exist.
-	 */
-	abstract public function loadSession($sessionId = NULL);
-
-
-	/**
-	 * Initialize the session handler.
-	 *
-	 * This function creates an instance of the session handler which is
-	 * selected in the 'session.handler' configuration directive. If no
-	 * session handler is selected, then we will fall back to the default
-	 * PHP session handler.
-	 */
-	private static function createSessionHandler() {
-
-		$store = SimpleSAML_Store::getInstance();
-		if ($store === FALSE) {
-			self::$sessionHandler = new SimpleSAML_SessionHandlerPHP();
-		} else {
-			self::$sessionHandler = new SimpleSAML_SessionHandlerStore($store);
-		}
-	}
-
-
-	/**
-	 * Check whether the session cookie is set.
-	 *
-	 * This function will only return false if is is certain that the cookie isn't set.
-	 *
-	 * @return bool True if it was set, false if not.
-	 */
-	public function hasSessionCookie() {
-
-		return TRUE;
-	}
-
-
-	/**
-	 * Get the cookie parameters that should be used for session cookies.
-	 *
-	 * @return array An array with the cookie parameters.
-	 * @link http://www.php.net/manual/en/function.session-get-cookie-params.php
-	 */
-	public function getCookieParams() {
-
-		$config = SimpleSAML_Configuration::getInstance();
-
-		return array(
-			'lifetime' => $config->getInteger('session.cookie.lifetime', 0),
-			'path' => $config->getString('session.cookie.path', '/'),
-			'domain' => $config->getString('session.cookie.domain', NULL),
-			'secure' => $config->getBoolean('session.cookie.secure', FALSE),
-			'httponly' => TRUE,
-		);
-	}
-
-
-	/**
-	 * Set a session cookie.
-	 *
-	 * @param string $name The name of the session cookie.
-	 * @param string|null $value The value of the cookie. Set to null to delete the cookie.
-	 */
-	public function setCookie($name, $value, array $params = NULL) {
-		assert('is_string($name)');
-		assert('is_string($value) || is_null($value)');
-
-		if ($params !== NULL) {
-			$params = array_merge($this->getCookieParams(), $params);
-		} else {
-			$params = $this->getCookieParams();
-		}
-
-		\SimpleSAML\Utils\HTTP::setCookie($name, $value, $params);
-	}
+abstract class SimpleSAML_SessionHandler
+{
+
+
+    /**
+     * This static variable contains a reference to the current
+     * instance of the session handler. This variable will be NULL if
+     * we haven't instantiated a session handler yet.
+     *
+     * @var SimpleSAML_SessionHandler
+     */
+    private static $sessionHandler = null;
+
+
+    /**
+     * This function retrieves the current instance of the session handler.
+     * The session handler will be instantiated if this is the first call
+     * to this function.
+     *
+     * @return SimpleSAML_SessionHandler The current session handler.
+     */
+    public static function getSessionHandler()
+    {
+        if (self::$sessionHandler === null) {
+            self::createSessionHandler();
+        }
+
+        return self::$sessionHandler;
+    }
+
+
+    /**
+     * This constructor is included in case it is needed in the the
+     * future. Including it now allows us to write parent::__construct() in
+     * the subclasses of this class.
+     */
+    protected function __construct()
+    {
+    }
+
+
+    /**
+     * Create and set new session id.
+     *
+     * @return string The new session id.
+     */
+    abstract public function newSessionId();
+
+
+    /**
+     * Retrieve the session id of saved in the session cookie.
+     *
+     * @return string The session id saved in the cookie.
+     */
+    abstract public function getCookieSessionId();
+
+
+    /**
+     * Retrieve the session cookie name.
+     *
+     * @return string The session cookie name.
+     */
+    abstract public function getSessionCookieName();
+
+
+    /**
+     * Save the session.
+     *
+     * @param SimpleSAML_Session $session The session object we should save.
+     */
+    abstract public function saveSession(SimpleSAML_Session $session);
+
+
+    /**
+     * Load the session.
+     *
+     * @param string|NULL $sessionId The ID of the session we should load, or null to use the default.
+     *
+     * @return SimpleSAML_Session|null The session object, or null if it doesn't exist.
+     */
+    abstract public function loadSession($sessionId = null);
+
+
+    /**
+     * Initialize the session handler.
+     *
+     * This function creates an instance of the session handler which is
+     * selected in the 'session.handler' configuration directive. If no
+     * session handler is selected, then we will fall back to the default
+     * PHP session handler.
+     */
+    private static function createSessionHandler()
+    {
+
+        $store = SimpleSAML_Store::getInstance();
+        if ($store === false) {
+            self::$sessionHandler = new SimpleSAML_SessionHandlerPHP();
+        } else {
+            self::$sessionHandler = new SimpleSAML_SessionHandlerStore($store);
+        }
+    }
+
+
+    /**
+     * Check whether the session cookie is set.
+     *
+     * This function will only return false if is is certain that the cookie isn't set.
+     *
+     * @return bool True if it was set, false if not.
+     */
+    public function hasSessionCookie()
+    {
+
+        return true;
+    }
+
+
+    /**
+     * Get the cookie parameters that should be used for session cookies.
+     *
+     * @return array An array with the cookie parameters.
+     * @link http://www.php.net/manual/en/function.session-get-cookie-params.php
+     */
+    public function getCookieParams()
+    {
+
+        $config = SimpleSAML_Configuration::getInstance();
+
+        return array(
+            'lifetime' => $config->getInteger('session.cookie.lifetime', 0),
+            'path'     => $config->getString('session.cookie.path', '/'),
+            'domain'   => $config->getString('session.cookie.domain', null),
+            'secure'   => $config->getBoolean('session.cookie.secure', false),
+            'httponly' => true,
+        );
+    }
+
+
+    /**
+     * Set a session cookie.
+     *
+     * @param string      $name The name of the session cookie.
+     * @param string|null $value The value of the cookie. Set to null to delete the cookie.
+     * @param array|null  $params Additional params to use for the session cookie.
+     */
+    public function setCookie($name, $value, array $params = null)
+    {
+        assert('is_string($name)');
+        assert('is_string($value) || is_null($value)');
+
+        if ($params !== null) {
+            $params = array_merge($this->getCookieParams(), $params);
+        } else {
+            $params = $this->getCookieParams();
+        }
+
+        \SimpleSAML\Utils\HTTP::setCookie($name, $value, $params);
+    }
 
 }