Accueil Explorer Aide
S'inscrire Connexion
Ayuda_Virtual
/
sloodle_website
2
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki
Branche: master
Branches Tags
sloodle_webs...
/
webroot
/
phpdocs
/
0.3-beta-2008070702
/
sloodle
/
SloodleModuleChoice.html

SloodleModuleChoice.html 37 KB
Lien permanent Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971 
  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos  -->
    6. 

  6. 			<title>Docs For Class SloodleModuleChoice</title>
    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />
    8. 

  8. 						<script src="../media/lib/classTree.js"></script>
    9. 

  9. 												<script language="javascript" type="text/javascript">
    10. 

  10. 				var imgPlus = new Image();
    11. 

  11. 				var imgMinus = new Image();
    12. 

  12. 				imgPlus.src = "../media/images/plus.png";
    13. 

  13. 				imgMinus.src = "../media/images/minus.png";
    14. 

  14. 				
    15. 

  15. 				function showNode(Node){
    16. 

  16. 							switch(navigator.family){
    17. 

  17. 								case 'nn4':
    18. 

  18. 									// Nav 4.x code fork...
    19. 

  19. 							var oTable = document.layers["span" + Node];
    20. 

  20. 							var oImg = document.layers["img" + Node];
    21. 

  21. 									break;
    22. 

  22. 								case 'ie4':
    23. 

  23. 									// IE 4/5 code fork...
    24. 

  24. 							var oTable = document.all["span" + Node];
    25. 

  25. 							var oImg = document.all["img" + Node];
    26. 

  26. 									break;
    27. 

  27. 								case 'gecko':
    28. 

  28. 									// Standards Compliant code fork...
    29. 

  29. 							var oTable = document.getElementById("span" + Node);
    30. 

  30. 							var oImg = document.getElementById("img" + Node);
    31. 

  31. 									break;
    32. 

  32. 							}
    33. 

  33. 					oImg.src = imgMinus.src;
    34. 

  34. 					oTable.style.display = "block";
    35. 

  35. 				}
    36. 

  36. 				
    37. 

  37. 				function hideNode(Node){
    38. 

  38. 							switch(navigator.family){
    39. 

  39. 								case 'nn4':
    40. 

  40. 									// Nav 4.x code fork...
    41. 

  41. 							var oTable = document.layers["span" + Node];
    42. 

  42. 							var oImg = document.layers["img" + Node];
    43. 

  43. 									break;
    44. 

  44. 								case 'ie4':
    45. 

  45. 									// IE 4/5 code fork...
    46. 

  46. 							var oTable = document.all["span" + Node];
    47. 

  47. 							var oImg = document.all["img" + Node];
    48. 

  48. 									break;
    49. 

  49. 								case 'gecko':
    50. 

  50. 									// Standards Compliant code fork...
    51. 

  51. 							var oTable = document.getElementById("span" + Node);
    52. 

  52. 							var oImg = document.getElementById("img" + Node);
    53. 

  53. 									break;
    54. 

  54. 							}
    55. 

  55. 					oImg.src = imgPlus.src;
    56. 

  56. 					oTable.style.display = "none";
    57. 

  57. 				}
    58. 

  58. 				
    59. 

  59. 				function nodeIsVisible(Node){
    60. 

  60. 							switch(navigator.family){
    61. 

  61. 								case 'nn4':
    62. 

  62. 									// Nav 4.x code fork...
    63. 

  63. 							var oTable = document.layers["span" + Node];
    64. 

  64. 									break;
    65. 

  65. 								case 'ie4':
    66. 

  66. 									// IE 4/5 code fork...
    67. 

  67. 							var oTable = document.all["span" + Node];
    68. 

  68. 									break;
    69. 

  69. 								case 'gecko':
    70. 

  70. 									// Standards Compliant code fork...
    71. 

  71. 							var oTable = document.getElementById("span" + Node);
    72. 

  72. 									break;
    73. 

  73. 							}
    74. 

  74. 					return (oTable && oTable.style.display == "block");
    75. 

  75. 				}
    76. 

  76. 				
    77. 

  77. 				function toggleNodeVisibility(Node){
    78. 

  78. 					if (nodeIsVisible(Node)){
    79. 

  79. 						hideNode(Node);
    80. 

  80. 					}else{
    81. 

  81. 						showNode(Node);
    82. 

  82. 					}
    83. 

  83. 				}
    84. 

  84. 			</script>
    85. 

  85. 					</head>
    86. 

  86. 		<body>
    87. 

  87. 			<div class="page-body">			
    88. 

  88. <h2 class="class-name"><img src="../media/images/Class_logo.png"
    89. 

  89. 														alt=" Class"
    90. 

  90. 														title=" Class"
    91. 

  91. 														style="vertical-align: middle"> SloodleModuleChoice</h2>
    92. 

  92. 

  93. <a name="sec-description"></a>
    94. 

  94. <div class="info-box">
    95. 

  95. 	<div class="info-box-title">Description</div>
    96. 

  96. 	<div class="nav-bar">
    97. 

  97. 					<span class="disabled">Description</span> |
    98. 

  98. 													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    99. 

  99. 						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    100. 

  100. 						
    101. 

  101. 					</div>
    102. 

  102. 	<div class="info-box-body">
    103. 

  103.         		<!-- ========== Info from phpDoc block ========= -->
    104. 

  104. <p class="short-description">The Sloodle choice module class.</p>
    105. 

  105. 		<p class="notes">
    106. 

  106. 			Located in <a class="field" href="_lib---modules---module_choice.php.html">/lib/modules/module_choice.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a26">26</a></span>)
    107. 

  107. 		</p>
    108. 

  108. 		
    109. 

  109. 				
    110. 

  110. 		<pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
    111. 

  111.    |
    112. 

  112.    --SloodleModuleChoice</pre>
    113. 

  113. 	
    114. 

  114. 			</div>
    115. 

  115. </div>
    116. 

  116. 

  117. 

  118. 

  119. 	<a name="sec-var-summary"></a>
    120. 

  120. 	<div class="info-box">
    121. 

  121. 		<div class="info-box-title">Variable Summary</span></div>
    122. 

  122. 		<div class="nav-bar">
    123. 

  123. 			<a href="#sec-description">Description</a> |
    124. 

  124. 						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
    125. 

  125. 							| 
    126. 

  126. 									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    127. 

  127. 							
    128. 

  128. 								</div>
    129. 

  129. 		<div class="info-box-body">
    130. 

  130. 			<div class="var-summary">
    131. 

  131. 																																																<div class="var-title">
    132. 

  132. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    133. 

  133. 					<span class="var-type">object</span>
    134. 

  134. 					<a href="#$cm" title="details" class="var-name">$cm</a>
    135. 

  135. 				</div>
    136. 

  136. 																<div class="var-title">
    137. 

  137. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    138. 

  138. 					<span class="var-type">object</span>
    139. 

  139. 					<a href="#$moodle_choice_instance" title="details" class="var-name">$moodle_choice_instance</a>
    140. 

  140. 				</div>
    141. 

  141. 																<div class="var-title">
    142. 

  142. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    143. 

  143. 					<span class="var-type">int</span>
    144. 

  144. 					<a href="#$numunanswered" title="details" class="var-name">$numunanswered</a>
    145. 

  145. 				</div>
    146. 

  146. 																<div class="var-title">
    147. 

  147. 					<img src="../media/images/Variable.png" alt=" " />
    148. 

  148. 					<span class="var-type">array</span>
    149. 

  149. 					<a href="#$options" title="details" class="var-name">$options</a>
    150. 

  150. 				</div>
    151. 

  151. 											</div>
    152. 

  152. 		</div>
    153. 

  153. 	</div>
    154. 

  154. 

  155. 	<a name="sec-method-summary"></a>
    156. 

  156. 	<div class="info-box">
    157. 

  157. 		<div class="info-box-title">Method Summary</span></div>
    158. 

  158. 		<div class="nav-bar">
    159. 

  159. 			<a href="#sec-description">Description</a> |
    160. 

  160. 																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    161. 

  161. 				 
    162. 

  162. 				|
    163. 

  163. 						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    164. 

  164. 		</div>
    165. 

  165. 		<div class="info-box-body">			
    166. 

  166. 			<div class="method-summary">
    167. 

  167. 																																																																																																																																																															
    168. 

  168. 				<div class="method-definition">
    169. 

  169. 					<img src="../media/images/Constructor.png" alt=" "/>
    170. 

  170. 											<span class="method-result">SloodleModuleChoice</span>
    171. 

  171. 										<a href="#SloodleModuleChoice" title="details" class="method-name">SloodleModuleChoice</a>
    172. 

  172. 											(<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
    173. 

  173. 									</div>
    174. 

  174. 															
    175. 

  175. 				<div class="method-definition">
    176. 

  176. 					<img src="../media/images/Method.png" alt=" "/>
    177. 

  177. 											<span class="method-result">bool</span>
    178. 

  178. 										<a href="#allow_update" title="details" class="method-name">allow_update</a>
    179. 

  179. 										()
    180. 

  180. 									</div>
    181. 

  181. 															
    182. 

  182. 				<div class="method-definition">
    183. 

  183. 					<img src="../media/images/Method.png" alt=" "/>
    184. 

  184. 											<span class="method-result">bool</span>
    185. 

  185. 										<a href="#can_show_results" title="details" class="method-name">can_show_results</a>
    186. 

  186. 										()
    187. 

  187. 									</div>
    188. 

  188. 															
    189. 

  189. 				<div class="method-definition">
    190. 

  190. 					<img src="../media/images/Method.png" alt=" "/>
    191. 

  191. 											<span class="method-result">int</span>
    192. 

  192. 										<a href="#get_closing_time" title="details" class="method-name">get_closing_time</a>
    193. 

  193. 										()
    194. 

  194. 									</div>
    195. 

  195. 															
    196. 

  196. 				<div class="method-definition">
    197. 

  197. 					<img src="../media/images/Method.png" alt=" "/>
    198. 

  198. 											<span class="method-result">mixed</span>
    199. 

  199. 										<a href="#get_course_id" title="details" class="method-name">get_course_id</a>
    200. 

  200. 										()
    201. 

  201. 									</div>
    202. 

  202. 															
    203. 

  203. 				<div class="method-definition">
    204. 

  204. 					<img src="../media/images/Method.png" alt=" "/>
    205. 

  205. 											<span class="method-result">int</span>
    206. 

  206. 										<a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
    207. 

  207. 										()
    208. 

  208. 									</div>
    209. 

  209. 															
    210. 

  210. 				<div class="method-definition">
    211. 

  211. 					<img src="../media/images/Method.png" alt=" "/>
    212. 

  212. 											<span class="method-result">string</span>
    213. 

  213. 										<a href="#get_intro" title="details" class="method-name">get_intro</a>
    214. 

  214. 										()
    215. 

  215. 									</div>
    216. 

  216. 															
    217. 

  217. 				<div class="method-definition">
    218. 

  218. 					<img src="../media/images/Method.png" alt=" "/>
    219. 

  219. 											<span class="method-result">int</span>
    220. 

  220. 										<a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
    221. 

  221. 										()
    222. 

  222. 									</div>
    223. 

  223. 															
    224. 

  224. 				<div class="method-definition">
    225. 

  225. 					<img src="../media/images/Method.png" alt=" "/>
    226. 

  226. 											<span class="method-result">string</span>
    227. 

  227. 										<a href="#get_name" title="details" class="method-name">get_name</a>
    228. 

  228. 										()
    229. 

  229. 									</div>
    230. 

  230. 															
    231. 

  231. 				<div class="method-definition">
    232. 

  232. 					<img src="../media/images/Method.png" alt=" "/>
    233. 

  233. 											<span class="method-result">int</span>
    234. 

  234. 										<a href="#get_num_unanswered" title="details" class="method-name">get_num_unanswered</a>
    235. 

  235. 										()
    236. 

  236. 									</div>
    237. 

  237. 															
    238. 

  238. 				<div class="method-definition">
    239. 

  239. 					<img src="../media/images/Method.png" alt=" "/>
    240. 

  240. 											<span class="method-result">int</span>
    241. 

  241. 										<a href="#get_opening_time" title="details" class="method-name">get_opening_time</a>
    242. 

  242. 										()
    243. 

  243. 									</div>
    244. 

  244. 															
    245. 

  245. 				<div class="method-definition">
    246. 

  246. 					<img src="../media/images/Method.png" alt=" "/>
    247. 

  247. 											<span class="method-result">string</span>
    248. 

  248. 										<a href="#get_type" title="details" class="method-name">get_type</a>
    249. 

  249. 										()
    250. 

  250. 									</div>
    251. 

  251. 															
    252. 

  252. 				<div class="method-definition">
    253. 

  253. 					<img src="../media/images/Method.png" alt=" "/>
    254. 

  254. 											<span class="method-result">string</span>
    255. 

  255. 										<a href="#get_type_full" title="details" class="method-name">get_type_full</a>
    256. 

  256. 										()
    257. 

  257. 									</div>
    258. 

  258. 															
    259. 

  259. 				<div class="method-definition">
    260. 

  260. 					<img src="../media/images/Method.png" alt=" "/>
    261. 

  261. 											<span class="method-result">bool</span>
    262. 

  262. 										<a href="#is_early" title="details" class="method-name">is_early</a>
    263. 

  263. 											([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
    264. 

  264. 									</div>
    265. 

  265. 															
    266. 

  266. 				<div class="method-definition">
    267. 

  267. 					<img src="../media/images/Method.png" alt=" "/>
    268. 

  268. 											<span class="method-result">bool</span>
    269. 

  269. 										<a href="#is_late" title="details" class="method-name">is_late</a>
    270. 

  270. 											([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
    271. 

  271. 									</div>
    272. 

  272. 															
    273. 

  273. 				<div class="method-definition">
    274. 

  274. 					<img src="../media/images/Method.png" alt=" "/>
    275. 

  275. 											<span class="method-result">bool</span>
    276. 

  276. 										<a href="#is_open" title="details" class="method-name">is_open</a>
    277. 

  277. 											([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
    278. 

  278. 									</div>
    279. 

  279. 															
    280. 

  280. 				<div class="method-definition">
    281. 

  281. 					<img src="../media/images/Method.png" alt=" "/>
    282. 

  282. 											<span class="method-result">bool</span>
    283. 

  283. 										<a href="#load" title="details" class="method-name">load</a>
    284. 

  284. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
    285. 

  285. 									</div>
    286. 

  286. 															
    287. 

  287. 				<div class="method-definition">
    288. 

  288. 					<img src="../media/images/Method.png" alt=" "/>
    289. 

  289. 											<span class="method-result">integer|false</span>
    290. 

  290. 										<a href="#select_option" title="details" class="method-name">select_option</a>
    291. 

  291. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$optionid</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$user</span> = <span class="var-default">null</span>])
    292. 

  292. 									</div>
    293. 

  293. 											</div>
    294. 

  294. 		</div>
    295. 

  295. 	</div>		
    296. 

  296. 

  297. 	<a name="sec-vars"></a>
    298. 

  298. 	<div class="info-box">
    299. 

  299. 		<div class="info-box-title">Variables</div>
    300. 

  300. 		<div class="nav-bar">
    301. 

  301. 			<a href="#sec-description">Description</a> |
    302. 

  302. 										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
    303. 

  303. 						
    304. 

  304. 			
    305. 

  305. 										| 
    306. 

  306. 									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    307. 

  307. 							
    308. 

  308. 					</div>
    309. 

  309. 		<div class="info-box-body">
    310. 

  310. 			
    311. 

  311. <a name="var$cm" id="$cm"><!-- --></A>
    312. 

  312. <div class="oddrow">
    313. 

  313. 

  314. 	<div class="var-header">
    315. 

  315. 		<img src="../media/images/PrivateVariable.png" />
    316. 

  316. 		<span class="var-title">
    317. 

  317. 			<span class="var-type">object</span>
    318. 

  318. 			<span class="var-name">$cm</span>
    319. 

  319. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a36">36</a></span>)
    320. 

  320. 		</span>
    321. 

  321. 	</div>
    322. 

  322. 

  323. 	<!-- ========== Info from phpDoc block ========= -->
    324. 

  324. <p class="short-description">Internal for Moodle only - course module instance.</p>
    325. 

  325. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
    326. 

  326. 	<ul class="tags">
    327. 

  327. 				<li><span class="field">access:</span> private</li>
    328. 

  328. 			</ul>
    329. 

  329. 	
    330. 

  330. 	
    331. 

  331. 		
    332. 

  332. 		
    333. 

  333. 

  334. </div>
    335. 

  335. <a name="var$moodle_choice_instance" id="$moodle_choice_instance"><!-- --></A>
    336. 

  336. <div class="evenrow">
    337. 

  337. 

  338. 	<div class="var-header">
    339. 

  339. 		<img src="../media/images/PrivateVariable.png" />
    340. 

  340. 		<span class="var-title">
    341. 

  341. 			<span class="var-type">object</span>
    342. 

  342. 			<span class="var-name">$moodle_choice_instance</span>
    343. 

  343. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a44">44</a></span>)
    344. 

  344. 		</span>
    345. 

  345. 	</div>
    346. 

  346. 

  347. 	<!-- ========== Info from phpDoc block ========= -->
    348. 

  348. <p class="short-description">Internal only - Moodle choice module instance database object.</p>
    349. 

  349. <p class="description"><p>Corresponds to one record from the Moodle 'choice' table.</p></p>
    350. 

  350. 	<ul class="tags">
    351. 

  351. 				<li><span class="field">access:</span> private</li>
    352. 

  352. 			</ul>
    353. 

  353. 	
    354. 

  354. 	
    355. 

  355. 		
    356. 

  356. 		
    357. 

  357. 

  358. </div>
    359. 

  359. <a name="var$numunanswered" id="$numunanswered"><!-- --></A>
    360. 

  360. <div class="oddrow">
    361. 

  361. 

  362. 	<div class="var-header">
    363. 

  363. 		<img src="../media/images/PrivateVariable.png" />
    364. 

  364. 		<span class="var-title">
    365. 

  365. 			<span class="var-type">int</span>
    366. 

  366. 			<span class="var-name">$numunanswered</span>
    367. 

  367. 			 = <span class="var-default"> 0</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a51">51</a></span>)
    368. 

  368. 		</span>
    369. 

  369. 	</div>
    370. 

  370. 

  371. 	<!-- ========== Info from phpDoc block ========= -->
    372. 

  372. <p class="short-description">The number of (non-admin) users on the course who have not yet answered this choice.</p>
    373. 

  373. 	<ul class="tags">
    374. 

  374. 				<li><span class="field">access:</span> private</li>
    375. 

  375. 			</ul>
    376. 

  376. 	
    377. 

  377. 	
    378. 

  378. 		
    379. 

  379. 		
    380. 

  380. 

  381. </div>
    382. 

  382. <a name="var$options" id="$options"><!-- --></A>
    383. 

  383. <div class="evenrow">
    384. 

  384. 

  385. 	<div class="var-header">
    386. 

  386. 		<img src="../media/images/Variable.png" />
    387. 

  387. 		<span class="var-title">
    388. 

  388. 			<span class="var-type">array</span>
    389. 

  389. 			<span class="var-name">$options</span>
    390. 

  390. 			 = <span class="var-default">array()</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a58">58</a></span>)
    391. 

  391. 		</span>
    392. 

  392. 	</div>
    393. 

  393. 

  394. 	<!-- ========== Info from phpDoc block ========= -->
    395. 

  395. <p class="short-description">The options available for this choice, as an associative array of IDs to <a href="../sloodle/SloodleChoiceOption.html">SloodleChoiceOption</a> objects.</p>
    396. 

  396. 	<ul class="tags">
    397. 

  397. 				<li><span class="field">access:</span> public</li>
    398. 

  398. 			</ul>
    399. 

  399. 	
    400. 

  400. 	
    401. 

  401. 		
    402. 

  402. 		
    403. 

  403. 

  404. </div>
    405. 

  405. 
							<h4>Inherited Variables</h4>
    406. 

  406. 				<A NAME='inherited_vars'><!-- --></A>
    407. 

  407. 									<p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
    408. 

  408. 					<blockquote>
    409. 

  409. 													<img src="../media/images/Variable.png" />
    410. 

  410. 							<span class="var-title">
    411. 

  411. 								<span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
    412. 

  412. 							</span>
    413. 

  413. 											</blockquote> 
    414. 

  414. 										
    415. 

  415. 		</div>
    416. 

  416. 	</div>
    417. 

  417. 	
    418. 

  418. 	<a name="sec-methods"></a>
    419. 

  419. 	<div class="info-box">
    420. 

  420. 		<div class="info-box-title">Methods</div>
    421. 

  421. 		<div class="nav-bar">
    422. 

  422. 			<a href="#sec-description">Description</a> |
    423. 

  423. 															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    424. 

  424. 																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    425. 

  425. 						
    426. 

  426. 		</div>
    427. 

  427. 		<div class="info-box-body">
    428. 

  428. 			<A NAME='method_detail'></A>
    429. 

  429. <a name="methodSloodleModuleChoice" id="SloodleModuleChoice"><!-- --></a>
    430. 

  430. <div class="oddrow">
    431. 

  431. 	
    432. 

  432. 	<div class="method-header">
    433. 

  433. 		<img src="../media/images/Constructor.png" />
    434. 

  434. 		<span class="method-title">Constructor SloodleModuleChoice</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a66">66</a></span>)
    435. 

  435. 	</div> 
    436. 

  436. 	
    437. 

  437. 	<!-- ========== Info from phpDoc block ========= -->
    438. 

  438. <p class="short-description">Constructor</p>
    439. 

  439. 	
    440. 

  440. 	<div class="method-signature">
    441. 

  441. 		<span class="method-result">SloodleModuleChoice</span>
    442. 

  442. 		<span class="method-name">
    443. 

  443. 			SloodleModuleChoice
    444. 

  444. 		</span>
    445. 

  445. 					(<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
    446. 

  446. 			</div>
    447. 

  447. 	
    448. 

  448. 			<ul class="parameters">
    449. 

  449. 					<li>
    450. 

  450. 				<span class="var-type"></span>
    451. 

  451. 				<span class="var-name">&$_session</span>			</li>
    452. 

  452. 				</ul>
    453. 

  453. 		
    454. 

  454. 			
    455. 

  455. 	</div>
    456. 

  456. <a name="methodallow_update" id="allow_update"><!-- --></a>
    457. 

  457. <div class="evenrow">
    458. 

  458. 	
    459. 

  459. 	<div class="method-header">
    460. 

  460. 		<img src="../media/images/Method.png" />
    461. 

  461. 		<span class="method-title">allow_update</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a342">342</a></span>)
    462. 

  462. 	</div> 
    463. 

  463. 	
    464. 

  464. 	<!-- ========== Info from phpDoc block ========= -->
    465. 

  465. <p class="short-description">Checks if users are allowed to re-select their answer in this choice.</p>
    466. 

  466. 	
    467. 

  467. 	<div class="method-signature">
    468. 

  468. 		<span class="method-result">bool</span>
    469. 

  469. 		<span class="method-name">
    470. 

  470. 			allow_update
    471. 

  471. 		</span>
    472. 

  472. 				()
    473. 

  473. 			</div>
    474. 

  474. 	
    475. 

  475. 		
    476. 

  476. 			
    477. 

  477. 	</div>
    478. 

  478. <a name="methodcan_show_results" id="can_show_results"><!-- --></a>
    479. 

  479. <div class="oddrow">
    480. 

  480. 	
    481. 

  481. 	<div class="method-header">
    482. 

  482. 		<img src="../media/images/Method.png" />
    483. 

  483. 		<span class="method-title">can_show_results</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a352">352</a></span>)
    484. 

  484. 	</div> 
    485. 

  485. 	
    486. 

  486. 	<!-- ========== Info from phpDoc block ========= -->
    487. 

  487. <p class="short-description">Checks if results are to be shown.</p>
    488. 

  488. <p class="description"><p>(Some choices only allow results after the choice is closed).</p></p>
    489. 

  489. 	
    490. 

  490. 	<div class="method-signature">
    491. 

  491. 		<span class="method-result">bool</span>
    492. 

  492. 		<span class="method-name">
    493. 

  493. 			can_show_results
    494. 

  494. 		</span>
    495. 

  495. 				()
    496. 

  496. 			</div>
    497. 

  497. 	
    498. 

  498. 		
    499. 

  499. 			
    500. 

  500. 	</div>
    501. 

  501. <a name="methodget_closing_time" id="get_closing_time"><!-- --></a>
    502. 

  502. <div class="evenrow">
    503. 

  503. 	
    504. 

  504. 	<div class="method-header">
    505. 

  505. 		<img src="../media/images/Method.png" />
    506. 

  506. 		<span class="method-title">get_closing_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a286">286</a></span>)
    507. 

  507. 	</div> 
    508. 

  508. 	
    509. 

  509. 	<!-- ========== Info from phpDoc block ========= -->
    510. 

  510. <p class="short-description">Gets the time at which this choice closes.</p>
    511. 

  511. 	<ul class="tags">
    512. 

  512. 				<li><span class="field">return:</span> Timestamp. 0 if choice has no closing time.</li>
    513. 

  513. 			</ul>
    514. 

  514. 	
    515. 

  515. 	<div class="method-signature">
    516. 

  516. 		<span class="method-result">int</span>
    517. 

  517. 		<span class="method-name">
    518. 

  518. 			get_closing_time
    519. 

  519. 		</span>
    520. 

  520. 				()
    521. 

  521. 			</div>
    522. 

  522. 	
    523. 

  523. 		
    524. 

  524. 			
    525. 

  525. 	</div>
    526. 

  526. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
    527. 

  527. <div class="oddrow">
    528. 

  528. 	
    529. 

  529. 	<div class="method-header">
    530. 

  530. 		<img src="../media/images/Method.png" />
    531. 

  531. 		<span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a230">230</a></span>)
    532. 

  532. 	</div> 
    533. 

  533. 	
    534. 

  534. 	<!-- ========== Info from phpDoc block ========= -->
    535. 

  535. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
    536. 

  536. 	<ul class="tags">
    537. 

  537. 				<li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
    538. 

  538. 			</ul>
    539. 

  539. 	
    540. 

  540. 	<div class="method-signature">
    541. 

  541. 		<span class="method-result">mixed</span>
    542. 

  542. 		<span class="method-name">
    543. 

  543. 			get_course_id
    544. 

  544. 		</span>
    545. 

  545. 				()
    546. 

  546. 			</div>
    547. 

  547. 	
    548. 

  548. 		
    549. 

  549. 			<hr class="separator" />
    550. 

  550. 		<div class="notes">Redefinition of:</div>
    551. 

  551. 		<dl>
    552. 

  552. 			<dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
    553. 

  553. 						<dd>Gets the identifier of the course this controller belongs to.</dd>
    554. 

  554. 					</dl>
    555. 

  555. 			
    556. 

  556. 	</div>
    557. 

  557. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
    558. 

  558. <div class="evenrow">
    559. 

  559. 	
    560. 

  560. 	<div class="method-header">
    561. 

  561. 		<img src="../media/images/Method.png" />
    562. 

  562. 		<span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a239">239</a></span>)
    563. 

  563. 	</div> 
    564. 

  564. 	
    565. 

  565. 	<!-- ========== Info from phpDoc block ========= -->
    566. 

  566. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
    567. 

  567. 	<ul class="tags">
    568. 

  568. 				<li><span class="field">return:</span> Timestamp</li>
    569. 

  569. 			</ul>
    570. 

  570. 	
    571. 

  571. 	<div class="method-signature">
    572. 

  572. 		<span class="method-result">int</span>
    573. 

  573. 		<span class="method-name">
    574. 

  574. 			get_creation_time
    575. 

  575. 		</span>
    576. 

  576. 				()
    577. 

  577. 			</div>
    578. 

  578. 	
    579. 

  579. 		
    580. 

  580. 			<hr class="separator" />
    581. 

  581. 		<div class="notes">Redefinition of:</div>
    582. 

  582. 		<dl>
    583. 

  583. 			<dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
    584. 

  584. 						<dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
    585. 

  585. 					</dl>
    586. 

  586. 			
    587. 

  587. 	</div>
    588. 

  588. <a name="methodget_intro" id="get_intro"><!-- --></a>
    589. 

  589. <div class="oddrow">
    590. 

  590. 	
    591. 

  591. 	<div class="method-header">
    592. 

  592. 		<img src="../media/images/Method.png" />
    593. 

  593. 		<span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a221">221</a></span>)
    594. 

  594. 	</div> 
    595. 

  595. 	
    596. 

  596. 	<!-- ========== Info from phpDoc block ========= -->
    597. 

  597. <p class="short-description">Gets the intro description of this module instance, if available.</p>
    598. 

  598. 	<ul class="tags">
    599. 

  599. 				<li><span class="field">return:</span> The intro description of this controller</li>
    600. 

  600. 			</ul>
    601. 

  601. 	
    602. 

  602. 	<div class="method-signature">
    603. 

  603. 		<span class="method-result">string</span>
    604. 

  604. 		<span class="method-name">
    605. 

  605. 			get_intro
    606. 

  606. 		</span>
    607. 

  607. 				()
    608. 

  608. 			</div>
    609. 

  609. 	
    610. 

  610. 		
    611. 

  611. 			<hr class="separator" />
    612. 

  612. 		<div class="notes">Redefinition of:</div>
    613. 

  613. 		<dl>
    614. 

  614. 			<dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
    615. 

  615. 						<dd>Gets the intro description of this module instance, if available.</dd>
    616. 

  616. 					</dl>
    617. 

  617. 			
    618. 

  618. 	</div>
    619. 

  619. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
    620. 

  620. <div class="evenrow">
    621. 

  621. 	
    622. 

  622. 	<div class="method-header">
    623. 

  623. 		<img src="../media/images/Method.png" />
    624. 

  624. 		<span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a248">248</a></span>)
    625. 

  625. 	</div> 
    626. 

  626. 	
    627. 

  627. 	<!-- ========== Info from phpDoc block ========= -->
    628. 

  628. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
    629. 

  629. 	<ul class="tags">
    630. 

  630. 				<li><span class="field">return:</span> Timestamp</li>
    631. 

  631. 			</ul>
    632. 

  632. 	
    633. 

  633. 	<div class="method-signature">
    634. 

  634. 		<span class="method-result">int</span>
    635. 

  635. 		<span class="method-name">
    636. 

  636. 			get_modification_time
    637. 

  637. 		</span>
    638. 

  638. 				()
    639. 

  639. 			</div>
    640. 

  640. 	
    641. 

  641. 		
    642. 

  642. 			<hr class="separator" />
    643. 

  643. 		<div class="notes">Redefinition of:</div>
    644. 

  644. 		<dl>
    645. 

  645. 			<dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
    646. 

  646. 						<dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
    647. 

  647. 					</dl>
    648. 

  648. 			
    649. 

  649. 	</div>
    650. 

  650. <a name="methodget_name" id="get_name"><!-- --></a>
    651. 

  651. <div class="oddrow">
    652. 

  652. 	
    653. 

  653. 	<div class="method-header">
    654. 

  654. 		<img src="../media/images/Method.png" />
    655. 

  655. 		<span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a212">212</a></span>)
    656. 

  656. 	</div> 
    657. 

  657. 	
    658. 

  658. 	<!-- ========== Info from phpDoc block ========= -->
    659. 

  659. <p class="short-description">Gets the name of this module instance.</p>
    660. 

  660. 	<ul class="tags">
    661. 

  661. 				<li><span class="field">return:</span> The name of this controller</li>
    662. 

  662. 			</ul>
    663. 

  663. 	
    664. 

  664. 	<div class="method-signature">
    665. 

  665. 		<span class="method-result">string</span>
    666. 

  666. 		<span class="method-name">
    667. 

  667. 			get_name
    668. 

  668. 		</span>
    669. 

  669. 				()
    670. 

  670. 			</div>
    671. 

  671. 	
    672. 

  672. 		
    673. 

  673. 			<hr class="separator" />
    674. 

  674. 		<div class="notes">Redefinition of:</div>
    675. 

  675. 		<dl>
    676. 

  676. 			<dt><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></dt>
    677. 

  677. 						<dd>Gets the name of this module instance.</dd>
    678. 

  678. 					</dl>
    679. 

  679. 			
    680. 

  680. 	</div>
    681. 

  681. <a name="methodget_num_unanswered" id="get_num_unanswered"><!-- --></a>
    682. 

  682. <div class="evenrow">
    683. 

  683. 	
    684. 

  684. 	<div class="method-header">
    685. 

  685. 		<img src="../media/images/Method.png" />
    686. 

  686. 		<span class="method-title">get_num_unanswered</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a364">364</a></span>)
    687. 

  687. 	</div> 
    688. 

  688. 	
    689. 

  689. 	<!-- ========== Info from phpDoc block ========= -->
    690. 

  690. <p class="short-description">Gets the number of people who have not yet answered the choice.</p>
    691. 

  691. <p class="description"><p>Counts all users on the course, including students and teachers.</p></p>
    692. 

  692. 	
    693. 

  693. 	<div class="method-signature">
    694. 

  694. 		<span class="method-result">int</span>
    695. 

  695. 		<span class="method-name">
    696. 

  696. 			get_num_unanswered
    697. 

  697. 		</span>
    698. 

  698. 				()
    699. 

  699. 			</div>
    700. 

  700. 	
    701. 

  701. 		
    702. 

  702. 			
    703. 

  703. 	</div>
    704. 

  704. <a name="methodget_opening_time" id="get_opening_time"><!-- --></a>
    705. 

  705. <div class="oddrow">
    706. 

  706. 	
    707. 

  707. 	<div class="method-header">
    708. 

  708. 		<img src="../media/images/Method.png" />
    709. 

  709. 		<span class="method-title">get_opening_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a277">277</a></span>)
    710. 

  710. 	</div> 
    711. 

  711. 	
    712. 

  712. 	<!-- ========== Info from phpDoc block ========= -->
    713. 

  713. <p class="short-description">Gets the time at which this choice opens.</p>
    714. 

  714. 	<ul class="tags">
    715. 

  715. 				<li><span class="field">return:</span> Timestamp. 0 if choice has no opening time.</li>
    716. 

  716. 			</ul>
    717. 

  717. 	
    718. 

  718. 	<div class="method-signature">
    719. 

  719. 		<span class="method-result">int</span>
    720. 

  720. 		<span class="method-name">
    721. 

  721. 			get_opening_time
    722. 

  722. 		</span>
    723. 

  723. 				()
    724. 

  724. 			</div>
    725. 

  725. 	
    726. 

  726. 		
    727. 

  727. 			
    728. 

  728. 	</div>
    729. 

  729. <a name="methodget_type" id="get_type"><!-- --></a>
    730. 

  730. <div class="evenrow">
    731. 

  731. 	
    732. 

  732. 	<div class="method-header">
    733. 

  733. 		<img src="../media/images/Method.png" />
    734. 

  734. 		<span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a258">258</a></span>)
    735. 

  735. 	</div> 
    736. 

  736. 	
    737. 

  737. 	<!-- ========== Info from phpDoc block ========= -->
    738. 

  738. <p class="short-description">Gets the short type name of this instance.</p>
    739. 

  739. 	
    740. 

  740. 	<div class="method-signature">
    741. 

  741. 		<span class="method-result">string</span>
    742. 

  742. 		<span class="method-name">
    743. 

  743. 			get_type
    744. 

  744. 		</span>
    745. 

  745. 				()
    746. 

  746. 			</div>
    747. 

  747. 	
    748. 

  748. 		
    749. 

  749. 			<hr class="separator" />
    750. 

  750. 		<div class="notes">Redefinition of:</div>
    751. 

  751. 		<dl>
    752. 

  752. 			<dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
    753. 

  753. 						<dd>Gets the short type name of this instance.</dd>
    754. 

  754. 					</dl>
    755. 

  755. 			
    756. 

  756. 	</div>
    757. 

  757. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
    758. 

  758. <div class="oddrow">
    759. 

  759. 	
    760. 

  760. 	<div class="method-header">
    761. 

  761. 		<img src="../media/images/Method.png" />
    762. 

  762. 		<span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a268">268</a></span>)
    763. 

  763. 	</div> 
    764. 

  764. 	
    765. 

  765. 	<!-- ========== Info from phpDoc block ========= -->
    766. 

  766. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
    767. 

  767. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
    768. 

  768. 	<ul class="tags">
    769. 

  769. 				<li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
    770. 

  770. 			</ul>
    771. 

  771. 	
    772. 

  772. 	<div class="method-signature">
    773. 

  773. 		<span class="method-result">string</span>
    774. 

  774. 		<span class="method-name">
    775. 

  775. 			get_type_full
    776. 

  776. 		</span>
    777. 

  777. 				()
    778. 

  778. 			</div>
    779. 

  779. 	
    780. 

  780. 		
    781. 

  781. 			<hr class="separator" />
    782. 

  782. 		<div class="notes">Redefinition of:</div>
    783. 

  783. 		<dl>
    784. 

  784. 			<dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
    785. 

  785. 						<dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
    786. 

  786. 					</dl>
    787. 

  787. 			
    788. 

  788. 	</div>
    789. 

  789. <a name="methodis_early" id="is_early"><!-- --></a>
    790. 

  790. <div class="evenrow">
    791. 

  791. 	
    792. 

  792. 	<div class="method-header">
    793. 

  793. 		<img src="../media/images/Method.png" />
    794. 

  794. 		<span class="method-title">is_early</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a313">313</a></span>)
    795. 

  795. 	</div> 
    796. 

  796. 	
    797. 

  797. 	<!-- ========== Info from phpDoc block ========= -->
    798. 

  798. <p class="short-description">Determines if the choice has not opened yet.</p>
    799. 

  799. 	
    800. 

  800. 	<div class="method-signature">
    801. 

  801. 		<span class="method-result">bool</span>
    802. 

  802. 		<span class="method-name">
    803. 

  803. 			is_early
    804. 

  804. 		</span>
    805. 

  805. 					([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
    806. 

  806. 			</div>
    807. 

  807. 	
    808. 

  808. 			<ul class="parameters">
    809. 

  809. 					<li>
    810. 

  810. 				<span class="var-type">int</span>
    811. 

  811. 				<span class="var-name">$timestamp</span><span class="var-description">: The time to test. Uses the current time if none is given.</span>			</li>
    812. 

  812. 				</ul>
    813. 

  813. 		
    814. 

  814. 			
    815. 

  815. 	</div>
    816. 

  816. <a name="methodis_late" id="is_late"><!-- --></a>
    817. 

  817. <div class="oddrow">
    818. 

  818. 	
    819. 

  819. 	<div class="method-header">
    820. 

  820. 		<img src="../media/images/Method.png" />
    821. 

  821. 		<span class="method-title">is_late</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a328">328</a></span>)
    822. 

  822. 	</div> 
    823. 

  823. 	
    824. 

  824. 	<!-- ========== Info from phpDoc block ========= -->
    825. 

  825. <p class="short-description">Determines if the choice has already closed.</p>
    826. 

  826. 	
    827. 

  827. 	<div class="method-signature">
    828. 

  828. 		<span class="method-result">bool</span>
    829. 

  829. 		<span class="method-name">
    830. 

  830. 			is_late
    831. 

  831. 		</span>
    832. 

  832. 					([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
    833. 

  833. 			</div>
    834. 

  834. 	
    835. 

  835. 			<ul class="parameters">
    836. 

  836. 					<li>
    837. 

  837. 				<span class="var-type">int</span>
    838. 

  838. 				<span class="var-name">$timestamp</span><span class="var-description">: The time to test. Uses the current time if none is given.</span>			</li>
    839. 

  839. 				</ul>
    840. 

  840. 		
    841. 

  841. 			
    842. 

  842. 	</div>
    843. 

  843. <a name="methodis_open" id="is_open"><!-- --></a>
    844. 

  844. <div class="evenrow">
    845. 

  845. 	
    846. 

  846. 	<div class="method-header">
    847. 

  847. 		<img src="../media/images/Method.png" />
    848. 

  848. 		<span class="method-title">is_open</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a296">296</a></span>)
    849. 

  849. 	</div> 
    850. 

  850. 	
    851. 

  851. 	<!-- ========== Info from phpDoc block ========= -->
    852. 

  852. <p class="short-description">Determines if the choice is currently open.</p>
    853. 

  853. 	
    854. 

  854. 	<div class="method-signature">
    855. 

  855. 		<span class="method-result">bool</span>
    856. 

  856. 		<span class="method-name">
    857. 

  857. 			is_open
    858. 

  858. 		</span>
    859. 

  859. 					([<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
    860. 

  860. 			</div>
    861. 

  861. 	
    862. 

  862. 			<ul class="parameters">
    863. 

  863. 					<li>
    864. 

  864. 				<span class="var-type">int</span>
    865. 

  865. 				<span class="var-name">$timestamp</span><span class="var-description">: The time to test. Uses the current time if none is given.</span>			</li>
    866. 

  866. 				</ul>
    867. 

  867. 		
    868. 

  868. 			
    869. 

  869. 	</div>
    870. 

  870. <a name="methodload" id="load"><!-- --></a>
    871. 

  871. <div class="oddrow">
    872. 

  872. 	
    873. 

  873. 	<div class="method-header">
    874. 

  874. 		<img src="../media/images/Method.png" />
    875. 

  875. 		<span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a78">78</a></span>)
    876. 

  876. 	</div> 
    877. 

  877. 	
    878. 

  878. 	<!-- ========== Info from phpDoc block ========= -->
    879. 

  879. <p class="short-description">Loads data from the database.</p>
    880. 

  880. <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>
    881. 

  881. 	<ul class="tags">
    882. 

  882. 				<li><span class="field">return:</span> True if successful, or false otherwise</li>
    883. 

  883. 			</ul>
    884. 

  884. 	
    885. 

  885. 	<div class="method-signature">
    886. 

  886. 		<span class="method-result">bool</span>
    887. 

  887. 		<span class="method-name">
    888. 

  888. 			load
    889. 

  889. 		</span>
    890. 

  890. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
    891. 

  891. 			</div>
    892. 

  892. 	
    893. 

  893. 			<ul class="parameters">
    894. 

  894. 					<li>
    895. 

  895. 				<span class="var-type">mixed</span>
    896. 

  896. 				<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>
    897. 

  897. 				</ul>
    898. 

  898. 		
    899. 

  899. 			<hr class="separator" />
    900. 

  900. 		<div class="notes">Redefinition of:</div>
    901. 

  901. 		<dl>
    902. 

  902. 			<dt><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></dt>
    903. 

  903. 						<dd>Loads data from the database.</dd>
    904. 

  904. 					</dl>
    905. 

  905. 			
    906. 

  906. 	</div>
    907. 

  907. <a name="methodselect_option" id="select_option"><!-- --></a>
    908. 

  908. <div class="evenrow">
    909. 

  909. 	
    910. 

  910. 	<div class="method-header">
    911. 

  911. 		<img src="../media/images/Method.png" />
    912. 

  912. 		<span class="method-title">select_option</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a143">143</a></span>)
    913. 

  913. 	</div> 
    914. 

  914. 	
    915. 

  915. 	<!-- ========== Info from phpDoc block ========= -->
    916. 

  916. <p class="short-description">Selects an option in this choice on behalf of the specified user.</p>
    917. 

  917. <p class="description"><p>Logs the user in to the VLE if necessary.  If a general error occurs, FALSE will be returned.  Otherwise, an integer <a href="http://slisweb.sjsu.edu/sl/index.php/Sloodle_status_codes">status code</a> will be returned.  The following status codes are typical responses:   * 10011 = added new choice selection   * 10012 = updated existing choice selection   * 10013 = user previously selected same option   * -10011 = User already made a selection, and re-selection is not allowed   * -10012 = max number of selections for this option already made   * -10013 = choice is not yet open   * -10014 = choice is already closed</p></p>
    918. 

  918. 	
    919. 

  919. 	<div class="method-signature">
    920. 

  920. 		<span class="method-result">integer|false</span>
    921. 

  921. 		<span class="method-name">
    922. 

  922. 			select_option
    923. 

  923. 		</span>
    924. 

  924. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$optionid</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$user</span> = <span class="var-default">null</span>])
    925. 

  925. 			</div>
    926. 

  926. 	
    927. 

  927. 			<ul class="parameters">
    928. 

  928. 					<li>
    929. 

  929. 				<span class="var-type">mixed</span>
    930. 

  930. 				<span class="var-name">$optionid</span><span class="var-description">: The unique site-wide identifier of the option to be selected</span>			</li>
    931. 

  931. 					<li>
    932. 

  932. 				<span class="var-type">mixed</span>
    933. 

  933. 				<span class="var-name">$user</span><span class="var-description">: A SloodleUser identifying the current user; if omitted, the current <a href="../sloodle/SloodleSession.html">SloodleSession</a> will be used.</span>			</li>
    934. 

  934. 				</ul>
    935. 

  935. 		
    936. 

  936. 			
    937. 

  937. 	</div>
    938. 

  938. 							<h4>Inherited Methods</h4>
    939. 

  939. 				<a name='inherited_methods'><!-- --></a>	
    940. 

  940. 									<!-- =========== Summary =========== -->
    941. 

  941. 					<p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
    942. 

  942. 					<blockquote>
    943. 

  943. 													<img src="../media/images/Constructor.png" alt=" "/>
    944. 

  944. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
    945. 

  945. 													<img src="../media/images/Method.png" alt=" "/>
    946. 

  946. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
    947. 

  947. 													<img src="../media/images/Method.png" alt=" "/>
    948. 

  948. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
    949. 

  949. 													<img src="../media/images/Method.png" alt=" "/>
    950. 

  950. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
    951. 

  951. 													<img src="../media/images/Method.png" alt=" "/>
    952. 

  952. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
    953. 

  953. 													<img src="../media/images/Method.png" alt=" "/>
    954. 

  954. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
    955. 

  955. 													<img src="../media/images/Method.png" alt=" "/>
    956. 

  956. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
    957. 

  957. 													<img src="../media/images/Method.png" alt=" "/>
    958. 

  958. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
    959. 

  959. 													<img src="../media/images/Method.png" alt=" "/>
    960. 

  960. 							<span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
    961. 

  961. 											</blockquote>
    962. 

  962. 										
    963. 

  963. 		</div>
    964. 

  964. 	</div>
    965. 

  965. 

  966. 	
    967. 

  967. 	<p class="notes" id="credit">
    968. 

  968. 		Documentation generated on Mon, 07 Jul 2008 12:32:55 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
    969. 

  969. 	</p>
    970. 

  970. 	</div></body>
    971. 

  971. </html>
    972.