MetaData¶

class OC\Group\MetaData¶

Source:	lib/private/Group/MetaData.php#38

Constants¶

SORT_NONE = 0

Source:	lib/private/Group/MetaData.php#39

SORT_USERCOUNT = 1

Source:	lib/private/Group/MetaData.php#40

SORT_GROUPNAME = 2

Source:	lib/private/Group/MetaData.php#41

Properties¶

protected static property OC\Group\MetaData::$user¶

Source:	lib/private/Group/MetaData.php#44
Type:	string

protected static property OC\Group\MetaData::$isAdmin¶

Source:	lib/private/Group/MetaData.php#46
Type:	bool

protected static property OC\Group\MetaData::$metaData¶

Source:	lib/private/Group/MetaData.php#48
Type:	array

protected static property OC\Group\MetaData::$groupManager¶

Source:	lib/private/Group/MetaData.php#50
Type:	`\OC\Group\Manager`

protected static property OC\Group\MetaData::$sorting¶

Source:	lib/private/Group/MetaData.php#52
Type:	bool

protected static property OC\Group\MetaData::$userSession¶

Source:	lib/private/Group/MetaData.php#54
Type:	`\OCP\IUserSession`

Methods¶

public OC\Group\MetaData::__construct($user, $isAdmin, $groupManager, $userSession)¶

Source:	lib/private/Group/MetaData.php#62
Parameters:	$user (string) the uid of the current user $isAdmin (bool) whether the current users is an admin $groupManager (`OCP\IGroupManager`) $userSession (`OCP\IUserSession`)

public OC\Group\MetaData::get($groupSearch="", $userSearch="")¶

returns an array with meta data about all available groups
the array is structured as follows:
[0] array containing meta data about admin groups
[1] array containing meta data about unprivileged groups

Source:

lib/private/Group/MetaData.php#84

Parameters:

$groupSearch (string) only effective when instance was created with

isAdmin being true * $userSearch (string) the pattern users are search for

Returns:

array

public OC\Group\MetaData::setSorting($sortMode)¶

sets the sort mode, see SORT_* constants for supported modes

Source:	lib/private/Group/MetaData.php#130
Parameters:	$sortMode (int)

public OC\Group\MetaData::getGroups($search="")¶

returns the available groups

Source:	lib/private/Group/MetaData.php#196
Parameters:	$search (string) a search string
Returns:	`\OCP\IGroup[]`