SloodleModuleSloodleObject.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924
  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 SloodleModuleSloodleObject</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"> SloodleModuleSloodleObject</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">The Sloodle Object assignment module class.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_lib---modules---module_sloodleobject.php.html">/lib/modules/module_sloodleobject.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a30">30</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
  103. |
  104. --SloodleModuleSloodleObject</pre>
  105. </div>
  106. </div>
  107. <a name="sec-var-summary"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Variable Summary</span></div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  113. |
  114. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <div class="var-summary">
  118. <div class="var-title">
  119. <img src="../media/images/PrivateVariable.png" alt=" " />
  120. <span class="var-type"><a href="../sloodle/assignment_sloodleobject.html">assignment_sloodleobject</a></span>
  121. <a href="#$assignment" title="details" class="var-name">$assignment</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/PrivateVariable.png" alt=" " />
  125. <span class="var-type">object</span>
  126. <a href="#$cm" title="details" class="var-name">$cm</a>
  127. </div>
  128. <div class="var-title">
  129. <img src="../media/images/PrivateVariable.png" alt=" " />
  130. <span class="var-type">object</span>
  131. <a href="#$moodle_assignment_instance" title="details" class="var-name">$moodle_assignment_instance</a>
  132. </div>
  133. </div>
  134. </div>
  135. </div>
  136. <a name="sec-method-summary"></a>
  137. <div class="info-box">
  138. <div class="info-box-title">Method Summary</span></div>
  139. <div class="nav-bar">
  140. <a href="#sec-description">Description</a> |
  141. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  142. |
  143. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  144. </div>
  145. <div class="info-box-body">
  146. <div class="method-summary">
  147. <div class="method-definition">
  148. <img src="../media/images/Constructor.png" alt=" "/>
  149. <span class="method-result">SloodleModuleSloodleObject</span>
  150. <a href="#SloodleModuleSloodleObject" title="details" class="method-name">SloodleModuleSloodleObject</a>
  151. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  152. </div>
  153. <div class="method-definition">
  154. <img src="../media/images/Method.png" alt=" "/>
  155. <span class="method-result">mixed</span>
  156. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  157. ()
  158. </div>
  159. <div class="method-definition">
  160. <img src="../media/images/Method.png" alt=" "/>
  161. <span class="method-result">int</span>
  162. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  163. ()
  164. </div>
  165. <div class="method-definition">
  166. <img src="../media/images/Method.png" alt=" "/>
  167. <span class="method-result">string</span>
  168. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  169. ()
  170. </div>
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">int</span>
  174. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  175. ()
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">string</span>
  180. <a href="#get_name" title="details" class="method-name">get_name</a>
  181. ()
  182. </div>
  183. <div class="method-definition">
  184. <img src="../media/images/Method.png" alt=" "/>
  185. <span class="method-result">string</span>
  186. <a href="#get_type" title="details" class="method-name">get_type</a>
  187. ()
  188. </div>
  189. <div class="method-definition">
  190. <img src="../media/images/Method.png" alt=" "/>
  191. <span class="method-result">string</span>
  192. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  193. ()
  194. </div>
  195. <div class="method-definition">
  196. <img src="../media/images/Method.png" alt=" "/>
  197. <span class="method-result">bool</span>
  198. <a href="#is_too_early" title="details" class="method-name">is_too_early</a>
  199. ([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  200. </div>
  201. <div class="method-definition">
  202. <img src="../media/images/Method.png" alt=" "/>
  203. <span class="method-result">int</span>
  204. <a href="#is_too_late" title="details" class="method-name">is_too_late</a>
  205. ([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  206. </div>
  207. <div class="method-definition">
  208. <img src="../media/images/Method.png" alt=" "/>
  209. <span class="method-result">bool</span>
  210. <a href="#load" title="details" class="method-name">load</a>
  211. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  212. </div>
  213. <div class="method-definition">
  214. <img src="../media/images/Method.png" alt=" "/>
  215. <span class="method-result">bool</span>
  216. <a href="#resubmit_allowed" title="details" class="method-name">resubmit_allowed</a>
  217. ()
  218. </div>
  219. <div class="method-definition">
  220. <img src="../media/images/Method.png" alt=" "/>
  221. <span class="method-result">bool</span>
  222. <a href="#submit" title="details" class="method-name">submit</a>
  223. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$obj_name</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$num_prims</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_region</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_pos</span>)
  224. </div>
  225. <div class="method-definition">
  226. <img src="../media/images/Method.png" alt=" "/>
  227. <span class="method-result">bool</span>
  228. <a href="#user_can_submit" title="details" class="method-name">user_can_submit</a>
  229. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
  230. </div>
  231. <div class="method-definition">
  232. <img src="../media/images/Method.png" alt=" "/>
  233. <span class="method-result">bool</span>
  234. <a href="#user_can_view" title="details" class="method-name">user_can_view</a>
  235. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
  236. </div>
  237. <div class="method-definition">
  238. <img src="../media/images/Method.png" alt=" "/>
  239. <span class="method-result">bool</span>
  240. <a href="#user_has_submitted" title="details" class="method-name">user_has_submitted</a>
  241. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
  242. </div>
  243. </div>
  244. </div>
  245. </div>
  246. <a name="sec-vars"></a>
  247. <div class="info-box">
  248. <div class="info-box-title">Variables</div>
  249. <div class="nav-bar">
  250. <a href="#sec-description">Description</a> |
  251. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  252. |
  253. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  254. </div>
  255. <div class="info-box-body">
  256. <a name="var$assignment" id="$assignment"><!-- --></A>
  257. <div class="oddrow">
  258. <div class="var-header">
  259. <img src="../media/images/PrivateVariable.png" />
  260. <span class="var-title">
  261. <span class="var-type"><a href="../sloodle/assignment_sloodleobject.html">assignment_sloodleobject</a></span>
  262. <span class="var-name">$assignment</span>
  263. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a55">55</a></span>)
  264. </span>
  265. </div>
  266. <!-- ========== Info from phpDoc block ========= -->
  267. <p class="short-description">Internal only - the Moodle assignment structure.</p>
  268. <ul class="tags">
  269. <li><span class="field">access:</span> private</li>
  270. </ul>
  271. </div>
  272. <a name="var$cm" id="$cm"><!-- --></A>
  273. <div class="evenrow">
  274. <div class="var-header">
  275. <img src="../media/images/PrivateVariable.png" />
  276. <span class="var-title">
  277. <span class="var-type">object</span>
  278. <span class="var-name">$cm</span>
  279. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a40">40</a></span>)
  280. </span>
  281. </div>
  282. <!-- ========== Info from phpDoc block ========= -->
  283. <p class="short-description">Internal for Moodle only - course module instance.</p>
  284. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
  285. <ul class="tags">
  286. <li><span class="field">access:</span> private</li>
  287. </ul>
  288. </div>
  289. <a name="var$moodle_assignment_instance" id="$moodle_assignment_instance"><!-- --></A>
  290. <div class="oddrow">
  291. <div class="var-header">
  292. <img src="../media/images/PrivateVariable.png" />
  293. <span class="var-title">
  294. <span class="var-type">object</span>
  295. <span class="var-name">$moodle_assignment_instance</span>
  296. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a48">48</a></span>)
  297. </span>
  298. </div>
  299. <!-- ========== Info from phpDoc block ========= -->
  300. <p class="short-description">Internal only - Moodle assignment module instance database object.</p>
  301. <p class="description"><p>Corresponds to one record from the Moodle 'assignment' table.</p></p>
  302. <ul class="tags">
  303. <li><span class="field">access:</span> private</li>
  304. </ul>
  305. </div>
  306. <h4>Inherited Variables</h4>
  307. <A NAME='inherited_vars'><!-- --></A>
  308. <p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  309. <blockquote>
  310. <img src="../media/images/Variable.png" />
  311. <span class="var-title">
  312. <span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
  313. </span>
  314. </blockquote>
  315. </div>
  316. </div>
  317. <a name="sec-methods"></a>
  318. <div class="info-box">
  319. <div class="info-box-title">Methods</div>
  320. <div class="nav-bar">
  321. <a href="#sec-description">Description</a> |
  322. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  323. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  324. </div>
  325. <div class="info-box-body">
  326. <A NAME='method_detail'></A>
  327. <a name="methodSloodleModuleSloodleObject" id="SloodleModuleSloodleObject"><!-- --></a>
  328. <div class="evenrow">
  329. <div class="method-header">
  330. <img src="../media/images/Constructor.png" />
  331. <span class="method-title">Constructor SloodleModuleSloodleObject</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a63">63</a></span>)
  332. </div>
  333. <!-- ========== Info from phpDoc block ========= -->
  334. <p class="short-description">Constructor</p>
  335. <div class="method-signature">
  336. <span class="method-result">SloodleModuleSloodleObject</span>
  337. <span class="method-name">
  338. SloodleModuleSloodleObject
  339. </span>
  340. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  341. </div>
  342. <ul class="parameters">
  343. <li>
  344. <span class="var-type"></span>
  345. <span class="var-name">&$_session</span> </li>
  346. </ul>
  347. </div>
  348. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  349. <div class="oddrow">
  350. <div class="method-header">
  351. <img src="../media/images/Method.png" />
  352. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a257">257</a></span>)
  353. </div>
  354. <!-- ========== Info from phpDoc block ========= -->
  355. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  356. <ul class="tags">
  357. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  358. </ul>
  359. <div class="method-signature">
  360. <span class="method-result">mixed</span>
  361. <span class="method-name">
  362. get_course_id
  363. </span>
  364. ()
  365. </div>
  366. <hr class="separator" />
  367. <div class="notes">Redefinition of:</div>
  368. <dl>
  369. <dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
  370. <dd>Gets the identifier of the course this controller belongs to.</dd>
  371. </dl>
  372. </div>
  373. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  374. <div class="evenrow">
  375. <div class="method-header">
  376. <img src="../media/images/Method.png" />
  377. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a266">266</a></span>)
  378. </div>
  379. <!-- ========== Info from phpDoc block ========= -->
  380. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  381. <ul class="tags">
  382. <li><span class="field">return:</span> Timestamp</li>
  383. </ul>
  384. <div class="method-signature">
  385. <span class="method-result">int</span>
  386. <span class="method-name">
  387. get_creation_time
  388. </span>
  389. ()
  390. </div>
  391. <hr class="separator" />
  392. <div class="notes">Redefinition of:</div>
  393. <dl>
  394. <dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
  395. <dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
  396. </dl>
  397. </div>
  398. <a name="methodget_intro" id="get_intro"><!-- --></a>
  399. <div class="oddrow">
  400. <div class="method-header">
  401. <img src="../media/images/Method.png" />
  402. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a248">248</a></span>)
  403. </div>
  404. <!-- ========== Info from phpDoc block ========= -->
  405. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  406. <ul class="tags">
  407. <li><span class="field">return:</span> The intro description of this controller</li>
  408. </ul>
  409. <div class="method-signature">
  410. <span class="method-result">string</span>
  411. <span class="method-name">
  412. get_intro
  413. </span>
  414. ()
  415. </div>
  416. <hr class="separator" />
  417. <div class="notes">Redefinition of:</div>
  418. <dl>
  419. <dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
  420. <dd>Gets the intro description of this module instance, if available.</dd>
  421. </dl>
  422. </div>
  423. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  424. <div class="evenrow">
  425. <div class="method-header">
  426. <img src="../media/images/Method.png" />
  427. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a275">275</a></span>)
  428. </div>
  429. <!-- ========== Info from phpDoc block ========= -->
  430. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  431. <ul class="tags">
  432. <li><span class="field">return:</span> Timestamp</li>
  433. </ul>
  434. <div class="method-signature">
  435. <span class="method-result">int</span>
  436. <span class="method-name">
  437. get_modification_time
  438. </span>
  439. ()
  440. </div>
  441. <hr class="separator" />
  442. <div class="notes">Redefinition of:</div>
  443. <dl>
  444. <dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
  445. <dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
  446. </dl>
  447. </div>
  448. <a name="methodget_name" id="get_name"><!-- --></a>
  449. <div class="oddrow">
  450. <div class="method-header">
  451. <img src="../media/images/Method.png" />
  452. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a239">239</a></span>)
  453. </div>
  454. <!-- ========== Info from phpDoc block ========= -->
  455. <p class="short-description">Gets the name of this module instance.</p>
  456. <ul class="tags">
  457. <li><span class="field">return:</span> The name of this controller</li>
  458. </ul>
  459. <div class="method-signature">
  460. <span class="method-result">string</span>
  461. <span class="method-name">
  462. get_name
  463. </span>
  464. ()
  465. </div>
  466. <hr class="separator" />
  467. <div class="notes">Redefinition of:</div>
  468. <dl>
  469. <dt><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></dt>
  470. <dd>Gets the name of this module instance.</dd>
  471. </dl>
  472. </div>
  473. <a name="methodget_type" id="get_type"><!-- --></a>
  474. <div class="evenrow">
  475. <div class="method-header">
  476. <img src="../media/images/Method.png" />
  477. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a285">285</a></span>)
  478. </div>
  479. <!-- ========== Info from phpDoc block ========= -->
  480. <p class="short-description">Gets the short type name of this instance.</p>
  481. <div class="method-signature">
  482. <span class="method-result">string</span>
  483. <span class="method-name">
  484. get_type
  485. </span>
  486. ()
  487. </div>
  488. <hr class="separator" />
  489. <div class="notes">Redefinition of:</div>
  490. <dl>
  491. <dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
  492. <dd>Gets the short type name of this instance.</dd>
  493. </dl>
  494. </div>
  495. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  496. <div class="oddrow">
  497. <div class="method-header">
  498. <img src="../media/images/Method.png" />
  499. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a295">295</a></span>)
  500. </div>
  501. <!-- ========== Info from phpDoc block ========= -->
  502. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  503. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  504. <ul class="tags">
  505. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  506. </ul>
  507. <div class="method-signature">
  508. <span class="method-result">string</span>
  509. <span class="method-name">
  510. get_type_full
  511. </span>
  512. ()
  513. </div>
  514. <hr class="separator" />
  515. <div class="notes">Redefinition of:</div>
  516. <dl>
  517. <dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
  518. <dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
  519. </dl>
  520. </div>
  521. <a name="methodis_too_early" id="is_too_early"><!-- --></a>
  522. <div class="evenrow">
  523. <div class="method-header">
  524. <img src="../media/images/Method.png" />
  525. <span class="method-title">is_too_early</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a168">168</a></span>)
  526. </div>
  527. <!-- ========== Info from phpDoc block ========= -->
  528. <p class="short-description">Checks if an assignment submitted at the specified time would be too early for submission.</p>
  529. <ul class="tags">
  530. <li><span class="field">return:</span> True if assignment would be too early, or false if it's OK.</li>
  531. </ul>
  532. <div class="method-signature">
  533. <span class="method-result">bool</span>
  534. <span class="method-name">
  535. is_too_early
  536. </span>
  537. ([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  538. </div>
  539. <ul class="parameters">
  540. <li>
  541. <span class="var-type">int</span>
  542. <span class="var-name">$timestamp</span><span class="var-description">: A timestamp giving the time to check (if omitted, it defaults to the current timestamp)</span> </li>
  543. </ul>
  544. </div>
  545. <a name="methodis_too_late" id="is_too_late"><!-- --></a>
  546. <div class="oddrow">
  547. <div class="method-header">
  548. <img src="../media/images/Method.png" />
  549. <span class="method-title">is_too_late</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a183">183</a></span>)
  550. </div>
  551. <!-- ========== Info from phpDoc block ========= -->
  552. <p class="short-description">Checks if an assignment submitted at the specified time would be too late for submission.</p>
  553. <ul class="tags">
  554. <li><span class="field">return:</span> 1 if assignment would be too late and cannot be accepted, 0 if it is OK, or -1 if it would be late but still accepted</li>
  555. </ul>
  556. <div class="method-signature">
  557. <span class="method-result">int</span>
  558. <span class="method-name">
  559. is_too_late
  560. </span>
  561. ([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  562. </div>
  563. <ul class="parameters">
  564. <li>
  565. <span class="var-type">int</span>
  566. <span class="var-name">$timestamp</span><span class="var-description">: A timestamp giving the time to check (if omitted, it defaults to the current timestamp)</span> </li>
  567. </ul>
  568. </div>
  569. <a name="methodload" id="load"><!-- --></a>
  570. <div class="evenrow">
  571. <div class="method-header">
  572. <img src="../media/images/Method.png" />
  573. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a75">75</a></span>)
  574. </div>
  575. <!-- ========== Info from phpDoc block ========= -->
  576. <p class="short-description">Loads data from the database.</p>
  577. <p class="description"><p>Note: even if the function fails, it may still have overwritten some or all existing data in the object.</p></p>
  578. <ul class="tags">
  579. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  580. </ul>
  581. <div class="method-signature">
  582. <span class="method-result">bool</span>
  583. <span class="method-name">
  584. load
  585. </span>
  586. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  587. </div>
  588. <ul class="parameters">
  589. <li>
  590. <span class="var-type">mixed</span>
  591. <span class="var-name">$id</span><span class="var-description">: The site-wide unique identifier for all modules. Type depends on VLE. On Moodle, it is an integer course module identifier ('id' field of 'course_modules' table)</span> </li>
  592. </ul>
  593. <hr class="separator" />
  594. <div class="notes">Redefinition of:</div>
  595. <dl>
  596. <dt><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></dt>
  597. <dd>Loads data from the database.</dd>
  598. </dl>
  599. </div>
  600. <a name="methodresubmit_allowed" id="resubmit_allowed"><!-- --></a>
  601. <div class="oddrow">
  602. <div class="method-header">
  603. <img src="../media/images/Method.png" />
  604. <span class="method-title">resubmit_allowed</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a157">157</a></span>)
  605. </div>
  606. <!-- ========== Info from phpDoc block ========= -->
  607. <p class="short-description">Checks if re-submissions are permitted.</p>
  608. <ul class="tags">
  609. <li><span class="field">return:</span> True if resubmissions are permitted, or false otherwise</li>
  610. </ul>
  611. <div class="method-signature">
  612. <span class="method-result">bool</span>
  613. <span class="method-name">
  614. resubmit_allowed
  615. </span>
  616. ()
  617. </div>
  618. </div>
  619. <a name="methodsubmit" id="submit"><!-- --></a>
  620. <div class="evenrow">
  621. <div class="method-header">
  622. <img src="../media/images/Method.png" />
  623. <span class="method-title">submit</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a215">215</a></span>)
  624. </div>
  625. <!-- ========== Info from phpDoc block ========= -->
  626. <p class="short-description">Add a new submission (or replace an existing one).</p>
  627. <p class="description"><p>Ignores all submission checks, such as permissions and time.</p></p>
  628. <ul class="tags">
  629. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  630. </ul>
  631. <div class="method-signature">
  632. <span class="method-result">bool</span>
  633. <span class="method-name">
  634. submit
  635. </span>
  636. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$obj_name</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$num_prims</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_region</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$primdrop_pos</span>)
  637. </div>
  638. <ul class="parameters">
  639. <li>
  640. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  641. <span class="var-name">$user</span><span class="var-description">: The user making the submission</span> </li>
  642. <li>
  643. <span class="var-type">string</span>
  644. <span class="var-name">$obj_name</span><span class="var-description">: Name of the object being submitted</span> </li>
  645. <li>
  646. <span class="var-type">int</span>
  647. <span class="var-name">$num_prims</span><span class="var-description">: Number of prims in the object being submitted</span> </li>
  648. <li>
  649. <span class="var-type">string</span>
  650. <span class="var-name">$primdrop_name</span><span class="var-description">: Name of the PrimDrop being submitted to</span> </li>
  651. <li>
  652. <span class="var-type">string</span>
  653. <span class="var-name">$primdrop_uuid</span><span class="var-description">: UUID of the PrimDrop being submitted to</span> </li>
  654. <li>
  655. <span class="var-type">string</span>
  656. <span class="var-name">$primdrop_region</span><span class="var-description">: Region of the PrimDrop being submitted to</span> </li>
  657. <li>
  658. <span class="var-type">string</span>
  659. <span class="var-name">$primdrop_pos</span><span class="var-description">: Position vector (&lt;x,y,z&gt;) of the PrimDrop being submitted to</span> </li>
  660. </ul>
  661. </div>
  662. <a name="methoduser_can_submit" id="user_can_submit"><!-- --></a>
  663. <div class="oddrow">
  664. <div class="method-header">
  665. <img src="../media/images/Method.png" />
  666. <span class="method-title">user_can_submit</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a116">116</a></span>)
  667. </div>
  668. <!-- ========== Info from phpDoc block ========= -->
  669. <p class="short-description">Checks if the specified user is permitted to submit to this assignment.</p>
  670. <p class="description"><p>(Note: this only checks permissions, and no other settings, such as submission times).</p></p>
  671. <ul class="tags">
  672. <li><span class="field">return:</span> True if the user has permission to submit to this assignment, or false otherwise.</li>
  673. </ul>
  674. <div class="method-signature">
  675. <span class="method-result">bool</span>
  676. <span class="method-name">
  677. user_can_submit
  678. </span>
  679. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
  680. </div>
  681. <ul class="parameters">
  682. <li>
  683. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  684. <span class="var-name">$user</span><span class="var-description">: The user to be checked</span> </li>
  685. </ul>
  686. </div>
  687. <a name="methoduser_can_view" id="user_can_view"><!-- --></a>
  688. <div class="evenrow">
  689. <div class="method-header">
  690. <img src="../media/images/Method.png" />
  691. <span class="method-title">user_can_view</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a130">130</a></span>)
  692. </div>
  693. <!-- ========== Info from phpDoc block ========= -->
  694. <p class="short-description">Checks if the specified user is permitted to view submissions to this assignment.</p>
  695. <ul class="tags">
  696. <li><span class="field">return:</span> True if the user has permission to view the submissions, or false otherwise.</li>
  697. </ul>
  698. <div class="method-signature">
  699. <span class="method-result">bool</span>
  700. <span class="method-name">
  701. user_can_view
  702. </span>
  703. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
  704. </div>
  705. <ul class="parameters">
  706. <li>
  707. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  708. <span class="var-name">$user</span><span class="var-description">: The user to be checked</span> </li>
  709. </ul>
  710. </div>
  711. <a name="methoduser_has_submitted" id="user_has_submitted"><!-- --></a>
  712. <div class="oddrow">
  713. <div class="method-header">
  714. <img src="../media/images/Method.png" />
  715. <span class="method-title">user_has_submitted</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_sloodleobject.php.html#a144">144</a></span>)
  716. </div>
  717. <!-- ========== Info from phpDoc block ========= -->
  718. <p class="short-description">Checks if the specified user has submitted to this assignment already.</p>
  719. <ul class="tags">
  720. <li><span class="field">return:</span> True if the user has previously attempted this assignment, or false otherwise</li>
  721. </ul>
  722. <div class="method-signature">
  723. <span class="method-result">bool</span>
  724. <span class="method-name">
  725. user_has_submitted
  726. </span>
  727. (<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
  728. </div>
  729. <ul class="parameters">
  730. <li>
  731. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  732. <span class="var-name">$user</span><span class="var-description">: The user to be checked</span> </li>
  733. </ul>
  734. </div>
  735. <h4>Inherited Methods</h4>
  736. <a name='inherited_methods'><!-- --></a>
  737. <!-- =========== Summary =========== -->
  738. <p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  739. <blockquote>
  740. <img src="../media/images/Constructor.png" alt=" "/>
  741. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
  742. <img src="../media/images/Method.png" alt=" "/>
  743. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
  744. <img src="../media/images/Method.png" alt=" "/>
  745. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
  746. <img src="../media/images/Method.png" alt=" "/>
  747. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
  748. <img src="../media/images/Method.png" alt=" "/>
  749. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
  750. <img src="../media/images/Method.png" alt=" "/>
  751. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
  752. <img src="../media/images/Method.png" alt=" "/>
  753. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
  754. <img src="../media/images/Method.png" alt=" "/>
  755. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
  756. <img src="../media/images/Method.png" alt=" "/>
  757. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
  758. </blockquote>
  759. </div>
  760. </div>
  761. <p class="notes" id="credit">
  762. Documentation generated on Mon, 07 Jul 2008 12:33:00 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  763. </p>
  764. </div></body>
  765. </html>