Collaboration diagram for StudygroupModel:

Static Public Member Functions
static	getInstalledPlugins ()

static	getInstalledModules ()

static	getEnabledPlugins ($id)

static	getInstitutes ()

static	accept_user ($username, $sem_id)

static	deny_user ($username, $sem_id)

static	promote_user ($username, $sem_id, $perm)

static	remove_user ($username, $sem_id)

static	countGroups ($search=null, $closed_groups=null)

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

static	countMembers ($semid)

static	getFounder ($semid)

static	isMember ($userid, $semid)

static	addFounder ($username, $sem_id)

static	removeFounder ($username, $sem_id)

static	getFounders ($sem_id)

static	getMembers ($sem_id, $lower_bound=1, $elements_per_page=null)

static	inviteMember ($user_id, $sem_id)

static	cancelInvitation ($username, $sem_id)

static	getInvitations ($sem_id)

static	isInvited ($user_id, $sem_id)

static	compare_status ($a, $b)

static	isStudygroup ($sem_id)

static	applicationNotice ($sem_id, $user_id)

Member Function Documentation

◆ accept_user()

static accept_user	(	$username,
		$sem_id
	)

static

allows an user to access a "closed" studygroup

Parameters

string	username
string	id of a studygroup

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addFounder()

static addFounder	(	$username,
		$sem_id
	)

static

adds a founder to a given studygroup

Parameters

string	username
string	id of a studygroup

Here is the call graph for this function:

◆ applicationNotice()

static applicationNotice	(	$sem_id,
		$user_id
	)

static

If a new user applies, an application note to all moderators and founders of a studygroup will be automatically sent while calling this function. The note contains the user's name and a direct link to the member page of the studygroup.

Parameters

string	$sem_id	id of a seminar / studygroup
string	$user_id	id of the applicant

Returns: int number of recipients

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancelInvitation()

static cancelInvitation	(	$username,
		$sem_id
	)

static

cancels invitation.

Parameters

string	username
string	id of a studygroup

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compare_status()

static compare_status	(	$a,
		$b
	)

static

callback function - used to compare sequences of studygroup statuses

Parameters

array	status a
array	status b

Returns: int ordering

◆ countGroups()

static countGroups	(	$search = `null`,
		$closed_groups = `null`
	)

static

retrieves the count of all studygroups

Parameters

string	$search	Search term
mixed	$closed_groups	Display closed groups

Returns: int count

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countMembers()

static countMembers ( $semid )

static

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()

static deny_user	(	$username,
		$sem_id
	)

static

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()

static getAllGroups	(	$sort = `''`,
		$lower_bound = `1`,
		$elements_per_page = `null`,
		$search = `null`,
		$closed_groups = `null`
	)

static

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

Parameters

string	$sort	Sort criteria
int	$lower_bound	Lower bound of the resultset
int	$elements_per_page	Elements per page, if null get the global configuration value
string	$search	Search term
mixed	$closed_groups	Display closed groups

Returns: array studygroups

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEnabledPlugins()

static getEnabledPlugins ( $id )

static

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()

static getFounder ( $semid )

static

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()

static getFounders ( $sem_id )

static

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()

static getInstalledModules ( )

static

retrieves all modules

Returns: array modules

Here is the caller graph for this function:

◆ getInstalledPlugins()

static getInstalledPlugins ( )

static

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()

static getInstitutes ( )

static

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:

◆ getInvitations()

static getInvitations ( $sem_id )

static

returns invited member of a given studygroup.

Parameters

string id of a studygroup

Returns: array invited members

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembers()

static getMembers	(	$sem_id,
		$lower_bound = `1`,
		$elements_per_page = `null`
	)

static

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, if null get the global configuration value

Returns: array members

Here is the call graph for this function:

◆ inviteMember()

static inviteMember	(	$user_id,
		$sem_id
	)

static

invites a member to a given studygroup.

Parameters

string	user id
string	id of a studygroup

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInvited()

static isInvited	(	$user_id,
		$sem_id
	)

static

checks if a user is already invited.

Parameters

string	user id
string	id of a studygroup

Returns: array invited members

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMember()

static isMember	(	$userid,
		$semid
	)

static

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()

static isStudygroup ( $sem_id )

static

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()

static promote_user	(	$username,
		$sem_id,
		$perm
	)

static

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()

static remove_user	(	$username,
		$sem_id
	)

static

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()

static removeFounder	(	$username,
		$sem_id
	)

static

removes a founder from a given studygroup

Parameters

string	username
string	id of a studygroup

Here is the call graph for this function:

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

app/models/studygroup.php

Static Public Member Functions

Member Function Documentation

◆ accept_user()

◆ addFounder()

◆ applicationNotice()

◆ cancelInvitation()

◆ compare_status()

◆ countGroups()

◆ countMembers()

◆ deny_user()

◆ getAllGroups()

◆ getEnabledPlugins()

◆ getFounder()

◆ getFounders()

◆ getInstalledModules()

◆ getInstalledPlugins()

◆ getInstitutes()

◆ getInvitations()

◆ getMembers()

◆ inviteMember()

◆ isInvited()

◆ isMember()

◆ isStudygroup()

◆ promote_user()

◆ remove_user()

◆ removeFounder()