Docs For Class stipendGiverObject

Description

Located in /mod/ibank-1.0/stipendgiver_object.php (line 14)

iPointBank
   |
   --stipendGiverObject

Variable Summary

mixed $icurrency

mixed $sloodleId

mixed $startingBalance

mixed $stipendGiverRec

Method Summary

void geticurrency ()

void getSloodleId ()

void getStartingBalance ()

returns getStipendBudget ( $userid, $userList)

a getStipendRec ( $userid)

true searchUserList ( $userList, $userid)

void setStartingBalance ( $newStartingBalance)

true setStipendBudget ([ $amount = 0], [ $userId = null])

void StipendGiverObject ( $id)

true updateUserList ( $userList)

Variables

mixed $icurrency = '' (line 28)

mixed $sloodleId = null (line 32)

mixed $startingBalance = 0 (line 19)

mixed $stipendGiverRec = null (line 24)

Methods

geticurrency (line 136)

void geticurrency ()

getSloodleId (line 142)

void getSloodleId ()

getStartingBalance (line 123)

void getStartingBalance ()

getStipendBudget (line 160)

return: bugeted amount for this user,
staticvar: $userId 0: moodle id of the user
author:
Paul Preibisch
getStipendBudget gets the stipend amount allocated to this user

returns getStipendBudget ( $userid, $userList)

$userid
$userList

getStipendRec (line 236)

return: record from the sloodle_ipoint_trans table
staticvar: $userId 0: moodle id of the user
author:
Paul Preibisch
getStipendRec returns the stipend record for this user. itype in the sloodle_ipoint_trans table must be 'stipend',

a getStipendRec ( $userid)

$userid

searchUserList (line 113)

return: if found
staticvar: $userList 0: users in this course
staticvar: $userId 1: - moodle id of user sought
author:
Paul Preibisch
searchUserList searches through the list of users

true searchUserList ( $userList, $userid)

$userList
$userid

setStartingBalance (line 130)

void setStartingBalance ( $newStartingBalance)

$newStartingBalance

setStipendBudget (line 196)

return: if record can be updates
staticvar: $amount 0: is amount of the stipend - defaults to zero
staticvar: $userId 1: moodle id of the user
author:
Paul Preibisch
setStipendBudget can be used to set the default stipend, or a stipend of an individual user

true setStipendBudget ([ $amount = 0], [ $userId = null])

$amount
$userId

StipendGiverObject (line 38)

void StipendGiverObject ( $id)

$id

updateUserList (line 62)

return: if found
staticvar: $userList 0: users in this course
staticvar: $userId 1: - moodle id of user sought
author:
Paul Preibisch
updateUserList searches through the list of users in the course, and adds new stipends for new users to transactions table, and or removes students stipends who have been removed from the class list

true updateUserList ( $userList)

$userList