Skip to content

Commit f804a03

Browse files
committed
Include expectation for the getGroupDetails method
1 parent b618814 commit f804a03

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

lib/Group_LDAP.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1001,6 +1001,16 @@ public function groupExists($gid) {
10011001
return true;
10021002
}
10031003

1004+
/**
1005+
* Get the details of the target group. The details consist (as of now)
1006+
* of the gid and the displayname of the group. More data might be added
1007+
* accordingly to the interface.
1008+
* The method returns null on error (such as missing displayname, or
1009+
* missing group)
1010+
* @param string $gid the gid of the group we want to get the details of
1011+
* @return array|null an array containing the gid and the displayname such as
1012+
* ['gid' => 'abcdef', 'displayname' => 'my group']
1013+
*/
10041014
public function getGroupDetails($gid) {
10051015
$cacheKey = "groupDetails-$gid";
10061016
$details = $this->access->getConnection()->getFromCache($cacheKey);

0 commit comments

Comments
 (0)