From 03707f4e13d96b879ad49d9fd9ff349048f92254 Mon Sep 17 00:00:00 2001
From: Jan Schneider <jan@horde.org>
Date: Thu, 16 Dec 2010 15:00:18 +0100
Subject: [PATCH] Move timeout parameter to base class, phpdoc.

---
 framework/Token/lib/Horde/Token/Base.php | 24 ++++++++++++------------
 framework/Token/lib/Horde/Token/File.php | 12 ++++--------
 framework/Token/lib/Horde/Token/Sql.php  | 16 +++++++---------
 3 files changed, 23 insertions(+), 29 deletions(-)

diff --git a/framework/Token/lib/Horde/Token/Base.php b/framework/Token/lib/Horde/Token/Base.php
index a636a37dd..931a4dd88 100644
--- a/framework/Token/lib/Horde/Token/Base.php
+++ b/framework/Token/lib/Horde/Token/Base.php
@@ -33,16 +33,14 @@ abstract class Horde_Token_Base
      * Constructor.
      *
      * @param array $params  Required parameters:
-     * <pre>
-     * 'secret' - (string) The secret string used for signing tokens.
-     * 'token_lifetime' - (int) The number of seconds after which tokens time out.
-     *                          Negative numbers represent "no timeout".
-     *                          The default is "-1".
-     * </pre>
+     * - secret (string): The secret string used for signing tokens.
      * Optional parameters:
-     * <pre>
-     * 'logger' - (Horde_Log_Logger) A logger object.
-     * </pre>
+     * - token_lifetime (integer): The number of seconds after which tokens
+     *                             time out. Negative numbers represent "no
+     *                             timeout". The default is "-1".
+     * - timeout (integer): The period (in seconds) after which an id is purged.
+     *                      DEFAULT: 86400 (24 hours)
+     * - logger (Horde_Log_Logger): A logger object.
      */
     public function __construct($params)
     {
@@ -50,9 +48,11 @@ abstract class Horde_Token_Base
             throw new Horde_Token_Exception('Missing secret parameter.');
         }
 
-        if (!isset($params['token_lifetime'])) {
-            $params['token_lifetime'] = -1;
-        }
+        $params = array_merge(array(
+            'token_lifetime' => -1,
+            'timeout' => 86400
+        ), $params);
+
         if (isset($params['logger'])) {
             $this->_logger = $params['logger'];
             unset($params['logger']);
diff --git a/framework/Token/lib/Horde/Token/File.php b/framework/Token/lib/Horde/Token/File.php
index 4afcd720e..e445552fd 100644
--- a/framework/Token/lib/Horde/Token/File.php
+++ b/framework/Token/lib/Horde/Token/File.php
@@ -30,19 +30,15 @@ class Horde_Token_File extends Horde_Token_Base
     /**
      * Constructor.
      *
+     * @see Horde_Token_Base::__construct() for more parameters.
+     *
      * @param array $params  Optional parameters:
-     * <pre>
-     * 'timeout' - (integer) The period (in seconds) after which an id is
-     *             purged.
-     *             DEFAULT: 86400 (24 hours)
-     * 'token_dir' - (string)  The directory where to keep token files.
-     *               DEFAULT: System temporary directory
-     * </pre>
+     * - token_dir (string): The directory where to keep token files.
+     *                       DEFAULT: System temporary directory
      */
     public function __construct($params = array())
     {
         $params = array_merge(array(
-            'timeout' => 86400,
             'token_dir' => Horde_Util::getTempDir()
         ), $params);
 
diff --git a/framework/Token/lib/Horde/Token/Sql.php b/framework/Token/lib/Horde/Token/Sql.php
index 9ec26cb40..2838ff51e 100644
--- a/framework/Token/lib/Horde/Token/Sql.php
+++ b/framework/Token/lib/Horde/Token/Sql.php
@@ -34,14 +34,13 @@ class Horde_Token_Sql extends Horde_Token_Base
     /**
      * Constructor.
      *
-     * @param array $params  Parameters:
-     * <pre>
-     * 'db' - (Horde_Db_Adapter) [REQUIRED] The DB instance.
-     * 'table' - (string) The name of the tokens table.
-     *           DEFAULT: 'horde_tokens'
-     * 'timeout' - (integer) The period (in seconds) after which an id is
-     *             purged.
-     *             DEFAULT: 86400 (24 hours)
+     * @see Horde_Token_Base::__construct() for more parameters.
+     *
+     * @param array $params  Required parameters:
+     * - db (Horde_Db_Adapter): The DB instance.
+     * Optional parameters:
+     * - table (string): The name of the tokens table.
+     *                   DEFAULT: 'horde_tokens'
      * </pre>
      *
      * @throws Horde_Token_Exception
@@ -56,7 +55,6 @@ class Horde_Token_Sql extends Horde_Token_Base
 
         $params = array_merge(array(
             'table' => 'horde_tokens',
-            'timeout' => 86400
         ), $params);
 
         parent::__construct($params);
-- 
2.11.0