Docs For Class sloodle_view

Description

Class for rendering a view of a Distributor module in Moodle.

sloodle_base_view
   |
   --sloodle_base_view_module
      |
      --sloodle_view_ibank

Variable Summary

object $cm

object $course

object $course_context

$icurrency $icurrency

mixed $initialized

$iPb $iPb

$iPts $iPts

mixed $renderMessage

$sCourseObj $sCourseObj

SloodleSession $session

mixed $showInitForm

object $sloodle

object $sloodleCourse

bigInt(10) $sloodleId

SloodleCourse $sloodle_course

integer $start

Array $stipendCollectors_moodleid

Array $stipendCollectors_uuid

$stipendGiverObj $stipendGiverObj

Array $transactionRecords

Array $userList

Method Summary

sloodle_view_ibank sloodle_view_ibank ()

string addCommas (array $arrList)

object buildAvTable (null 0)

void check_permission ()

void destroy ()

void getRenderMessage ()

null printUserTable ($userData $userData)

void print_header ()

void process_form ()

void process_request ()

void render ()

void setRenderMessage ( $str)

Variables

object $cm = null (line 128)

The course module instance, retrieved directly from the database (table: course_modules)

access: private

Redefinition of:

sloodle_base_view_module::$cm: The course module instance, retrieved directly from the database (table: course_modules)

object $course = null (line 142)

The VLE course object, retrieved directly from the database (table: course)

access: private

Redefinition of:

sloodle_base_view_module::$course: The VLE course object, retrieved directly from the database (table: course)

object $course_context = null (line 156)

Context object for permissions in the Moodle course.

access: private

Redefinition of:

sloodle_base_view_module::$course_context: Context object for permissions in the Moodle course.

$icurrency $icurrency (line 117)

var: - currency of this stopend - can be Lindens, or iPoints

mixed $initialized = false (line 84)

$iPb $iPb = null (line 102)

var: a pointer to the iPoint bank object base class;

$iPts $iPts = null (line 111)

var: are the number of iPoints if iPoints were selected as icurrency

mixed $renderMessage = null (line 46)

$sCourseObj $sCourseObj = null (line 106)

var: - a pointer to the sloodleCourseObject with useful functions to access course data

SloodleSession $session = null (line 98)

session is a dummy session object to be used as a parameter when creating a sloodleUser object

var: Object
access: private

mixed $showInitForm = false (line 113)

object $sloodle = null (line 135)

The main SLOODLE module instance, retreived directly from the database (table: sloodle)

access: private

Redefinition of:

sloodle_base_view_module::$sloodle: The main SLOODLE module instance, retreived directly from the database (table: sloodle)

object $sloodleCourse = null (line 44)

SLOODLE course object, retrieved directly from database.

access: private

bigInt(10) $sloodleId = null (line 91)

sloodleId The instance of this moodle module

access: private

SloodleCourse $sloodle_course = null (line 149)

The SLOODLE course object.

access: private

Redefinition of:

sloodle_base_view_module::$sloodle_course: The SLOODLE course object.

integer $start = 0 (line 53)

The result number to start displaying from

access: private

Array $stipendCollectors_moodleid = null (line 74)

A List of usrs moodle id's who have collected a stipend

access: private

Array $stipendCollectors_uuid = null (line 67)

A List of all users avatar UUID's who have collected a stipend

access: private

$stipendGiverObj $stipendGiverObj = null (line 121)

var: - a pointer to the stipendGiverObject with useful functions to access the stipendGiver

Array $transactionRecords = null (line 60)

A List of records of the transactions for this stipend

access: private

Array $userList = null (line 82)

A List of all the students in this course

access: private

Inherited Variables

Inherited from sloodle_base_view_module

sloodle_base_view_module::$canedit
sloodle_base_view_module::$module_context

Methods

Constructor sloodle_view_ibank (line 171)

Constructor.

This constructor creates a sloodleCourseObject which gives us useful functions to access course data Also creats a stipendGiver Object which gives us useful functions to access stipendGiver data

sloodle_view_ibank sloodle_view_ibank ()

addCommas (line 609)

addCommas takes an array of strings and add commas between elements except at the last element, or if there is only one element

string addCommas (array $arrList)

array $arrList

buildAvTable (line 631)

Simply sets up the inner avatar table, alignment, and sizes

staticvar: object $avTable:
link: http://sloodle.googlecode.com

object buildAvTable (null 0)

null 0

check_permission (line 188)

Check that the user has permission to view this module, and check if they can edit it too.

void check_permission ()

Redefinition of:

sloodle_base_view_module::check_permission(): Check that the user has permission to view this module, and check if they can edit it too.

destroy (line 649)

void destroy ()

getRenderMessage (line 645)

void getRenderMessage ()

printUserTable (line 362)

This function will display an HTML table of the users transactions Columns displayed will be: UserName | Avatar | Amount Alloted | Balance Remaining

staticvar: null 0:
link: http://sloodle.googlecode.com

null printUserTable ($userData $userData)

$userData $userData: - an array of users

print_header (line 328)

Override the base_view_module print_header for formatting reasons

void print_header ()

Redefinition of:

sloodle_base_view_module::print_header(): Print module header info.

process_form (line 232)

Process any form data which has been submitted.

void process_form ()

Redefinition of:

sloodle_base_view_module::process_form(): Process any form data which has been submitted.

process_request (line 207)

Check and process the request parameters.

void process_request ()

Redefinition of:

sloodle_base_view_module::process_request(): Checks for incoming request data identifying a particular module (parameter 'id').

render (line 526)

Render the view of the Stipend Giver.

void render ()

Redefinition of:

sloodle_base_view_module::render(): Render the view of the module or feature.

setRenderMessage (line 641)

void setRenderMessage ( $str)

$str

Inherited Methods

Inherited From sloodle_base_view_module

sloodle_base_view_module::sloodle_base_view_module()
sloodle_base_view_module::check_permission()
sloodle_base_view_module::print_footer()
sloodle_base_view_module::print_header()
sloodle_base_view_module::process_form()
sloodle_base_view_module::process_request()
sloodle_base_view_module::render()

Inherited From sloodle_base_view

sloodle_base_view::sloodle_base_view()
sloodle_base_view::check_permission()
sloodle_base_view::print_footer()
sloodle_base_view::print_header()
sloodle_base_view::process_form()
sloodle_base_view::process_request()
sloodle_base_view::render()
sloodle_base_view::view()