aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/classes/session.php
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/classes/session.php')
-rw-r--r--phpBB/includes/classes/session.php44
1 files changed, 22 insertions, 22 deletions
diff --git a/phpBB/includes/classes/session.php b/phpBB/includes/classes/session.php
index 72bc7c9a6b..7d780a59ed 100644
--- a/phpBB/includes/classes/session.php
+++ b/phpBB/includes/classes/session.php
@@ -20,7 +20,7 @@ if (!defined('IN_PHPBB'))
* Session class
* @package phpBB3
*/
-class phpbb_session
+abstract class phpbb_session
{
/**
* @var array Cookie informations
@@ -48,12 +48,12 @@ class phpbb_session
public $update_session_page = true;
/**
- * @var object Reference to authentication system.
+ * @var mixed Reference to authentication system.
*/
public $auth = NULL;
/**
- * @var object Reference to system array for obtaining server/system information
+ * @var mixed Reference to system array for obtaining server/system information
*/
public $system = NULL;
@@ -96,7 +96,7 @@ class phpbb_session
/**
* Specifiy the need for a session id within the URL
*
- * @param bool $need_sid[optional] Specify if the session id is needed or not. Default is false.
+ * @param bool $need_sid Specify if the session id is needed or not. Default is false.
* @access public
*/
public function need_sid($need_sid = false)
@@ -114,7 +114,7 @@ class phpbb_session
* running on a system which makes such information readily available) and
* halt if it's above an admin definable limit.
*
- * @param bool $update_session_page[optional] If true the session page gets updated. This can be set to false to circumvent certain scripts to update the users last visited page.
+ * @param bool $update_session_page If true the session page gets updated. This can be set to false to circumvent certain scripts to update the users last visited page.
* @return bool True if the session exist or has been created, else False.
* @access public
*/
@@ -165,10 +165,10 @@ class phpbb_session
* garbage collection, (search)bot checking, banned user comparison. Basically
* though this method will result in a new session for a specific user.
*
- * @param int $user_id[optional] The user id to create the session for.
- * @param bool $set_admin[optional] Set the users admin field to identify him/her as an admin?
- * @param bool $persist_login[optional] Allow persistent login
- * @param bool $viewonline[optional] If false then the user will be logged in as hidden
+ * @param int $user_id The user id to create the session for.
+ * @param bool $set_admin Set the users admin field to identify him/her as an admin?
+ * @param bool $persist_login Allow persistent login
+ * @param bool $viewonline If false then the user will be logged in as hidden
* @return bool True if session got created successfully.
* @access public
*/
@@ -484,7 +484,7 @@ class phpbb_session
* and update the users information from the relevant session data. It will then
* grab guest user information.
*
- * @param bool $new_session[optional] If true a new session will be generated after the original one got killed.
+ * @param bool $new_session If true a new session will be generated after the original one got killed.
* @access public
*/
public function session_kill($new_session = true)
@@ -655,11 +655,11 @@ class phpbb_session
* this routine does not return on finding a banned user, it outputs a relevant
* message and stops execution.
*
- * @param int $user_id[optional] The user id to check. If false then do not check user ids
- * @param mixed $user_ips[optional] Can contain a string with one IP or an array of multiple IPs. If false then no ips are checked.
- * @param int $user_email[optional] The email address to check
+ * @param int $user_id The user id to check. If false then do not check user ids
+ * @param string|array $user_ips Can contain a string with one IP or an array of multiple IPs. If false then no ips are checked.
+ * @param int $user_email The email address to check
* @param bool $return If false then the banned message is displayed and script halted
- * @return mixed True if banned and no reason given. False if not banned. A ban reason if banned and ban reason given. Check for !== false.
+ * @return bool|string True if banned and no reason given. False if not banned. A ban reason if banned and ban reason given. Check for !== false.
* @access public
*/
public function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false)
@@ -850,8 +850,8 @@ class phpbb_session
*
* @author satmd (from the php manual)
* @param string $mode register/post - spamcop for example is ommitted for posting
- * @param string $ip[optional] The ip to check. If false then the current IP is used
- * @return mixed false if ip is not blacklisted, else an array([checked server], [lookup])
+ * @param string $ip The ip to check. If false then the current IP is used
+ * @return bool|array false if ip is not blacklisted, else an array([checked server], [lookup])
* @access public
*/
public function check_dnsbl($mode, $ip = false)
@@ -910,9 +910,9 @@ class phpbb_session
* browsers or locations. As with _any_ non-secure-socket no passphrase login this
* remains vulnerable to exploit.
*
- * @param int $user_id[optional] The user id. If false the current users user id will be used
- * @param object $key[optional] A login key. If false then the current users login key stored within the cookie will be used
- * @param object $user_ip[optional] The users ip. If false, then the current users IP will be used
+ * @param int $user_id The user id. If false the current users user id will be used
+ * @param string $key A login key. If false then the current users login key stored within the cookie will be used
+ * @param string $user_ip The users ip. If false, then the current users IP will be used
* @access public
*/
public function set_login_key($user_id = false, $key = false, $user_ip = false)
@@ -958,7 +958,7 @@ class phpbb_session
* This method removes all current login keys for a specified (or the current)
* user. It will be called on password change to render old keys unusable
*
- * @param int $user_id[optional] The user id. If false then the current users user id is used.
+ * @param int $user_id The user id. If false then the current users user id is used.
* @access public
*/
public function reset_login_keys($user_id = false)
@@ -1093,7 +1093,7 @@ class phpbb_session
/**
* Check if the request originated from the same page.
*
- * @param bool $check_script_path[optional] If true, the path will be checked as well
+ * @param bool $check_script_path If true, the path will be checked as well
* @return bool True if the referer is valid
* @access private
*/
@@ -1195,7 +1195,7 @@ class phpbb_session
/**
* Check if session is valid by comparing ip, forwarded for, browser and referer
*
- * @param bool $log_failure[optional] If true then a non-match will be logged. Can cause huge logs.
+ * @param bool $log_failure If true then a non-match will be logged. Can cause huge logs.
* @return bool true if the session is valid
* @access private
*/