AdmissionPriority Class Reference

Collaboration diagram for AdmissionPriority:

Static Public Member Functions
static	getPriorities ($courseSetId)
static	getPrioritiesByCourse ($courseSetId, $courseId)
static	getPrioritiesByUser ($courseSetId, $userId)
static	setPriority ($courseSetId, $userId, $courseId, $priority)
static	unsetPriority ($courseSetId, $userId, $courseId)
static	unsetAllPriorities ($courseSetId)
static	unsetAllPrioritiesForUser ($courseSetId, $userId)
static	getPrioritiesStats ($courseSetId)
static	getPrioritiesCount ($courseSetId)
static	getPrioritiesMax ($courseSetId)
static	unsetAllPrioritiesForCourse ($course_id)

Member Function Documentation

getPriorities()

static getPriorities (   $courseSetId )

static

Get all priorities for the given course set. The priorities are stored in a 2-dimensional array in the form priority[user_id][course_id] = x.

Parameters

String

courseSetId

Returns

A 2-dimensional array containing all priorities.

Here is the call graph for this function:

Here is the caller graph for this function:

getPrioritiesByCourse()

static getPrioritiesByCourse (   $courseSetId,   $courseId  )

static

Get all priorities for the given course in the given course set. The priorities are stored in an array in the form priority[user_id] = x.

Parameters

String	courseSetId
String	courseId

Returns

An array containing all priorities.

Here is the call graph for this function:

Here is the caller graph for this function:

getPrioritiesByUser()

static getPrioritiesByUser (   $courseSetId,   $userId  )

static

Get all priorities the given user has set in the given course set. The priorities are stored in an array in the form priority[course_id] = x.

Parameters

String	courseSetId
String	userId

Returns

An array containing all priorities.

Here is the call graph for this function:

Here is the caller graph for this function:

getPrioritiesCount()

static getPrioritiesCount (   $courseSetId )

static

returns number of users with priorities for a set

Parameters

String

courseSetId

Returns

integer

Here is the call graph for this function:

Here is the caller graph for this function:

getPrioritiesMax()

static getPrioritiesMax (   $courseSetId )

static

return max chosen priority in set

Parameters

String

courseSetId

Returns

integer

Here is the call graph for this function:

getPrioritiesStats()

static getPrioritiesStats (   $courseSetId )

static

returns statistics of priority selection for a set

Parameters

String

courseSetId

Returns

array stats grouped by course id

Here is the call graph for this function:

Here is the caller graph for this function:

setPriority()

static setPriority (   $courseSetId,   $userId,   $courseId,   $priority  )

static

The given user sets a course in the given course set to priority x.

Parameters

String	courseSetId
String	userId
String	courseId
int	priority

Returns

int Number of affected rows, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

unsetAllPriorities()

static unsetAllPriorities (   $courseSetId )

static

delete all priorities for one set

Parameters

String

courseSetId

Returns

int Number of affected rows, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

unsetAllPrioritiesForCourse()

static unsetAllPrioritiesForCourse (   $course_id )

static

delete all priorities for one course

Parameters

String

course Id

Returns

int Number of affected rows, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

unsetAllPrioritiesForUser()

static unsetAllPrioritiesForUser (   $courseSetId,   $userId  )

static

delete all priorities for one set and one user

Parameters

String	courseSetId
String	userId

Returns

int Number of affected rows, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

unsetPriority()

static unsetPriority (   $courseSetId,   $userId,   $courseId  )

static

unset priority for given user,set and course reorder remaining priorities

Parameters

String	courseSetId
String	userId
String	courseId

Returns

int Number of affected rows, if any.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• lib/classes/admission/AdmissionPriority.class.php