StudygroupModel Class Reference

Collaboration diagram for StudygroupModel:

Public Member Functions
	getInstalledPlugins ()
	getInstalledModules ()
	getAvailability ($modules)
	getAvailableModules ()
	getAvailablePlugins ()
	getEnabledPlugins ($id)
	getInstitutes ()
	accept_user ($username, $sem_id)
	deny_user ($username, $sem_id)
	promote_user ($username, $sem_id, $perm)
	remove_user ($username, $sem_id)
	countGroups ($search=null)
	getAllGroups ($sort= '', $lower_bound=1, $elements_per_page=20, $search=null)
	countMembers ($semid)
	getFounder ($semid)
	isMember ($userid, $semid)
	addFounder ($username, $sem_id)
	removeFounder ($username, $sem_id)
	getFounders ($sem_id)
	getMembers ($sem_id, $lower_bound=1, $elements_per_page=20)
	compare_status ($a, $b)
	isStudygroup ($sem_id)

Member Function Documentation

accept_user	(		$username,
			$sem_id
	)

allows an user to access a "closed" studygroup

Parameters

string	username
string	id of a studygroup

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

addFounder	(		$username,
			$sem_id
	)

adds a founder to a given studygroup

Parameters

string	username
string	id of a studygroup

Returns

void

Here is the call graph for this function:

compare_status	(		$a,
			$b
	)

callback function - used to compare sequences of studygroup statuses

Parameters

array	status a
array	status b

return int ordering

countGroups

(

$search = null

)

retrieves the count of all studygroups

param string search a filter term

Returns

string count

Here is the call graph for this function:

Here is the caller graph for this function:

countMembers

(

$semid

)

returns the count of members for a given studygroup

Parameters

string

id of a studygroup

Returns

int count

Here is the call graph for this function:

Here is the caller graph for this function:

deny_user	(		$username,
			$sem_id
	)

denies access to a "closed" studygroup for an user

Parameters

string	username
string	id of a studygroup

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

getAllGroups	(		$sort = '',
			$lower_bound = 1,
			$elements_per_page = 20,
			$search = null
	)

get all studygroups in a paged manner wrt a stort criteria and a search term

Parameters

string	sort criteria
int	lower bound of the resultset
int	elements per page / resultset
string	search term

Returns

array studygroups

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailability

(

$modules

)

gets the availability for a set of given modules

Parameters

array

modules

Returns

array enabled modules

Here is the caller graph for this function:

getAvailableModules

(

)

gets all available modules

Returns

array avialable modules

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailablePlugins

(

)

gets all available plugins

Returns

array avialable plugins

Here is the call graph for this function:

Here is the caller graph for this function:

getEnabledPlugins

(

$id

)

gets enabled plugins for a given studygroup

Parameters

string

id of a studygroup

Returns

array enabled plugins

Here is the call graph for this function:

Here is the caller graph for this function:

getFounder

(

$semid

)

get founder for a given studgroup

Parameters

string

id of a studygroup

Returns

array founder

Here is the call graph for this function:

Here is the caller graph for this function:

getFounders

(

$sem_id

)

get founders of a given studygroup

Parameters

string

id of a studygroup

Returns

array founders

Here is the call graph for this function:

Here is the caller graph for this function:

getInstalledModules

(

)

retrieves all modules

Returns

array modules

Here is the caller graph for this function:

getInstalledPlugins

(

)

retrieves all installed plugins

Returns

array modules a set of all plugins

Here is the call graph for this function:

Here is the caller graph for this function:

getInstitutes

(

)

retrieves all institues suitbable for an admin wrt global studygroup settings

Returns

array institutes

Here is the call graph for this function:

Here is the caller graph for this function:

getMembers	(		$sem_id,
			$lower_bound = 1,
			$elements_per_page = 20
	)

retrieves all members of a given studygroup in a paged manner

Parameters

string	id of a studygroup
int	lower bound of the resultset
int	elements per page / resultset

Returns

array members

Here is the call graph for this function:

Here is the caller graph for this function:

isMember	(		$userid,
			$semid
	)

checks whether a user is a member of a studygroup

Parameters

string	id of a user
string	id of a studygroup

Returns

boolean membership

Here is the call graph for this function:

isStudygroup

(

$sem_id

)

Checks for a given seminar_id whether a course is a studygroup

Parameters

string

id of a seminar

Returns

array studygroup

Here is the call graph for this function:

promote_user	(		$username,
			$sem_id,
			$perm
	)

promotes an user in a studygroup wrt to a given perm

Parameters

string	username
string	id of a studygroup
string	perm

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

remove_user	(		$username,
			$sem_id
	)

removes a user of a studygroup

Parameters

string	username
string	id of a studygroup

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

removeFounder	(		$username,
			$sem_id
	)

removes a founder from a given studygroup

Parameters

string	username
string	id of a studygroup

Returns

void

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• app/models/studygroup.php