assignment_sloodleobject_submission.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  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_submission</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_submission</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  94. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  95. </div>
  96. <div class="info-box-body">
  97. <!-- ========== Info from phpDoc block ========= -->
  98. <p class="short-description">Defines a submission for a Sloodle assignment.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_mod---primdrop-1.0---sloodleobject---assignment.class.php.html">/mod/primdrop-1.0/sloodleobject/assignment.class.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a201">201</a></span>)
  101. </p>
  102. <pre></pre>
  103. </div>
  104. </div>
  105. <a name="sec-var-summary"></a>
  106. <div class="info-box">
  107. <div class="info-box-title">Variable Summary</span></div>
  108. <div class="nav-bar">
  109. <a href="#sec-description">Description</a> |
  110. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  111. |
  112. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  113. </div>
  114. <div class="info-box-body">
  115. <div class="var-summary">
  116. <div class="var-title">
  117. <img src="../media/images/Variable.png" alt=" " />
  118. <span class="var-type">bool</span>
  119. <a href="#$is_loaded" title="details" class="var-name">$is_loaded</a>
  120. </div>
  121. <div class="var-title">
  122. <img src="../media/images/Variable.png" alt=" " />
  123. <span class="var-type">int</span>
  124. <a href="#$num_prims" title="details" class="var-name">$num_prims</a>
  125. </div>
  126. <div class="var-title">
  127. <img src="../media/images/Variable.png" alt=" " />
  128. <span class="var-type">string</span>
  129. <a href="#$obj_name" title="details" class="var-name">$obj_name</a>
  130. </div>
  131. <div class="var-title">
  132. <img src="../media/images/Variable.png" alt=" " />
  133. <span class="var-type">string</span>
  134. <a href="#$primdrop_name" title="details" class="var-name">$primdrop_name</a>
  135. </div>
  136. <div class="var-title">
  137. <img src="../media/images/Variable.png" alt=" " />
  138. <span class="var-type">string</span>
  139. <a href="#$primdrop_pos" title="details" class="var-name">$primdrop_pos</a>
  140. </div>
  141. <div class="var-title">
  142. <img src="../media/images/Variable.png" alt=" " />
  143. <span class="var-type">string</span>
  144. <a href="#$primdrop_region" title="details" class="var-name">$primdrop_region</a>
  145. </div>
  146. <div class="var-title">
  147. <img src="../media/images/Variable.png" alt=" " />
  148. <span class="var-type">string</span>
  149. <a href="#$primdrop_uuid" title="details" class="var-name">$primdrop_uuid</a>
  150. </div>
  151. </div>
  152. </div>
  153. </div>
  154. <a name="sec-method-summary"></a>
  155. <div class="info-box">
  156. <div class="info-box-title">Method Summary</span></div>
  157. <div class="nav-bar">
  158. <a href="#sec-description">Description</a> |
  159. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  160. |
  161. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  162. </div>
  163. <div class="info-box-body">
  164. <div class="method-summary">
  165. <div class="method-definition">
  166. <img src="../media/images/Method.png" alt=" "/>
  167. <span class="method-result">float</span>
  168. <a href="#get_x" title="details" class="method-name">get_x</a>
  169. ()
  170. </div>
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">float</span>
  174. <a href="#get_y" title="details" class="method-name">get_y</a>
  175. ()
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">float</span>
  180. <a href="#get_z" title="details" class="method-name">get_z</a>
  181. ()
  182. </div>
  183. <div class="method-definition">
  184. <img src="../media/images/Method.png" alt=" "/>
  185. <span class="method-result">void</span>
  186. <a href="#load_submission" title="details" class="method-name">load_submission</a>
  187. (<span class="var-type"></span>&nbsp;<span class="var-name">$submission</span>)
  188. </div>
  189. <div class="method-definition">
  190. <img src="../media/images/Method.png" alt=" "/>
  191. <span class="method-result">void</span>
  192. <a href="#set_pos" title="details" class="method-name">set_pos</a>
  193. (<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
  194. </div>
  195. <div class="method-definition">
  196. <img src="../media/images/Method.png" alt=" "/>
  197. <span class="method-result">string</span>
  198. <a href="#text_summary" title="details" class="method-name">text_summary</a>
  199. ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$return</span> = <span class="var-default">true</span>])
  200. </div>
  201. </div>
  202. </div>
  203. </div>
  204. <a name="sec-vars"></a>
  205. <div class="info-box">
  206. <div class="info-box-title">Variables</div>
  207. <div class="nav-bar">
  208. <a href="#sec-description">Description</a> |
  209. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  210. |
  211. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  212. </div>
  213. <div class="info-box-body">
  214. <a name="var$is_loaded" id="$is_loaded"><!-- --></A>
  215. <div class="oddrow">
  216. <div class="var-header">
  217. <img src="../media/images/Variable.png" />
  218. <span class="var-title">
  219. <span class="var-type">bool</span>
  220. <span class="var-name">$is_loaded</span>
  221. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a208">208</a></span>)
  222. </span>
  223. </div>
  224. <!-- ========== Info from phpDoc block ========= -->
  225. <p class="short-description">Indicates whether or not a submission is loaded</p>
  226. <ul class="tags">
  227. <li><span class="field">access:</span> public</li>
  228. </ul>
  229. </div>
  230. <a name="var$num_prims" id="$num_prims"><!-- --></A>
  231. <div class="evenrow">
  232. <div class="var-header">
  233. <img src="../media/images/Variable.png" />
  234. <span class="var-title">
  235. <span class="var-type">int</span>
  236. <span class="var-name">$num_prims</span>
  237. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a222">222</a></span>)
  238. </span>
  239. </div>
  240. <!-- ========== Info from phpDoc block ========= -->
  241. <p class="short-description">Number of prims in the object which has been submitted</p>
  242. <ul class="tags">
  243. <li><span class="field">access:</span> public</li>
  244. </ul>
  245. </div>
  246. <a name="var$obj_name" id="$obj_name"><!-- --></A>
  247. <div class="oddrow">
  248. <div class="var-header">
  249. <img src="../media/images/Variable.png" />
  250. <span class="var-title">
  251. <span class="var-type">string</span>
  252. <span class="var-name">$obj_name</span>
  253. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a215">215</a></span>)
  254. </span>
  255. </div>
  256. <!-- ========== Info from phpDoc block ========= -->
  257. <p class="short-description">Name of the object which has been submitted.</p>
  258. <ul class="tags">
  259. <li><span class="field">access:</span> public</li>
  260. </ul>
  261. </div>
  262. <a name="var$primdrop_name" id="$primdrop_name"><!-- --></A>
  263. <div class="evenrow">
  264. <div class="var-header">
  265. <img src="../media/images/Variable.png" />
  266. <span class="var-title">
  267. <span class="var-type">string</span>
  268. <span class="var-name">$primdrop_name</span>
  269. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a229">229</a></span>)
  270. </span>
  271. </div>
  272. <!-- ========== Info from phpDoc block ========= -->
  273. <p class="short-description">Name of the PrimDrop object into which this object was submitted.</p>
  274. <ul class="tags">
  275. <li><span class="field">access:</span> public</li>
  276. </ul>
  277. </div>
  278. <a name="var$primdrop_pos" id="$primdrop_pos"><!-- --></A>
  279. <div class="oddrow">
  280. <div class="var-header">
  281. <img src="../media/images/Variable.png" />
  282. <span class="var-title">
  283. <span class="var-type">string</span>
  284. <span class="var-name">$primdrop_pos</span>
  285. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a250">250</a></span>)
  286. </span>
  287. </div>
  288. <!-- ========== Info from phpDoc block ========= -->
  289. <p class="short-description">Position where this object was submitted (as a vector, &quot;&lt;x,y,z&gt;&quot;)</p>
  290. <ul class="tags">
  291. <li><span class="field">access:</span> public</li>
  292. </ul>
  293. </div>
  294. <a name="var$primdrop_region" id="$primdrop_region"><!-- --></A>
  295. <div class="evenrow">
  296. <div class="var-header">
  297. <img src="../media/images/Variable.png" />
  298. <span class="var-title">
  299. <span class="var-type">string</span>
  300. <span class="var-name">$primdrop_region</span>
  301. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a243">243</a></span>)
  302. </span>
  303. </div>
  304. <!-- ========== Info from phpDoc block ========= -->
  305. <p class="short-description">Name of the region where this object was submitted</p>
  306. <ul class="tags">
  307. <li><span class="field">access:</span> public</li>
  308. </ul>
  309. </div>
  310. <a name="var$primdrop_uuid" id="$primdrop_uuid"><!-- --></A>
  311. <div class="oddrow">
  312. <div class="var-header">
  313. <img src="../media/images/Variable.png" />
  314. <span class="var-title">
  315. <span class="var-type">string</span>
  316. <span class="var-name">$primdrop_uuid</span>
  317. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a236">236</a></span>)
  318. </span>
  319. </div>
  320. <!-- ========== Info from phpDoc block ========= -->
  321. <p class="short-description">UUID of the PrimDrop object into which this object was submitted.</p>
  322. <ul class="tags">
  323. <li><span class="field">access:</span> public</li>
  324. </ul>
  325. </div>
  326. </div>
  327. </div>
  328. <a name="sec-methods"></a>
  329. <div class="info-box">
  330. <div class="info-box-title">Methods</div>
  331. <div class="nav-bar">
  332. <a href="#sec-description">Description</a> |
  333. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  334. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  335. </div>
  336. <div class="info-box-body">
  337. <A NAME='method_detail'></A>
  338. <a name="methodget_x" id="get_x"><!-- --></a>
  339. <div class="evenrow">
  340. <div class="method-header">
  341. <img src="../media/images/Method.png" />
  342. <span class="method-title">get_x</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a296">296</a></span>)
  343. </div>
  344. <!-- ========== Info from phpDoc block ========= -->
  345. <p class="short-description">Gets the X coordinate of the position</p>
  346. <ul class="tags">
  347. <li><span class="field">return:</span> The X coordinate of the position</li>
  348. </ul>
  349. <div class="method-signature">
  350. <span class="method-result">float</span>
  351. <span class="method-name">
  352. get_x
  353. </span>
  354. ()
  355. </div>
  356. </div>
  357. <a name="methodget_y" id="get_y"><!-- --></a>
  358. <div class="oddrow">
  359. <div class="method-header">
  360. <img src="../media/images/Method.png" />
  361. <span class="method-title">get_y</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a307">307</a></span>)
  362. </div>
  363. <!-- ========== Info from phpDoc block ========= -->
  364. <p class="short-description">Gets the Y coordinate of the position</p>
  365. <ul class="tags">
  366. <li><span class="field">return:</span> The Y coordinate of the position</li>
  367. </ul>
  368. <div class="method-signature">
  369. <span class="method-result">float</span>
  370. <span class="method-name">
  371. get_y
  372. </span>
  373. ()
  374. </div>
  375. </div>
  376. <a name="methodget_z" id="get_z"><!-- --></a>
  377. <div class="evenrow">
  378. <div class="method-header">
  379. <img src="../media/images/Method.png" />
  380. <span class="method-title">get_z</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a318">318</a></span>)
  381. </div>
  382. <!-- ========== Info from phpDoc block ========= -->
  383. <p class="short-description">Gets the Z coordinate of the position</p>
  384. <ul class="tags">
  385. <li><span class="field">return:</span> The Z coordinate of the position</li>
  386. </ul>
  387. <div class="method-signature">
  388. <span class="method-result">float</span>
  389. <span class="method-name">
  390. get_z
  391. </span>
  392. ()
  393. </div>
  394. </div>
  395. <a name="methodload_submission" id="load_submission"><!-- --></a>
  396. <div class="oddrow">
  397. <div class="method-header">
  398. <img src="../media/images/Method.png" />
  399. <span class="method-title">load_submission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a257">257</a></span>)
  400. </div>
  401. <!-- ========== Info from phpDoc block ========= -->
  402. <p class="short-description">Parses the data from a Submission database record object.</p>
  403. <ul class="tags">
  404. <li><span class="field">var:</span> The submission database record object.</li>
  405. </ul>
  406. <div class="method-signature">
  407. <span class="method-result">void</span>
  408. <span class="method-name">
  409. load_submission
  410. </span>
  411. (<span class="var-type"></span>&nbsp;<span class="var-name">$submission</span>)
  412. </div>
  413. <ul class="parameters">
  414. <li>
  415. <span class="var-type"></span>
  416. <span class="var-name">$submission</span> </li>
  417. </ul>
  418. </div>
  419. <a name="methodset_pos" id="set_pos"><!-- --></a>
  420. <div class="evenrow">
  421. <div class="method-header">
  422. <img src="../media/images/Method.png" />
  423. <span class="method-title">set_pos</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a287">287</a></span>)
  424. </div>
  425. <!-- ========== Info from phpDoc block ========= -->
  426. <p class="short-description">Sets the position as 3 components.</p>
  427. <div class="method-signature">
  428. <span class="method-result">void</span>
  429. <span class="method-name">
  430. set_pos
  431. </span>
  432. (<span class="var-type">float</span>&nbsp;<span class="var-name">$x</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$y</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$z</span>)
  433. </div>
  434. <ul class="parameters">
  435. <li>
  436. <span class="var-type">float</span>
  437. <span class="var-name">$x</span><span class="var-description">: x The X coordinate</span> </li>
  438. <li>
  439. <span class="var-type">float</span>
  440. <span class="var-name">$y</span><span class="var-description">: y The Y coordinate</span> </li>
  441. <li>
  442. <span class="var-type">float</span>
  443. <span class="var-name">$z</span><span class="var-description">: z The Z coordinate</span> </li>
  444. </ul>
  445. </div>
  446. <a name="methodtext_summary" id="text_summary"><!-- --></a>
  447. <div class="oddrow">
  448. <div class="method-header">
  449. <img src="../media/images/Method.png" />
  450. <span class="method-title">text_summary</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodleprimdrop__modprimdrop-1.0sloodleobjectassignment.class.php.html#a330">330</a></span>)
  451. </div>
  452. <!-- ========== Info from phpDoc block ========= -->
  453. <p class="short-description">Construct a text summary of this submission.</p>
  454. <ul class="tags">
  455. <li><span class="field">return:</span> If parameter $return was TRUE, then it returns the string. Otherwise, an empty string.</li>
  456. </ul>
  457. <div class="method-signature">
  458. <span class="method-result">string</span>
  459. <span class="method-name">
  460. text_summary
  461. </span>
  462. ([<span class="var-type">bool</span>&nbsp;<span class="var-name">$return</span> = <span class="var-default">true</span>])
  463. </div>
  464. <ul class="parameters">
  465. <li>
  466. <span class="var-type">bool</span>
  467. <span class="var-name">$return</span><span class="var-description">: If TRUE (default) then the text will be submitted instead of printed.</span> </li>
  468. </ul>
  469. </div>
  470. </div>
  471. </div>
  472. <p class="notes" id="credit">
  473. Documentation generated on Mon, 07 Jul 2008 12:32:13 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  474. </p>
  475. </div></body>
  476. </html>