[feature/auth-refactor] Fix comment block indentation

Comment block indentation was off by one space on the provider_*
files due to being incorrectly copied over from the auth_* files.

PHPBB3-9734
This commit is contained in:
Joseph Warner 2013-06-18 15:32:18 -04:00
parent e64abea999
commit db27a8c67a
3 changed files with 58 additions and 58 deletions

View file

@ -23,12 +23,12 @@ if (!defined('IN_PHPBB'))
class phpbb_auth_provider_apache implements phpbb_auth_provider_interface
{
/**
* Checks whether the user is identified to apache
* Only allow changing authentication to apache if the user is identified
* Called in acp_board while setting authentication plugins
*
* @return boolean|string false if the user is identified and else an error message
*/
* Checks whether the user is identified to apache
* Only allow changing authentication to apache if the user is identified
* Called in acp_board while setting authentication plugins
*
* @return boolean|string false if the user is identified and else an error message
*/
public function init()
{
global $user, $request;
@ -41,8 +41,8 @@ class phpbb_auth_provider_apache implements phpbb_auth_provider_interface
}
/**
* Login function
*/
* Login function
*/
public function login(&$username, &$password)
{
global $db, $request;
@ -133,11 +133,11 @@ class phpbb_auth_provider_apache implements phpbb_auth_provider_interface
}
/**
* Autologin function
*
* @return array containing the user row or empty if no auto login should
* take place
*/
* Autologin function
*
* @return array containing the user row or empty if no auto login should
* take place
*/
public function autologin()
{
global $db, $request;
@ -194,14 +194,14 @@ class phpbb_auth_provider_apache implements phpbb_auth_provider_interface
}
/**
* This function generates an array which can be passed to the user_add
* function in order to create a user
*
* @param str $username The username of the new user.
* @param str $password The password of the new user.
* @return array Contains data that can be passed directly to
* the user_add function.
*/
* This function generates an array which can be passed to the user_add
* function in order to create a user
*
* @param str $username The username of the new user.
* @param str $password The password of the new user.
* @return array Contains data that can be passed directly to
* the user_add function.
*/
private function user_row($username, $password)
{
global $db, $config, $user;
@ -232,11 +232,11 @@ class phpbb_auth_provider_apache implements phpbb_auth_provider_interface
}
/**
* The session validation function checks whether the user is still logged in
*
* @return boolean true if the given user is authenticated or false if
* the session should be closed
*/
* The session validation function checks whether the user is still logged in
*
* @return boolean true if the given user is authenticated or false if
* the session should be closed
*/
public function validate_session(&$user)
{
global $request;

View file

@ -30,21 +30,21 @@ class phpbb_auth_provider_db implements phpbb_auth_provider_interface
}
/**
* Login function
*
* @param string $username
* @param string $password
* @param string $ip IP address the login is taking place from. Used to
* limit the number of login attempts per IP address.
* @param string $browser The user agent used to login
* @param string $forwarded_for X_FORWARDED_FOR header sent with login request
* @return array A associative array of the format
* array(
* 'status' => status constant
* 'error_msg' => string
* 'user_row' => array
* )
*/
* Login function
*
* @param string $username
* @param string $password
* @param string $ip IP address the login is taking place from. Used to
* limit the number of login attempts per IP address.
* @param string $browser The user agent used to login
* @param string $forwarded_for X_FORWARDED_FOR header sent with login request
* @return array A associative array of the format
* array(
* 'status' => status constant
* 'error_msg' => string
* 'user_row' => array
* )
*/
public function login($username, $password, $ip = '', $browser = '', $forwarded_for = '')
{
global $db, $config;

View file

@ -25,10 +25,10 @@ if (!defined('IN_PHPBB'))
class phpbb_auth_provider_db implements phpbb_auth_provider_interface
{
/**
* Connect to ldap server
* Only allow changing authentication to ldap if we can connect to the ldap server
* Called in acp_board while setting authentication plugins
*/
* Connect to ldap server
* Only allow changing authentication to ldap if we can connect to the ldap server
* Called in acp_board while setting authentication plugins
*/
public function init()
{
global $config, $user;
@ -100,8 +100,8 @@ class phpbb_auth_provider_db implements phpbb_auth_provider_interface
}
/**
* Login function
*/
* Login function
*/
public function login(&$username, &$password)
{
global $db, $config, $user;
@ -278,9 +278,9 @@ class phpbb_auth_provider_db implements phpbb_auth_provider_interface
public function autologin();
/**
* This function is used to output any required fields in the authentication
* admin panel. It also defines any required configuration table fields.
*/
* This function is used to output any required fields in the authentication
* admin panel. It also defines any required configuration table fields.
*/
public function acp(&$new)
{
global $user;
@ -329,12 +329,12 @@ class phpbb_auth_provider_db implements phpbb_auth_provider_interface
}
/**
* Generates a filter string for ldap_search to find a user
*
* @param $username string Username identifying the searched user
*
* @return string A filter string for ldap_search
*/
* Generates a filter string for ldap_search to find a user
*
* @param $username string Username identifying the searched user
*
* @return string A filter string for ldap_search
*/
public function user_filter($username)
{
global $config;
@ -349,8 +349,8 @@ class phpbb_auth_provider_db implements phpbb_auth_provider_interface
}
/**
* Escapes an LDAP AttributeValue
*/
* Escapes an LDAP AttributeValue
*/
public function escape($string)
{
return str_replace(array('*', '\\', '(', ')'), array('\\*', '\\\\', '\\(', '\\)'), $string);