Fix PHPDoc and typos

Some things my IDE complained about while creating a custom backend.

Fix PHPDoc and typos

Some things my IDE complained about while creating a custom backend.

Conflicts:
	lib/private/group/database.php
	lib/private/group/dummy.php
	lib/private/group/example.php
This commit is contained in:
Lukas Reschke 2014-05-10 22:32:13 +02:00 committed by Robin McCorkell
parent 3bed3d2a23
commit 7e448a376f
4 changed files with 27 additions and 15 deletions

View File

@ -69,7 +69,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
/**
* @brief Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
* @return bool
*
* Returns the supported actions as int to be
* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.

View File

@ -215,9 +215,8 @@ class OC_Group_Database extends OC_Group_Backend {
* @brief get the number of all users matching the search string in a group
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return int|false
* @throws DatabaseException
*/
public function countUsersInGroup($gid, $search = '') {
$stmt = OC_DB::prepare('SELECT COUNT(`uid`) AS `count` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?');

View File

@ -31,7 +31,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
* @param string $gid The name of the group to create
* @return bool
*
* Trys to create a new group. If the group name already exists, false will
* Tries to create a new group. If the group name already exists, false will
* be returned.
*/
public function createGroup($gid) {
@ -136,18 +136,23 @@ class OC_Group_Dummy extends OC_Group_Backend {
}
/**
* @brief get a list of all groups
* @brief Get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of group names
*
* Returns a list with all groups
*/
public function getGroups($search = '', $limit = -1, $offset = 0) {
return array_keys($this->groups);
}
/**
* @brief get a list of all users in a group
* @return array an array of user ids
* @brief Get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of user IDs
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
if(isset($this->groups[$gid])) {
@ -159,7 +164,11 @@ class OC_Group_Dummy extends OC_Group_Backend {
/**
* @brief get the number of all users in a group
* @return int|bool
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return int
*/
public function countUsersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
if(isset($this->groups[$gid])) {

View File

@ -31,7 +31,7 @@ abstract class OC_Group_Example {
* @param string $gid The name of the group to create
* @return bool
*
* Trys to create a new group. If the group name already exists, false will
* Tries to create a new group. If the group name already exists, false will
* be returned.
*/
abstract public static function createGroup($gid);
@ -87,14 +87,15 @@ abstract class OC_Group_Example {
/**
* @brief get a list of all groups
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of group names
*
* Returns a list with all groups
*/
abstract public static function getGroups($search = '', $limit = -1, $offset = 0);
/**
* check if a group exists
* @brief Check if a group exists
* @param string $gid
* @return bool
*/
@ -102,8 +103,11 @@ abstract class OC_Group_Example {
/**
* @brief get a list of all users in a group
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array an array of user ids
*/
abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
}