Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
StudygroupModel Class Reference

Static Public Member Functions

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 isStudygroup ($sem_id)
 
static applicationNotice ($sem_id, $user_id)
 

Member Function Documentation

static accept_user (   $username,
  $sem_id 
)
static

allows an user to access a "closed" studygroup

Parameters
stringusername
stringid of a studygroup
static addFounder (   $username,
  $sem_id 
)
static

adds a founder to a given studygroup

Parameters
stringusername
stringid of a studygroup
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_idid of a seminar / studygroup
string$user_idid of the applicant
Returns
int number of recipients
static cancelInvitation (   $username,
  $sem_id 
)
static

cancels invitation.

Parameters
stringusername
stringid of a studygroup
static countGroups (   $search = null,
  $closed_groups = null 
)
static

retrieves the count of all studygroups

Parameters
string$searchSearch term
mixed$closed_groupsDisplay closed groups
Returns
int count
static countMembers (   $semid)
static

returns the count of members for a given studygroup

Parameters
stringid of a studygroup
Returns
int count
static deny_user (   $username,
  $sem_id 
)
static

denies access to a "closed" studygroup for an user

Parameters
stringusername
stringid of a studygroup
Returns
void
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$sortSort criteria
int$lower_boundLower bound of the resultset
int$elements_per_pageElements per page, if null get the global configuration value
string$searchSearch term
mixed$closed_groupsDisplay closed groups
Returns
array studygroups
static getFounder (   $semid)
static

get founder for a given studgroup

Parameters
stringid of a studygroup
Returns
array founder
static getFounders (   $sem_id)
static

get founders of a given studygroup

Parameters
stringid of a studygroup
Returns
array founders
static getInstitutes ( )
static

retrieves all institues suitbable for an admin wrt global studygroup settings

Returns
array institutes
static getInvitations (   $sem_id)
static

returns invited member of a given studygroup.

Parameters
stringid of a studygroup
Returns
array invited members
static getMembers (   $sem_id,
  $lower_bound = 1,
  $elements_per_page = null 
)
static

retrieves all members of a given studygroup in a paged manner

Parameters
stringid of a studygroup
intlower bound of the resultset
intelements per page, if null get the global configuration value
Returns
array members
static inviteMember (   $user_id,
  $sem_id 
)
static

invites a member to a given studygroup.

Parameters
stringuser id
stringid of a studygroup
static isInvited (   $user_id,
  $sem_id 
)
static

checks if a user is already invited.

Parameters
stringuser id
stringid of a studygroup
Returns
array invited members
static isMember (   $userid,
  $semid 
)
static

checks whether a user is a member of a studygroup

Parameters
stringid of a user
stringid of a studygroup
Returns
boolean membership
static isStudygroup (   $sem_id)
static

Checks for a given seminar_id whether a course is a studygroup

Parameters
stringid of a seminar
Returns
array studygroup
static promote_user (   $username,
  $sem_id,
  $perm 
)
static

promotes an user in a studygroup wrt to a given perm

Parameters
stringusername
stringid of a studygroup
stringperm
Returns
void
static remove_user (   $username,
  $sem_id 
)
static

removes a user of a studygroup

Parameters
stringusername
stringid of a studygroup
Returns
void
static removeFounder (   $username,
  $sem_id 
)
static

removes a founder from a given studygroup

Parameters
stringusername
stringid of a studygroup

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