StudygroupModel Class Reference

Collaboration diagram for StudygroupModel:

Public Member Functions
	getInstalledPlugins ()
	getInstalledModules ()
	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=NULL, $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=NULL)
	inviteMember ($user_id, $sem_id)
	cancelInvitation ($username, $sem_id)
	getInvitations ($sem_id)
	isInvited ($user_id, $sem_id)
	compare_status ($a, $b)
	isStudygroup ($sem_id)
	applicationNotice ($sem_id, $user_id)

Member Function Documentation

accept_user()

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

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:

applicationNotice()

applicationNotice	(		$sem_id,
			$user_id
	)

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

cancelInvitation	(		$username,
			$sem_id
	)

cancels invitation.

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:

compare_status()

compare_status	(		$a,
			$b
	)

callback function - used to compare sequences of studygroup statuses

Parameters

array	status a
array	status b

return int ordering

countGroups()

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

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

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

getAllGroups	(		$sort = '',
			$lower_bound = 1,
			$elements_per_page = NULL,
			$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, if null get the global configuration value
string	search term

Returns

array studygroups

Here is the call graph for this function:

Here is the caller graph for this function:

getEnabledPlugins()

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

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

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

getInstalledModules

(

)

retrieves all modules

Returns

array modules

Here is the caller graph for this function:

getInstalledPlugins()

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

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:

getInvitations()

getInvitations

(

$sem_id

)

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

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

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:

Here is the caller graph for this function:

inviteMember()

inviteMember	(		$user_id,
			$sem_id
	)

invites a member to a given studygroup.

Parameters

string	user id
string	id of a studygroup

Returns

void

Here is the call graph for this function:

Here is the caller graph for this function:

isInvited()

isInvited	(		$user_id,
			$sem_id
	)

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

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

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

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

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

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