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

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)
 
 getMemberByEmail ($email)
 
 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 (   $course_id,
  $course_title 
)

Member Function Documentation

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

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

Parameters
String$user_idThe user to add
Returns
bool Successful operation?
cancelAdmissionSubscription (   $users,
  $status 
)
cancelSubscription (   $users)
checkUserVisibility ( )
getAdmissionMembers (   $sort_status = 'autor',
  $order_by = 'nachname asc' 
)
Parameters
string$sort_status
string$order_by
Returns
SimpleCollection
getMemberByDatafield (   $nachname,
  $datafield_id 
)

Get user informations by generic datafields for csv-import

Parameters
String$nachname
String$datafield_id
Returns
Array
getMemberByEmail (   $email)

Get user informations by email for csv-import

Parameters
String$email
Returns
Array
getMemberByIdentification (   $nachname,
  $vorname = null 
)

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

Parameters
String$vorname
String$nachname
Returns
Array
getMemberByUsername (   $username)

Get user informations by username for csv-import

Parameters
String$username
Returns
Array
getMembers (   $sort_status = 'autor',
  $order_by = 'nachname asc' 
)
Parameters
string$sort_status
string$order_by
string$exclude_invisibles
Returns
SimpleCollection
insertAdmissionMember (   $users,
  $next_status,
  $consider_contingent,
  $accepted = null,
  $cmd = 'add_user' 
)
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$usersarray 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)
sendToCourse (   $users,
  $target_course_id,
  $move = false 
)

Adds the given users to the target course.

Parameters
array$usersusers to add
string$target_coursewhich course to add users to
bool$movemove users (=delete in source course) or just add to target course?
Returns
array success and failure statuses
setAdmissionVisibility (   $user_id,
  $status 
)
setMemberStatus (   $members,
  $status,
  $next_status,
  $direction 
)
setVisibilty (   $user_id,
  $status 
)

Field Documentation

$course_id
protected
$course_title
protected

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