diff options
| author | n-aleha <nick_aleha@myway.com> | 2014-05-17 03:43:34 +0300 |
|---|---|---|
| committer | n-aleha <nick_aleha@myway.com> | 2014-08-03 06:57:05 +0300 |
| commit | 19b9df7e630031e3bdf0640a91f7025da3a00257 (patch) | |
| tree | 100803d4d1390fbddcd0c7f2c448237c586d9f09 /phpBB/phpbb/session.php | |
| parent | c991b1d587e8ab3b080e2e6762646efe00e05bc5 (diff) | |
| download | forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar.gz forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar.bz2 forums-19b9df7e630031e3bdf0640a91f7025da3a00257.tar.xz forums-19b9df7e630031e3bdf0640a91f7025da3a00257.zip | |
[ticket/12557] Fix doc block errors found by Sami
PHPBB3-12557
Diffstat (limited to 'phpBB/phpbb/session.php')
| -rw-r--r-- | phpBB/phpbb/session.php | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/phpBB/phpbb/session.php b/phpBB/phpbb/session.php index 59b7ec2029..bfcd3368fa 100644 --- a/phpBB/phpbb/session.php +++ b/phpBB/phpbb/session.php @@ -1062,11 +1062,13 @@ class session * Check for banned user * * Checks whether the supplied user is banned by id, ip or email. If no parameters - * are passed to the method pre-existing session data is used. If $return is false - * this routine does not return on finding a banned user, it outputs a relevant - * message and stops execution. + * are passed to the method pre-existing session data is used. * - * @param string|array $user_ips Can contain a string with one IP or an array of multiple IPs + * @param int|false $user_id The user id + * @param string|array|false $user_ips Can contain a string with one IP or an array of multiple IPs + * @param string|false $user_email The user email + * @param bool $return If $return is false this routine does not return on finding a banned user, + * it outputs a relevant message and stops execution. */ function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false) { @@ -1254,12 +1256,14 @@ class session /** * Check if ip is blacklisted - * This should be called only where absolutly necessary + * This should be called only where absolutely necessary * * Only IPv4 (rbldns does not support AAAA records/IPv6 lookups) * * @author satmd (from the php manual) - * @param string $mode register/post - spamcop for example is ommitted for posting + * @param string $mode register/post - spamcop for example is ommitted for posting + * @param string|false $ip the IPv4 address to check + * * @return false if ip is not blacklisted, else an array([checked server], [lookup]) */ function check_dnsbl($mode, $ip = false) |