assignment_sloodleobject.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class assignment_sloodleobject</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <script src="../media/lib/classTree.js"></script>
  9. <script language="javascript" type="text/javascript">
  10. var imgPlus = new Image();
  11. var imgMinus = new Image();
  12. imgPlus.src = "../media/images/plus.png";
  13. imgMinus.src = "../media/images/minus.png";
  14. function showNode(Node){
  15. switch(navigator.family){
  16. case 'nn4':
  17. // Nav 4.x code fork...
  18. var oTable = document.layers["span" + Node];
  19. var oImg = document.layers["img" + Node];
  20. break;
  21. case 'ie4':
  22. // IE 4/5 code fork...
  23. var oTable = document.all["span" + Node];
  24. var oImg = document.all["img" + Node];
  25. break;
  26. case 'gecko':
  27. // Standards Compliant code fork...
  28. var oTable = document.getElementById("span" + Node);
  29. var oImg = document.getElementById("img" + Node);
  30. break;
  31. }
  32. oImg.src = imgMinus.src;
  33. oTable.style.display = "block";
  34. }
  35. function hideNode(Node){
  36. switch(navigator.family){
  37. case 'nn4':
  38. // Nav 4.x code fork...
  39. var oTable = document.layers["span" + Node];
  40. var oImg = document.layers["img" + Node];
  41. break;
  42. case 'ie4':
  43. // IE 4/5 code fork...
  44. var oTable = document.all["span" + Node];
  45. var oImg = document.all["img" + Node];
  46. break;
  47. case 'gecko':
  48. // Standards Compliant code fork...
  49. var oTable = document.getElementById("span" + Node);
  50. var oImg = document.getElementById("img" + Node);
  51. break;
  52. }
  53. oImg.src = imgPlus.src;
  54. oTable.style.display = "none";
  55. }
  56. function nodeIsVisible(Node){
  57. switch(navigator.family){
  58. case 'nn4':
  59. // Nav 4.x code fork...
  60. var oTable = document.layers["span" + Node];
  61. break;
  62. case 'ie4':
  63. // IE 4/5 code fork...
  64. var oTable = document.all["span" + Node];
  65. break;
  66. case 'gecko':
  67. // Standards Compliant code fork...
  68. var oTable = document.getElementById("span" + Node);
  69. break;
  70. }
  71. return (oTable && oTable.style.display == "block");
  72. }
  73. function toggleNodeVisibility(Node){
  74. if (nodeIsVisible(Node)){
  75. hideNode(Node);
  76. }else{
  77. showNode(Node);
  78. }
  79. }
  80. </script>
  81. </head>
  82. <body>
  83. <div class="page-body">
  84. <h2 class="class-name"><img src="../media/images/Class_logo.png"
  85. alt=" Class"
  86. title=" Class"
  87. style="vertical-align: middle"> assignment_sloodleobject</h2>
  88. <a name="sec-description"></a>
  89. <div class="info-box">
  90. <div class="info-box-title">Description</div>
  91. <div class="nav-bar">
  92. <span class="disabled">Description</span> |
  93. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  94. </div>
  95. <div class="info-box-body">
  96. <!-- ========== Info from phpDoc block ========= -->
  97. <p class="short-description">Extend the base assignment class for assignments where you submit an SL object in-world.</p>
  98. <p class="description"><p>This has been modified from the &quot;assignment_online&quot; type.</p></p>
  99. <p class="notes">
  100. Located in <a class="field" href="_sloodle---mod---primdrop-1.0---sloodleobject---assignment.class.php.html">/sloodle/mod/primdrop-1.0/sloodleobject/assignment.class.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a29">29</a></span>)
  101. </p>
  102. <pre>assignment_base
  103. |
  104. --assignment_sloodleobject</pre>
  105. </div>
  106. </div>
  107. <a name="sec-method-summary"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Method Summary</span></div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  113. </div>
  114. <div class="info-box-body">
  115. <div class="method-summary">
  116. <div class="method-definition">
  117. <img src="../media/images/Constructor.png" alt=" "/>
  118. <span class="method-result">assignment_sloodleobject</span>
  119. <a href="#assignment_sloodleobject" title="details" class="method-name">assignment_sloodleobject</a>
  120. ([<span class="var-type"></span>&nbsp;<span class="var-name">$cmid</span> = <span class="var-default">'staticonly'</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$assignment</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$cm</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$course</span> = <span class="var-default">NULL</span>])
  121. </div>
  122. <div class="method-definition">
  123. <img src="../media/images/Method.png" alt=" "/>
  124. <span class="method-result">void</span>
  125. <a href="#preprocess_submission" title="details" class="method-name">preprocess_submission</a>
  126. (<span class="var-type"></span>&nbsp;<span class="var-name">&$submission</span>)
  127. </div>
  128. <div class="method-definition">
  129. <img src="../media/images/Method.png" alt=" "/>
  130. <span class="method-result">void</span>
  131. <a href="#print_student_answer" title="details" class="method-name">print_student_answer</a>
  132. (<span class="var-type"></span>&nbsp;<span class="var-name">$userid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return</span> = <span class="var-default">true</span>])
  133. </div>
  134. <div class="method-definition">
  135. <img src="../media/images/Method.png" alt=" "/>
  136. <span class="method-result">void</span>
  137. <a href="#print_user_files" title="details" class="method-name">print_user_files</a>
  138. (<span class="var-type"></span>&nbsp;<span class="var-name">$userid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return</span> = <span class="var-default">false</span>])
  139. </div>
  140. <div class="method-definition">
  141. <img src="../media/images/Method.png" alt=" "/>
  142. <span class="method-result">void</span>
  143. <a href="#setup_elements" title="details" class="method-name">setup_elements</a>
  144. (<span class="var-type"></span>&nbsp;<span class="var-name">&$mform</span>)
  145. </div>
  146. <div class="method-definition">
  147. <img src="../media/images/Method.png" alt=" "/>
  148. <span class="method-result">bool</span>
  149. <a href="#update_submission" title="details" class="method-name">update_submission</a>
  150. (<span class="var-type">int</span>&nbsp;<span class="var-name">$userid</span>, <span class="var-type"><a href="../sloodle/assignment_sloodleobject_submission.html">assignment_sloodleobject_submission</a></span>&nbsp;<span class="var-name">$data</span>)
  151. </div>
  152. <div class="method-definition">
  153. <img src="../media/images/Method.png" alt=" "/>
  154. <span class="method-result">void</span>
  155. <a href="#view" title="details" class="method-name">view</a>
  156. ()
  157. </div>
  158. <div class="method-definition">
  159. <img src="../media/images/Method.png" alt=" "/>
  160. <span class="method-result">void</span>
  161. <a href="#view_dates" title="details" class="method-name">view_dates</a>
  162. ()
  163. </div>
  164. </div>
  165. </div>
  166. </div>
  167. <a name="sec-methods"></a>
  168. <div class="info-box">
  169. <div class="info-box-title">Methods</div>
  170. <div class="nav-bar">
  171. <a href="#sec-description">Description</a> |
  172. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  173. </div>
  174. <div class="info-box-body">
  175. <A NAME='method_detail'></A>
  176. <a name="methodassignment_sloodleobject" id="assignment_sloodleobject"><!-- --></a>
  177. <div class="oddrow">
  178. <div class="method-header">
  179. <img src="../media/images/Constructor.png" />
  180. <span class="method-title">Constructor assignment_sloodleobject</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a31">31</a></span>)
  181. </div>
  182. <!-- ========== Info from phpDoc block ========= -->
  183. <div class="method-signature">
  184. <span class="method-result">assignment_sloodleobject</span>
  185. <span class="method-name">
  186. assignment_sloodleobject
  187. </span>
  188. ([<span class="var-type"></span>&nbsp;<span class="var-name">$cmid</span> = <span class="var-default">'staticonly'</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$assignment</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$cm</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$course</span> = <span class="var-default">NULL</span>])
  189. </div>
  190. <ul class="parameters">
  191. <li>
  192. <span class="var-type"></span>
  193. <span class="var-name">$cmid</span> </li>
  194. <li>
  195. <span class="var-type"></span>
  196. <span class="var-name">$assignment</span> </li>
  197. <li>
  198. <span class="var-type"></span>
  199. <span class="var-name">$cm</span> </li>
  200. <li>
  201. <span class="var-type"></span>
  202. <span class="var-name">$course</span> </li>
  203. </ul>
  204. </div>
  205. <a name="methodpreprocess_submission" id="preprocess_submission"><!-- --></a>
  206. <div class="evenrow">
  207. <div class="method-header">
  208. <img src="../media/images/Method.png" />
  209. <span class="method-title">preprocess_submission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a172">172</a></span>)
  210. </div>
  211. <!-- ========== Info from phpDoc block ========= -->
  212. <div class="method-signature">
  213. <span class="method-result">void</span>
  214. <span class="method-name">
  215. preprocess_submission
  216. </span>
  217. (<span class="var-type"></span>&nbsp;<span class="var-name">&$submission</span>)
  218. </div>
  219. <ul class="parameters">
  220. <li>
  221. <span class="var-type"></span>
  222. <span class="var-name">&$submission</span> </li>
  223. </ul>
  224. </div>
  225. <a name="methodprint_student_answer" id="print_student_answer"><!-- --></a>
  226. <div class="oddrow">
  227. <div class="method-header">
  228. <img src="../media/images/Method.png" />
  229. <span class="method-title">print_student_answer</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a126">126</a></span>)
  230. </div>
  231. <!-- ========== Info from phpDoc block ========= -->
  232. <div class="method-signature">
  233. <span class="method-result">void</span>
  234. <span class="method-name">
  235. print_student_answer
  236. </span>
  237. (<span class="var-type"></span>&nbsp;<span class="var-name">$userid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return</span> = <span class="var-default">true</span>])
  238. </div>
  239. <ul class="parameters">
  240. <li>
  241. <span class="var-type"></span>
  242. <span class="var-name">$userid</span> </li>
  243. <li>
  244. <span class="var-type"></span>
  245. <span class="var-name">$return</span> </li>
  246. </ul>
  247. </div>
  248. <a name="methodprint_user_files" id="print_user_files"><!-- --></a>
  249. <div class="evenrow">
  250. <div class="method-header">
  251. <img src="../media/images/Method.png" />
  252. <span class="method-title">print_user_files</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a152">152</a></span>)
  253. </div>
  254. <!-- ========== Info from phpDoc block ========= -->
  255. <div class="method-signature">
  256. <span class="method-result">void</span>
  257. <span class="method-name">
  258. print_user_files
  259. </span>
  260. (<span class="var-type"></span>&nbsp;<span class="var-name">$userid</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$return</span> = <span class="var-default">false</span>])
  261. </div>
  262. <ul class="parameters">
  263. <li>
  264. <span class="var-type"></span>
  265. <span class="var-name">$userid</span> </li>
  266. <li>
  267. <span class="var-type"></span>
  268. <span class="var-name">$return</span> </li>
  269. </ul>
  270. </div>
  271. <a name="methodsetup_elements" id="setup_elements"><!-- --></a>
  272. <div class="oddrow">
  273. <div class="method-header">
  274. <img src="../media/images/Method.png" />
  275. <span class="method-title">setup_elements</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a176">176</a></span>)
  276. </div>
  277. <!-- ========== Info from phpDoc block ========= -->
  278. <div class="method-signature">
  279. <span class="method-result">void</span>
  280. <span class="method-name">
  281. setup_elements
  282. </span>
  283. (<span class="var-type"></span>&nbsp;<span class="var-name">&$mform</span>)
  284. </div>
  285. <ul class="parameters">
  286. <li>
  287. <span class="var-type"></span>
  288. <span class="var-name">&$mform</span> </li>
  289. </ul>
  290. </div>
  291. <a name="methodupdate_submission" id="update_submission"><!-- --></a>
  292. <div class="evenrow">
  293. <div class="method-header">
  294. <img src="../media/images/Method.png" />
  295. <span class="method-title">update_submission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a112">112</a></span>)
  296. </div>
  297. <!-- ========== Info from phpDoc block ========= -->
  298. <p class="short-description">Update the submission with the provided data.</p>
  299. <ul class="tags">
  300. <li><span class="field">return:</span> True if successful, or false otherwise.</li>
  301. </ul>
  302. <div class="method-signature">
  303. <span class="method-result">bool</span>
  304. <span class="method-name">
  305. update_submission
  306. </span>
  307. (<span class="var-type">int</span>&nbsp;<span class="var-name">$userid</span>, <span class="var-type"><a href="../sloodle/assignment_sloodleobject_submission.html">assignment_sloodleobject_submission</a></span>&nbsp;<span class="var-name">$data</span>)
  308. </div>
  309. <ul class="parameters">
  310. <li>
  311. <span class="var-type">int</span>
  312. <span class="var-name">$userid</span><span class="var-description">: Integer ID of the user making the submission</span> </li>
  313. <li>
  314. <span class="var-type"><a href="../sloodle/assignment_sloodleobject_submission.html">assignment_sloodleobject_submission</a></span>
  315. <span class="var-name">$data</span><span class="var-description">: A structure containing data about the Sloodle assignment submission</span> </li>
  316. </ul>
  317. </div>
  318. <a name="methodview" id="view"><!-- --></a>
  319. <div class="oddrow">
  320. <div class="method-header">
  321. <img src="../media/images/Method.png" />
  322. <span class="method-title">view</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a36">36</a></span>)
  323. </div>
  324. <!-- ========== Info from phpDoc block ========= -->
  325. <div class="method-signature">
  326. <span class="method-result">void</span>
  327. <span class="method-name">
  328. view
  329. </span>
  330. ()
  331. </div>
  332. </div>
  333. <a name="methodview_dates" id="view_dates"><!-- --></a>
  334. <div class="evenrow">
  335. <div class="method-header">
  336. <img src="../media/images/Method.png" />
  337. <span class="method-title">view_dates</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlemodprimdrop-1.0sloodleobjectassignment.class.php.html#a67">67</a></span>)
  338. </div>
  339. <!-- ========== Info from phpDoc block ========= -->
  340. <div class="method-signature">
  341. <span class="method-result">void</span>
  342. <span class="method-name">
  343. view_dates
  344. </span>
  345. ()
  346. </div>
  347. </div>
  348. </div>
  349. </div>
  350. <p class="notes" id="credit">
  351. Documentation generated on Mon, 16 Jun 2008 15:56:06 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  352. </p>
  353. </div></body>
  354. </html>