[Pkg-owncloud-commits] [owncloud] 68/153: PHPDoc fixes for user_ldap
David Prévot
taffit at moszumanska.debian.org
Tue May 27 03:05:37 UTC 2014
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch master
in repository owncloud.
commit a17f9111a087055306f8aabf1b4a0c4aca9684e8
Author: Robin McCorkell <rmccorkell at karoshi.org.uk>
Date: Thu May 15 13:12:17 2014 +0100
PHPDoc fixes for user_ldap
---
apps/user_ldap/group_ldap.php | 4 ++--
apps/user_ldap/group_proxy.php | 12 ++++++------
apps/user_ldap/lib/access.php | 30 +++++++++++++++---------------
apps/user_ldap/lib/ildapwrapper.php | 2 +-
apps/user_ldap/lib/jobs.php | 6 +++---
apps/user_ldap/user_ldap.php | 2 +-
apps/user_ldap/user_proxy.php | 2 +-
7 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/apps/user_ldap/group_ldap.php b/apps/user_ldap/group_ldap.php
index c868e17..da06062 100644
--- a/apps/user_ldap/group_ldap.php
+++ b/apps/user_ldap/group_ldap.php
@@ -286,8 +286,8 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
/**
* @brief returns the number of users in a group, who match the search term
- * @param string the internal group name
- * @param string optional, a search string
+ * @param string $gid the internal group name
+ * @param string $search optional, a search string
* @return int | bool
*/
public function countUsersInGroup($gid, $search = '') {
diff --git a/apps/user_ldap/group_proxy.php b/apps/user_ldap/group_proxy.php
index 555587b..672e8a6 100644
--- a/apps/user_ldap/group_proxy.php
+++ b/apps/user_ldap/group_proxy.php
@@ -31,7 +31,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief Constructor
- * @param array $serverConfigPrefixes array containing the config Prefixes
+ * @param string[] $serverConfigPrefixes array containing the config Prefixes
*/
public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) {
parent::__construct($ldap);
@@ -109,7 +109,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief Get all groups a user belongs to
* @param string $uid Name of the user
- * @return array with group names
+ * @return string[] with group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
@@ -129,7 +129,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief get a list of all users in a group
- * @return array with user ids
+ * @return string[] with user ids
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
$users = array();
@@ -146,8 +146,8 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief returns the number of users in a group, who match the search term
- * @param string the internal group name
- * @param string optional, a search string
+ * @param string $gid the internal group name
+ * @param string $search optional, a search string
* @return int | bool
*/
public function countUsersInGroup($gid, $search = '') {
@@ -157,7 +157,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief get a list of all groups
- * @return array with group names
+ * @return string[] with group names
*
* Returns a list with all groups
*/
diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php
index 0097c94..957a7c2 100644
--- a/apps/user_ldap/lib/access.php
+++ b/apps/user_ldap/lib/access.php
@@ -631,7 +631,7 @@ class Access extends LDAPUtility {
/**
* @param string $filter
- * @param string $attr
+ * @param string|string[] $attr
* @param int $limit
* @param int $offset
* @return array
@@ -642,7 +642,7 @@ class Access extends LDAPUtility {
/**
* @param string $filter
- * @param string $attr
+ * @param string|string[] $attr
* @param int $limit
* @param int $offset
* @return array
@@ -672,7 +672,7 @@ class Access extends LDAPUtility {
/**
* @brief executes an LDAP search, optimized for Users
* @param string $filter the LDAP filter for the search
- * @param string $attr optional, when a certain attribute shall be filtered out
+ * @param string|string[] $attr optional, when a certain attribute shall be filtered out
* @param integer $limit
* @param integer $offset
* @return array with the search result
@@ -685,7 +685,7 @@ class Access extends LDAPUtility {
/**
* @param string $filter
- * @param array $attr
+ * @param string|string[] $attr
* @param int $limit
* @param int $offset
* @return false|int
@@ -697,7 +697,7 @@ class Access extends LDAPUtility {
/**
* @brief executes an LDAP search, optimized for Groups
* @param string $filter the LDAP filter for the search
- * @param string $attr optional, when a certain attribute shall be filtered out
+ * @param string|string[] $attr optional, when a certain attribute shall be filtered out
* @param integer $limit
* @param integer $offset
* @return array with the search result
@@ -712,7 +712,7 @@ class Access extends LDAPUtility {
* @brief prepares and executes an LDAP search operation
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
- * @param array $attr optional, array, one or more attributes that shall be
+ * @param string|string[] $attr optional, array, one or more attributes that shall be
* retrieved. Results will according to the order in the array.
* @param int $limit optional, maximum results to be counted
* @param int $offset optional, a starting point
@@ -799,7 +799,7 @@ class Access extends LDAPUtility {
* @brief executes an LDAP search, but counts the results only
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
- * @param array $attr optional, array, one or more attributes that shall be
+ * @param string|string[] $attr optional, array, one or more attributes that shall be
* retrieved. Results will according to the order in the array.
* @param int $limit optional, maximum results to be counted
* @param int $offset optional, a starting point
@@ -864,7 +864,7 @@ class Access extends LDAPUtility {
* @brief Executes an LDAP search
* @param string $filter the LDAP filter for the search
* @param array $base an array containing the LDAP subtree(s) that shall be searched
- * @param array $attr optional, array, one or more attributes that shall be
+ * @param string|string[] $attr optional, array, one or more attributes that shall be
* @param int $limit
* @param int $offset
* @param bool $skipHandling
@@ -1003,7 +1003,7 @@ class Access extends LDAPUtility {
/**
* @brief combines the input filters with AND
- * @param array $filters the filters to connect
+ * @param string[] $filters the filters to connect
* @return string the combined filter
*/
public function combineFilterWithAnd($filters) {
@@ -1012,7 +1012,7 @@ class Access extends LDAPUtility {
/**
* @brief combines the input filters with AND
- * @param array $filters the filters to connect
+ * @param string[] $filters the filters to connect
* @return string the combined filter
*/
public function combineFilterWithOr($filters) {
@@ -1021,7 +1021,7 @@ class Access extends LDAPUtility {
/**
* @brief combines the input filters with given operator
- * @param array $filters the filters to connect
+ * @param string[] $filters the filters to connect
* @param string $operator either & or |
* @return string the combined filter
*/
@@ -1062,7 +1062,7 @@ class Access extends LDAPUtility {
/**
* @brief creates a filter part for searches
* @param string $search the search term
- * @param array|null $searchAttributes
+ * @param string[]|null $searchAttributes
* @param string $fallbackAttribute a fallback attribute in case the user
* did not define search attributes. Typically the display name attribute.
* @return string the final filter part to use in LDAP searches
@@ -1220,7 +1220,7 @@ class Access extends LDAPUtility {
/**
* @brief checks if the given DN is part of the given base DN(s)
* @param string $dn the DN
- * @param array $bases array containing the allowed base DN or DNs
+ * @param string[] $bases array containing the allowed base DN or DNs
* @return bool
*/
private function isDNPartOfBase($dn, $bases) {
@@ -1293,8 +1293,8 @@ class Access extends LDAPUtility {
/**
* @brief Prepares a paged search, if possible
* @param string $filter the LDAP filter for the search
- * @param array $bases an array containing the LDAP subtree(s) that shall be searched
- * @param array $attr optional, when a certain attribute shall be filtered outside
+ * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched
+ * @param string[] $attr optional, when a certain attribute shall be filtered outside
* @param int $limit
* @param int $offset
* @return bool|true
diff --git a/apps/user_ldap/lib/ildapwrapper.php b/apps/user_ldap/lib/ildapwrapper.php
index e26fdfd..e17f787 100644
--- a/apps/user_ldap/lib/ildapwrapper.php
+++ b/apps/user_ldap/lib/ildapwrapper.php
@@ -162,7 +162,7 @@ interface ILDAPWrapper {
/**
* @brief establish Start TLS
- * @param resource|$link LDAP link resource
+ * @param resource $link LDAP link resource
* @return bool true on success, false otherwise
*/
public function startTls($link);
diff --git a/apps/user_ldap/lib/jobs.php b/apps/user_ldap/lib/jobs.php
index dd9d1ee..34977dd 100644
--- a/apps/user_ldap/lib/jobs.php
+++ b/apps/user_ldap/lib/jobs.php
@@ -69,7 +69,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
}
/**
- * @param array $groups
+ * @param string[] $groups
*/
static private function handleKnownGroups($groups) {
\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
@@ -107,7 +107,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
}
/**
- * @param array $createdGroups
+ * @param string[] $createdGroups
*/
static private function handleCreatedGroups($createdGroups) {
\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
@@ -129,7 +129,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
}
/**
- * @param array $removedGroups
+ * @param string[] $removedGroups
*/
static private function handleRemovedGroups($removedGroups) {
\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
diff --git a/apps/user_ldap/user_ldap.php b/apps/user_ldap/user_ldap.php
index 2d44072..ba622a2 100644
--- a/apps/user_ldap/user_ldap.php
+++ b/apps/user_ldap/user_ldap.php
@@ -200,7 +200,7 @@ class USER_LDAP extends BackendUtility implements \OCP\UserInterface {
/**
* @brief Get a list of all users
- * @return array with all uids
+ * @return string[] with all uids
*
* Get a list of all users.
*/
diff --git a/apps/user_ldap/user_proxy.php b/apps/user_ldap/user_proxy.php
index 412d6a0..a134d1c 100644
--- a/apps/user_ldap/user_proxy.php
+++ b/apps/user_ldap/user_proxy.php
@@ -119,7 +119,7 @@ class User_Proxy extends lib\Proxy implements \OCP\UserInterface {
/**
* @brief Get a list of all users
- * @return array with all uids
+ * @return string[] with all uids
*
* Get a list of all users.
*/
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git
More information about the Pkg-owncloud-commits
mailing list