| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>Docs For Class sloodle_view_ibank</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <script src="../media/lib/classTree.js"></script>
- <script language="javascript" type="text/javascript">
- var imgPlus = new Image();
- var imgMinus = new Image();
- imgPlus.src = "../media/images/plus.png";
- imgMinus.src = "../media/images/minus.png";
-
- function showNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgMinus.src;
- oTable.style.display = "block";
- }
-
- function hideNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgPlus.src;
- oTable.style.display = "none";
- }
-
- function nodeIsVisible(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- break;
- }
- return (oTable && oTable.style.display == "block");
- }
-
- function toggleNodeVisibility(Node){
- if (nodeIsVisible(Node)){
- hideNode(Node);
- }else{
- showNode(Node);
- }
- }
- </script>
- </head>
- <body>
- <div class="page-body">
- <h2 class="class-name"><img src="../media/images/Class_logo.png"
- alt=" Class"
- title=" Class"
- style="vertical-align: middle"> sloodle_view_ibank</h2>
- <a name="sec-description"></a>
- <div class="info-box">
- <div class="info-box-title">Description</div>
- <div class="nav-bar">
- <span class="disabled">Description</span> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Class for rendering a view of a Distributor module in Moodle.</p>
- <p class="notes">
- Located in <a class="field" href="_view---ibank.php.html">/view/ibank.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a36">36</a></span>)
- </p>
-
-
- <pre><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a>
- |
- --<a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a>
- |
- --sloodle_view_ibank</pre>
-
- </div>
- </div>
- <a name="sec-var-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Variable Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <div class="var-summary">
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">object</span>
- <a href="#$cm" title="details" class="var-name">$cm</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">object</span>
- <a href="#$course" title="details" class="var-name">$course</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">object</span>
- <a href="#$course_context" title="details" class="var-name">$course_context</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">$icurrency</span>
- <a href="#$icurrency" title="details" class="var-name">$icurrency</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">mixed</span>
- <a href="#$initialized" title="details" class="var-name">$initialized</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">$iPb</span>
- <a href="#$iPb" title="details" class="var-name">$iPb</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">$iPts</span>
- <a href="#$iPts" title="details" class="var-name">$iPts</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">mixed</span>
- <a href="#$renderMessage" title="details" class="var-name">$renderMessage</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">$sCourseObj</span>
- <a href="#$sCourseObj" title="details" class="var-name">$sCourseObj</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type"><a href="../sloodle/SloodleSession.html">SloodleSession</a></span>
- <a href="#$session" title="details" class="var-name">$session</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">mixed</span>
- <a href="#$showInitForm" title="details" class="var-name">$showInitForm</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">object</span>
- <a href="#$sloodle" title="details" class="var-name">$sloodle</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">object</span>
- <a href="#$sloodleCourse" title="details" class="var-name">$sloodleCourse</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">bigInt(10)</span>
- <a href="#$sloodleId" title="details" class="var-name">$sloodleId</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type"><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></span>
- <a href="#$sloodle_course" title="details" class="var-name">$sloodle_course</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">integer</span>
- <a href="#$start" title="details" class="var-name">$start</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">Array</span>
- <a href="#$stipendCollectors_moodleid" title="details" class="var-name">$stipendCollectors_moodleid</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">Array</span>
- <a href="#$stipendCollectors_uuid" title="details" class="var-name">$stipendCollectors_uuid</a>
- </div>
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">$stipendGiverObj</span>
- <a href="#$stipendGiverObj" title="details" class="var-name">$stipendGiverObj</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">Array</span>
- <a href="#$transactionRecords" title="details" class="var-name">$transactionRecords</a>
- </div>
- <div class="var-title">
- <img src="../media/images/PrivateVariable.png" alt=" " />
- <span class="var-type">Array</span>
- <a href="#$userList" title="details" class="var-name">$userList</a>
- </div>
- </div>
- </div>
- </div>
- <a name="sec-method-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Method Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
-
- |
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
- </div>
- <div class="info-box-body">
- <div class="method-summary">
-
- <div class="method-definition">
- <img src="../media/images/Constructor.png" alt=" "/>
- <span class="method-result">sloodle_view_ibank</span>
- <a href="#sloodle_view_ibank" title="details" class="method-name">sloodle_view_ibank</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#addCommas" title="details" class="method-name">addCommas</a>
- (<span class="var-type">array</span> <span class="var-name">$arrList</span>)
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">object</span>
- <a href="#buildAvTable" title="details" class="method-name">buildAvTable</a>
- (<span class="var-type">null</span> <span class="var-name">0</span>)
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#check_permission" title="details" class="method-name">check_permission</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#destroy" title="details" class="method-name">destroy</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#getRenderMessage" title="details" class="method-name">getRenderMessage</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">null</span>
- <a href="#printUserTable" title="details" class="method-name">printUserTable</a>
- (<span class="var-type">$userData</span> <span class="var-name">$userData</span>)
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#print_header" title="details" class="method-name">print_header</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#process_form" title="details" class="method-name">process_form</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#process_request" title="details" class="method-name">process_request</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#render" title="details" class="method-name">render</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#setRenderMessage" title="details" class="method-name">setRenderMessage</a>
- (<span class="var-type"></span> <span class="var-name">$str</span>)
- </div>
- </div>
- </div>
- </div>
- <a name="sec-vars"></a>
- <div class="info-box">
- <div class="info-box-title">Variables</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
-
-
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
-
- <a name="var$cm" id="$cm"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">object</span>
- <span class="var-name">$cm</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a128">128</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">The course module instance, retrieved directly from the database (table: course_modules)</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#var$cm">sloodle_base_view_module::$cm</a></dt>
- <dd>The course module instance, retrieved directly from the database (table: course_modules)</dd>
- </dl>
-
-
- </div>
- <a name="var$course" id="$course"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">object</span>
- <span class="var-name">$course</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a142">142</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">The VLE course object, retrieved directly from the database (table: course)</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#var$course">sloodle_base_view_module::$course</a></dt>
- <dd>The VLE course object, retrieved directly from the database (table: course)</dd>
- </dl>
-
-
- </div>
- <a name="var$course_context" id="$course_context"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">object</span>
- <span class="var-name">$course_context</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a156">156</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Context object for permissions in the Moodle course.</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#var$course_context">sloodle_base_view_module::$course_context</a></dt>
- <dd>Context object for permissions in the Moodle course.</dd>
- </dl>
-
-
- </div>
- <a name="var$icurrency" id="$icurrency"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">$icurrency</span>
- <span class="var-name">$icurrency</span>
- (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a117">117</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">var:</span> - currency of this stopend - can be Lindens, or iPoints</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$initialized" id="$initialized"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$initialized</span>
- = <span class="var-default">false</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a84">84</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
-
-
- </div>
- <a name="var$iPb" id="$iPb"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">$iPb</span>
- <span class="var-name">$iPb</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a102">102</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">var:</span> a pointer to the iPoint bank object base class;</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$iPts" id="$iPts"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">$iPts</span>
- <span class="var-name">$iPts</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a111">111</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">var:</span> are the number of iPoints if iPoints were selected as icurrency</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$renderMessage" id="$renderMessage"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$renderMessage</span>
- = <span class="var-default">null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a46">46</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
-
-
- </div>
- <a name="var$sCourseObj" id="$sCourseObj"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">$sCourseObj</span>
- <span class="var-name">$sCourseObj</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a106">106</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">var:</span> - a pointer to the sloodleCourseObject with useful functions to access course data</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$session" id="$session"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type"><a href="../sloodle/SloodleSession.html">SloodleSession</a></span>
- <span class="var-name">$session</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a98">98</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">session is a dummy session object to be used as a parameter when creating a sloodleUser object</p>
- <ul class="tags">
- <li><span class="field">var:</span> Object</li>
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$showInitForm" id="$showInitForm"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">mixed</span>
- <span class="var-name">$showInitForm</span>
- = <span class="var-default"> false</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a113">113</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
-
-
-
-
- </div>
- <a name="var$sloodle" id="$sloodle"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">object</span>
- <span class="var-name">$sloodle</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a135">135</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">The main SLOODLE module instance, retreived directly from the database (table: sloodle)</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#var$sloodle">sloodle_base_view_module::$sloodle</a></dt>
- <dd>The main SLOODLE module instance, retreived directly from the database (table: sloodle)</dd>
- </dl>
-
-
- </div>
- <a name="var$sloodleCourse" id="$sloodleCourse"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">object</span>
- <span class="var-name">$sloodleCourse</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a44">44</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">SLOODLE course object, retrieved directly from database.</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$sloodleId" id="$sloodleId"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">bigInt(10)</span>
- <span class="var-name">$sloodleId</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a91">91</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">sloodleId The instance of this moodle module</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$sloodle_course" id="$sloodle_course"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type"><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></span>
- <span class="var-name">$sloodle_course</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a149">149</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">The SLOODLE course object.</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#var$sloodle_course">sloodle_base_view_module::$sloodle_course</a></dt>
- <dd>The SLOODLE course object.</dd>
- </dl>
-
-
- </div>
- <a name="var$start" id="$start"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">integer</span>
- <span class="var-name">$start</span>
- = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a53">53</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">The result number to start displaying from</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$stipendCollectors_moodleid" id="$stipendCollectors_moodleid"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">Array</span>
- <span class="var-name">$stipendCollectors_moodleid</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a74">74</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">A List of usrs moodle id's who have collected a stipend</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$stipendCollectors_uuid" id="$stipendCollectors_uuid"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">Array</span>
- <span class="var-name">$stipendCollectors_uuid</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a67">67</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">A List of all users avatar UUID's who have collected a stipend</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$stipendGiverObj" id="$stipendGiverObj"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">$stipendGiverObj</span>
- <span class="var-name">$stipendGiverObj</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a121">121</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <ul class="tags">
- <li><span class="field">var:</span> - a pointer to the stipendGiverObject with useful functions to access the stipendGiver</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$transactionRecords" id="$transactionRecords"><!-- --></A>
- <div class="oddrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">Array</span>
- <span class="var-name">$transactionRecords</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a60">60</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">A List of records of the transactions for this stipend</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
- <a name="var$userList" id="$userList"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-type">Array</span>
- <span class="var-name">$userList</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a82">82</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">A List of all the students in this course</p>
- <ul class="tags">
- <li><span class="field">access:</span> private</li>
- </ul>
-
-
-
-
- </div>
-
<h4>Inherited Variables</h4>
- <A NAME='inherited_vars'><!-- --></A>
- <p>Inherited from <span class="classname"><a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a></span></p>
- <blockquote>
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$canedit">sloodle_base_view_module::$canedit</a></span><br>
- </span>
- <img src="../media/images/PrivateVariable.png" />
- <span class="var-title">
- <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$module_context">sloodle_base_view_module::$module_context</a></span><br>
- </span>
- </blockquote>
-
- </div>
- </div>
-
- <a name="sec-methods"></a>
- <div class="info-box">
- <div class="info-box-title">Methods</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
-
- </div>
- <div class="info-box-body">
- <A NAME='method_detail'></A>
- <a name="methodsloodle_view_ibank" id="sloodle_view_ibank"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Constructor.png" />
- <span class="method-title">Constructor sloodle_view_ibank</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a171">171</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Constructor.</p>
- <p class="description"><p>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</p></p>
-
- <div class="method-signature">
- <span class="method-result">sloodle_view_ibank</span>
- <span class="method-name">
- sloodle_view_ibank
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodaddCommas" id="addCommas"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">addCommas</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a609">609</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">addCommas takes an array of strings and add commas between elements except at the last element, or if there is only one element</p>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- addCommas
- </span>
- (<span class="var-type">array</span> <span class="var-name">$arrList</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array</span>
- <span class="var-name">$arrList</span> </li>
- </ul>
-
-
- </div>
- <a name="methodbuildAvTable" id="buildAvTable"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">buildAvTable</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a631">631</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Simply sets up the inner avatar table, alignment, and sizes</p>
- <ul class="tags">
- <li><span class="field">staticvar:</span> object $avTable: </li>
- <li><span class="field">link:</span> <a href="http://sloodle.googlecode.com">http://sloodle.googlecode.com</a></li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">object</span>
- <span class="method-name">
- buildAvTable
- </span>
- (<span class="var-type">null</span> <span class="var-name">0</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">null</span>
- <span class="var-name">0</span> </li>
- </ul>
-
-
- </div>
- <a name="methodcheck_permission" id="check_permission"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">check_permission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a188">188</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Check that the user has permission to view this module, and check if they can edit it too.</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- check_permission
- </span>
- ()
- </div>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#methodcheck_permission">sloodle_base_view_module::check_permission()</a></dt>
- <dd>Check that the user has permission to view this module, and check if they can edit it too.</dd>
- </dl>
-
- </div>
- <a name="methoddestroy" id="destroy"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">destroy</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a649">649</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- destroy
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodgetRenderMessage" id="getRenderMessage"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getRenderMessage</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a645">645</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- getRenderMessage
- </span>
- ()
- </div>
-
-
-
- </div>
- <a name="methodprintUserTable" id="printUserTable"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">printUserTable</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a362">362</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">This function will display an HTML table of the users transactions Columns displayed will be: UserName | Avatar | Amount Alloted | Balance Remaining</p>
- <ul class="tags">
- <li><span class="field">staticvar:</span> null 0: </li>
- <li><span class="field">link:</span> <a href="http://sloodle.googlecode.com">http://sloodle.googlecode.com</a></li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">null</span>
- <span class="method-name">
- printUserTable
- </span>
- (<span class="var-type">$userData</span> <span class="var-name">$userData</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">$userData</span>
- <span class="var-name">$userData</span><span class="var-description">: - an array of users</span> </li>
- </ul>
-
-
- </div>
- <a name="methodprint_header" id="print_header"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">print_header</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a328">328</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Override the base_view_module print_header for formatting reasons</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- print_header
- </span>
- ()
- </div>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#methodprint_header">sloodle_base_view_module::print_header()</a></dt>
- <dd>Print module header info.</dd>
- </dl>
-
- </div>
- <a name="methodprocess_form" id="process_form"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">process_form</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a232">232</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Process any form data which has been submitted.</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- process_form
- </span>
- ()
- </div>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#methodprocess_form">sloodle_base_view_module::process_form()</a></dt>
- <dd>Process any form data which has been submitted.</dd>
- </dl>
-
- </div>
- <a name="methodprocess_request" id="process_request"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">process_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a207">207</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Check and process the request parameters.</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- process_request
- </span>
- ()
- </div>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#methodprocess_request">sloodle_base_view_module::process_request()</a></dt>
- <dd>Checks for incoming request data identifying a particular module (parameter 'id').</dd>
- </dl>
-
- </div>
- <a name="methodrender" id="render"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">render</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a526">526</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Render the view of the Stipend Giver.</p>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- render
- </span>
- ()
- </div>
-
-
- <hr class="separator" />
- <div class="notes">Redefinition of:</div>
- <dl>
- <dt><a href="../sloodle/sloodle_base_view_module.html#methodrender">sloodle_base_view_module::render()</a></dt>
- <dd>Render the view of the module or feature.</dd>
- </dl>
-
- </div>
- <a name="methodsetRenderMessage" id="setRenderMessage"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">setRenderMessage</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewibank.php.html#a641">641</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setRenderMessage
- </span>
- (<span class="var-type"></span> <span class="var-name">$str</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type"></span>
- <span class="var-name">$str</span> </li>
- </ul>
-
-
- </div>
- <h4>Inherited Methods</h4>
- <a name='inherited_methods'><!-- --></a>
- <!-- =========== Summary =========== -->
- <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a></span></p>
- <blockquote>
- <img src="../media/images/Constructor.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodsloodle_base_view_module">sloodle_base_view_module::sloodle_base_view_module()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodcheck_permission">sloodle_base_view_module::check_permission()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprint_footer">sloodle_base_view_module::print_footer()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprint_header">sloodle_base_view_module::print_header()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprocess_form">sloodle_base_view_module::process_form()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprocess_request">sloodle_base_view_module::process_request()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodrender">sloodle_base_view_module::render()</a></span><br>
- </blockquote>
- <!-- =========== Summary =========== -->
- <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a></span></p>
- <blockquote>
- <img src="../media/images/Constructor.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodsloodle_base_view">sloodle_base_view::sloodle_base_view()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_form">sloodle_base_view::process_form()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></span><br>
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodview">sloodle_base_view::view()</a></span><br>
- </blockquote>
-
- </div>
- </div>
-
- <p class="notes" id="credit">
- Documentation generated on Fri, 17 Jul 2009 11:01:21 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </div></body>
- </html>
|