MembersModel Class Reference

Collaboration diagram for MembersModel:

Public Member Functions
	__construct ($course_id, $course_title)
	setAdmissionVisibility ($user_id, $status)
	setVisibilty ($user_id, $status)
	setMemberStatus ($members, $status, $next_status, $direction)
	cancelSubscription ($users)
	cancelAdmissionSubscription ($users, $status)
	insertAdmissionMember ($users, $next_status, $consider_contingent, $accepted=null, $cmd='add_user')
	addMember ($user_id, $accepted=null, $consider_contingent=null, $cmd='add_user')
	addToWaitlist ($user_id)
	sendToCourse ($users, $target_course_id, $move=false)
	getMemberByIdentification ($nachname, $vorname=null)
	getMemberByUsername ($username)
	getMemberByDatafield ($nachname, $datafield_id)
	getMembers ($sort_status='autor', $order_by='nachname asc')
	getAdmissionMembers ($sort_status='autor', $order_by='nachname asc')
	moveToWaitlist ($users, $which_end)
	checkUserVisibility ()

Protected Attributes
	$course_id
	$course_title

Constructor & Destructor Documentation

__construct()

__construct	(		$course_id,
			$course_title
	)

Member Function Documentation

addMember()

addMember	(		$user_id,
			$accepted = null,
			$consider_contingent = null,
			$cmd = 'add_user'
	)

Here is the call graph for this function:

addToWaitlist()

addToWaitlist

(

$user_id

)

Adds the given user to the waitlist of the current course and sends a corresponding message.

Parameters

String

$user_id

The user to add

Returns

bool Successful operation?

Here is the call graph for this function:

cancelAdmissionSubscription()

cancelAdmissionSubscription	(		$users,
			$status
	)

Here is the call graph for this function:

cancelSubscription()

cancelSubscription

(

$users

)

Here is the call graph for this function:

checkUserVisibility()

checkUserVisibility

(

)

Here is the call graph for this function:

getAdmissionMembers()

getAdmissionMembers	(		$sort_status = 'autor',
			$order_by = 'nachname asc'
	)

Parameters

string	$sort_status
string	$order_by

Returns

SimpleCollection

Here is the call graph for this function:

getMemberByDatafield()

getMemberByDatafield	(		$nachname,
			$datafield_id
	)

Get user informations by generic datafields for csv-import

Parameters

String	$nachname
String	$datafield_id

Returns

Array

Here is the call graph for this function:

getMemberByIdentification()

getMemberByIdentification	(		$nachname,
			$vorname = null
	)

Get user informations by first and last name for csv-import

Parameters

String	$vorname
String	$nachname

Returns

Array

Here is the call graph for this function:

getMemberByUsername()

getMemberByUsername

(

$username

)

Get user informations by username for csv-import

Parameters

String

$username

Returns

Array

Here is the call graph for this function:

getMembers()

getMembers	(		$sort_status = 'autor',
			$order_by = 'nachname asc'
	)

Parameters

string	$sort_status
string	$order_by
string	$exclude_invisibles

Returns

SimpleCollection

Here is the call graph for this function:

insertAdmissionMember()

insertAdmissionMember	(		$users,
			$next_status,
			$consider_contingent,
			$accepted = null,
			$cmd = 'add_user'
	)

Here is the call graph for this function:

moveToWaitlist()

moveToWaitlist	(		$users,
			$which_end
	)

Adds given users to the course waitlist, either at list beginning or end. System messages are sent to affected users.

Parameters

mixed	$users	array of user ids to add
String	$which_end	'last' or 'first': which list end to append to

Returns

mixed Array of messages (stating success and/or errors)

Here is the call graph for this function:

sendToCourse()

sendToCourse	(		$users,
			$target_course_id,
			$move = false
	)

Adds the given users to the target course.

Parameters

array	$users	users to add
string	$target_course	which course to add users to
bool	$move	move users (=delete in source course) or just add to target course?

Returns

array success and failure statuses

Here is the call graph for this function:

setAdmissionVisibility()

setAdmissionVisibility	(		$user_id,
			$status
	)

Here is the call graph for this function:

setMemberStatus()

setMemberStatus	(		$members,
			$status,
			$next_status,
			$direction
	)

Here is the call graph for this function:

setVisibilty()

setVisibilty	(		$user_id,
			$status
	)

Here is the call graph for this function:

Field Documentation

$course_id

$course_id

protected

$course_title

$course_title

protected

---

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

• app/models/members.php