aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/auth
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2014-08-07 12:43:45 +0200
committerJoas Schilling <nickvergessen@gmx.de>2014-08-07 12:43:45 +0200
commit2f44a865a01d1c9d1198484c7a9e841c22ef267d (patch)
tree1af5a8b36be1540192b3c69d4a5494e4a5e59d65 /phpBB/phpbb/auth
parent83544992ecc013a2ab0a9b7f9f8329853fb2f212 (diff)
parentcea0cfa6f8f41ebeb73a0a90f789bfb4190009b6 (diff)
downloadforums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar
forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar.gz
forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar.bz2
forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.tar.xz
forums-2f44a865a01d1c9d1198484c7a9e841c22ef267d.zip
Merge pull request #2477 from n-aleha/ticket/12557ascraeus
[ticket/12557] Fix doc block errors found by Sami for ascraeus * n-aleha/ticket/12557ascraeus: [ticket/12557] Fix load active module description [ticket/12557] Fix php file description [ticket/12557] Fix post data description for notifications [ticket/12557] Fix pass by reference doc blocks [ticket/12557] Fix doc block in extension base class [ticket/12557] Fix doc block in mimetype guesser [ticket/12557] Fix var $preserve_cr description [ticket/12557] Fix doc block errors found by Sami [ticket/12557] Fix doc block errors found by Sami [ticket/12557] Fix doc block errors found by Sami [ticket/12557] Template fixes [ticket/12557] Search, cron and profilefields fixes [ticket/12557] Notification fixes [ticket/12557] Fix doc block errors found by Sami pt1 [ticket/12557] Fix doc block errors found by Sami [ticket/12557] Fix doc block errors found by Sami
Diffstat (limited to 'phpBB/phpbb/auth')
-rw-r--r--phpBB/phpbb/auth/auth.php7
-rw-r--r--phpBB/phpbb/auth/provider/apache.php14
-rw-r--r--phpBB/phpbb/auth/provider/ldap.php8
3 files changed, 16 insertions, 13 deletions
diff --git a/phpBB/phpbb/auth/auth.php b/phpBB/phpbb/auth/auth.php
index 65249275d4..38755ccf99 100644
--- a/phpBB/phpbb/auth/auth.php
+++ b/phpBB/phpbb/auth/auth.php
@@ -208,9 +208,12 @@ class auth
/**
* Get forums with the specified permission setting
- * if the option is prefixed with !, then the result becomes negated
*
- * @param bool $clean set to true if only values needs to be returned which are set/unset
+ * @param string $opt The permission name to lookup. If prefixed with !, the result is negated.
+ * @param bool $clean set to true if only values needs to be returned which are set/unset
+ *
+ * @return array Contains the forum ids with the specified permission set to true.
+ This is a nested array: array => forum_id => permission => true
*/
function acl_getf($opt, $clean = false)
{
diff --git a/phpBB/phpbb/auth/provider/apache.php b/phpBB/phpbb/auth/provider/apache.php
index 4f44efe9af..9137a77210 100644
--- a/phpBB/phpbb/auth/provider/apache.php
+++ b/phpBB/phpbb/auth/provider/apache.php
@@ -28,13 +28,13 @@ class apache extends \phpbb\auth\provider\base
/**
* Apache Authentication Constructor
*
- * @param \phpbb\db\driver\driver_interface $db
- * @param \phpbb\config\config $config
- * @param \phpbb\passwords\manager $passwords_manager
- * @param \phpbb\request\request $request
- * @param \phpbb\user $user
- * @param string $phpbb_root_path
- * @param string $php_ext
+ * @param \phpbb\db\driver\driver_interface $db Database object
+ * @param \phpbb\config\config $config Config object
+ * @param \phpbb\passwords\manager $passwords_manager Passwords Manager object
+ * @param \phpbb\request\request $request Request object
+ * @param \phpbb\user $user User object
+ * @param string $phpbb_root_path Relative path to phpBB root
+ * @param string $php_ext PHP file extension
*/
public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext)
{
diff --git a/phpBB/phpbb/auth/provider/ldap.php b/phpBB/phpbb/auth/provider/ldap.php
index e7764b754b..d32e7504eb 100644
--- a/phpBB/phpbb/auth/provider/ldap.php
+++ b/phpBB/phpbb/auth/provider/ldap.php
@@ -29,10 +29,10 @@ class ldap extends \phpbb\auth\provider\base
/**
* LDAP Authentication Constructor
*
- * @param \phpbb\db\driver\driver_interface $db
- * @param \phpbb\config\config $config
- * @param \phpbb\passwords\manager $passwords_manager
- * @param \phpbb\user $user
+ * @param \phpbb\db\driver\driver_interface $db Database object
+ * @param \phpbb\config\config $config Config object
+ * @param \phpbb\passwords\manager $passwords_manager Passwords manager object
+ * @param \phpbb\user $user User object
*/
public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\user $user)
{