summaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/group_proxy.php
diff options
context:
space:
mode:
authorRobin McCorkell <rmccorkell@karoshi.org.uk>2014-05-13 12:29:25 +0100
committerRobin McCorkell <rmccorkell@karoshi.org.uk>2014-05-16 22:21:57 +0100
commitc4f1de63a8ebe137566e034641b7bc3b05a05058 (patch)
treec238bc352ad6507bd40de7ed8eecedd03c470ce2 /apps/user_ldap/group_proxy.php
parent42b99b6d0fbcaf54b3cf3b3c9be5bc8a9c7a2e12 (diff)
downloadnextcloud-server-c4f1de63a8ebe137566e034641b7bc3b05a05058.tar.gz
nextcloud-server-c4f1de63a8ebe137566e034641b7bc3b05a05058.zip
Fix PHPDoc in /apps
Diffstat (limited to 'apps/user_ldap/group_proxy.php')
-rw-r--r--apps/user_ldap/group_proxy.php36
1 files changed, 18 insertions, 18 deletions
diff --git a/apps/user_ldap/group_proxy.php b/apps/user_ldap/group_proxy.php
index ea94990ffe4..555587b1bfa 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 $serverConfigPrefixes array containing the config Prefixes
+ * @param array $serverConfigPrefixes array containing the config Prefixes
*/
public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) {
parent::__construct($ldap);
@@ -46,9 +46,9 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief Tries the backends one after the other until a positive result is returned from the specified method
- * @param $gid string, the gid connected to the request
- * @param $method string, the method of the group backend that shall be called
- * @param $parameters an array of parameters to be passed
+ * @param string $gid the gid connected to the request
+ * @param string $method the method of the group backend that shall be called
+ * @param array $parameters an array of parameters to be passed
* @return mixed, the result of the method or false
*/
protected function walkBackends($gid, $method, $parameters) {
@@ -64,10 +64,10 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief Asks the backend connected to the server that supposely takes care of the gid from the request.
- * @param $gid string, the gid connected to the request
- * @param $method string, the method of the group backend that shall be called
- * @param $parameters an array of parameters to be passed
- * @param $passOnWhen the result matches this variable
+ * @param string $gid the gid connected to the request
+ * @param string $method the method of the group backend that shall be called
+ * @param array $parameters an array of parameters to be passed
+ * @param mixed $passOnWhen the result matches this variable
* @return mixed, the result of the method or false
*/
protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) {
@@ -96,9 +96,9 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief is user in group?
- * @param $uid uid of the user
- * @param $gid gid of the group
- * @returns true/false
+ * @param string $uid uid of the user
+ * @param string $gid gid of the group
+ * @return bool
*
* Checks whether the user is member of a group or not.
*/
@@ -108,8 +108,8 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief Get all groups a user belongs to
- * @param $uid Name of the user
- * @returns array with group names
+ * @param string $uid Name of the user
+ * @return array 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
- * @returns array with user ids
+ * @return array with user ids
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
$users = array();
@@ -148,7 +148,7 @@ 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
- * @returns int | bool
+ * @return int | bool
*/
public function countUsersInGroup($gid, $search = '') {
return $this->handleRequest(
@@ -157,7 +157,7 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief get a list of all groups
- * @returns array with group names
+ * @return array with group names
*
* Returns a list with all groups
*/
@@ -185,8 +185,8 @@ class Group_Proxy extends lib\Proxy implements \OCP\GroupInterface {
/**
* @brief Check if backend implements actions
- * @param $actions bitwise-or'ed actions
- * @returns boolean
+ * @param int $actions bitwise-or'ed actions
+ * @return boolean
*
* Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc.