Docs For Class iPointBank

Description

The iPointBank class provides basic transaction functions for the Sloodle iBank module.

copyright: Copyright (c) 2008 Sloodle (various contributors)
see: iBank
contributor: Paul G. Preibisch - aka Fire Centaur
license: GNU GPL v3

Located in /lib/ipointbank_object.php (line 11)

Variable Summary

mixed $name

mixed $sloodleid

mixed $transactionRecords

Method Summary

iPointBank iPointBank ( $id)

integer getAvatarDebits (string $avuuid)

void getSloodleId ()

returns getTransactionRecords ([ $userId = null])

integer getUserDebits ([ $userid = null], string $avuuid)

returns makeTransaction ( $iTransaction)

true removeTransaction ( $userId, $iType)

void update ()

void updateTransaction ( $transactionUpdate)

Variables

mixed $name = '' (line 13)

mixed $sloodleid = null (line 15)

mixed $transactionRecords = null (line 17)

Methods

Constructor iPointBank (line 19)

iPointBank iPointBank ( $id)

$id

getAvatarDebits (line 113)

This function will search through all the transactions for this stipend based on avatar uuid and return the TOTAL debits amount

staticvar: integer $debitAmount: will be zero if no debits exist for this user and stipend
link: http://sloodle.googlecode.com

integer getAvatarDebits (string $avuuid)

string $avuuid: the avatar UUID to search for

getSloodleId (line 101)

void getSloodleId ()

getTransactionRecords (line 61)

return: transaction records for this user / or for all users
staticvar: $userId 0: moodle id of the user
author:
Paul Preibisch
getTransactionRecords returns the recordset of sloodle_ipoint_trans record for the $userId specified. if $userId is null, returns all the transaction records for this stipend

returns getTransactionRecords ([ $userId = null])

$userId

getUserDebits (line 133)

This function will search through all the transactions and return TOTAL debits for this course user

staticvar: integer $debitAmount: will be zero if no debits exist for this user and stipend
link: http://sloodle.googlecode.com

integer getUserDebits ([ $userid = null], string $avuuid)

string $avuuid: the avatar UUID to search for
$userid

makeTransaction (line 38)

return: true if insert was successful
author:
Paul Preibisch
makeTransaction inserts a record into the sloodle_ipoint_trans table

returns makeTransaction ( $iTransaction)

$iTransaction

removeTransaction (line 90)

return: if successful
staticvar: $userId 0: moodle id of the user
staticvar: $iType 1: type of the transaction "stipend","credit","debit"
author:
Paul Preibisch
removeTransaction removes the transaction for this stipend

true removeTransaction ( $userId, $iType)

$userId
$iType

update (line 43)

void update ()

updateTransaction (line 95)

void updateTransaction ( $transactionUpdate)

$transactionUpdate