SloodleChoiceOption.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  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 SloodleChoiceOption</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"> SloodleChoiceOption</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. </div>
  95. <div class="info-box-body">
  96. <!-- ========== Info from phpDoc block ========= -->
  97. <p class="short-description">Class to represent a single available option for a choice.</p>
  98. <p class="notes">
  99. 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#a376">376</a></span>)
  100. </p>
  101. <pre></pre>
  102. </div>
  103. </div>
  104. <a name="sec-var-summary"></a>
  105. <div class="info-box">
  106. <div class="info-box-title">Variable Summary</span></div>
  107. <div class="nav-bar">
  108. <a href="#sec-description">Description</a> |
  109. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  110. </div>
  111. <div class="info-box-body">
  112. <div class="var-summary">
  113. <div class="var-title">
  114. <img src="../media/images/Variable.png" alt=" " />
  115. <span class="var-type">mixed</span>
  116. <a href="#$id" title="details" class="var-name">$id</a>
  117. </div>
  118. <div class="var-title">
  119. <img src="../media/images/Variable.png" alt=" " />
  120. <span class="var-type">int</span>
  121. <a href="#$maxselections" title="details" class="var-name">$maxselections</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/Variable.png" alt=" " />
  125. <span class="var-type">int</span>
  126. <a href="#$numselections" title="details" class="var-name">$numselections</a>
  127. </div>
  128. <div class="var-title">
  129. <img src="../media/images/Variable.png" alt=" " />
  130. <span class="var-type">string</span>
  131. <a href="#$text" title="details" class="var-name">$text</a>
  132. </div>
  133. <div class="var-title">
  134. <img src="../media/images/Variable.png" alt=" " />
  135. <span class="var-type">mixed</span>
  136. <a href="#$timemodified" title="details" class="var-name">$timemodified</a>
  137. </div>
  138. </div>
  139. </div>
  140. </div>
  141. <a name="sec-vars"></a>
  142. <div class="info-box">
  143. <div class="info-box-title">Variables</div>
  144. <div class="nav-bar">
  145. <a href="#sec-description">Description</a> |
  146. <span class="disabled">Vars</span>
  147. </div>
  148. <div class="info-box-body">
  149. <a name="var$id" id="$id"><!-- --></A>
  150. <div class="evenrow">
  151. <div class="var-header">
  152. <img src="../media/images/Variable.png" />
  153. <span class="var-title">
  154. <span class="var-type">mixed</span>
  155. <span class="var-name">$id</span>
  156. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a383">383</a></span>)
  157. </span>
  158. </div>
  159. <!-- ========== Info from phpDoc block ========= -->
  160. <p class="short-description">The ID of the option (should be unique across the site).</p>
  161. <ul class="tags">
  162. <li><span class="field">access:</span> public</li>
  163. </ul>
  164. </div>
  165. <a name="var$maxselections" id="$maxselections"><!-- --></A>
  166. <div class="oddrow">
  167. <div class="var-header">
  168. <img src="../media/images/Variable.png" />
  169. <span class="var-title">
  170. <span class="var-type">int</span>
  171. <span class="var-name">$maxselections</span>
  172. = <span class="var-default"> -1</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a405">405</a></span>)
  173. </span>
  174. </div>
  175. <!-- ========== Info from phpDoc block ========= -->
  176. <p class="short-description">Maximum allowed number of selections for this option.</p>
  177. <p class="description"><p>Note: will be -1 if there is no limit.</p></p>
  178. <ul class="tags">
  179. <li><span class="field">access:</span> public</li>
  180. </ul>
  181. </div>
  182. <a name="var$numselections" id="$numselections"><!-- --></A>
  183. <div class="evenrow">
  184. <div class="var-header">
  185. <img src="../media/images/Variable.png" />
  186. <span class="var-title">
  187. <span class="var-type">int</span>
  188. <span class="var-name">$numselections</span>
  189. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a397">397</a></span>)
  190. </span>
  191. </div>
  192. <!-- ========== Info from phpDoc block ========= -->
  193. <p class="short-description">Number of selections so far of this option.</p>
  194. <ul class="tags">
  195. <li><span class="field">access:</span> public</li>
  196. </ul>
  197. </div>
  198. <a name="var$text" id="$text"><!-- --></A>
  199. <div class="oddrow">
  200. <div class="var-header">
  201. <img src="../media/images/Variable.png" />
  202. <span class="var-title">
  203. <span class="var-type">string</span>
  204. <span class="var-name">$text</span>
  205. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a390">390</a></span>)
  206. </span>
  207. </div>
  208. <!-- ========== Info from phpDoc block ========= -->
  209. <p class="short-description">The text of this option.</p>
  210. <ul class="tags">
  211. <li><span class="field">access:</span> public</li>
  212. </ul>
  213. </div>
  214. <a name="var$timemodified" id="$timemodified"><!-- --></A>
  215. <div class="evenrow">
  216. <div class="var-header">
  217. <img src="../media/images/Variable.png" />
  218. <span class="var-title">
  219. <span class="var-type">mixed</span>
  220. <span class="var-name">$timemodified</span>
  221. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_choice.php.html#a412">412</a></span>)
  222. </span>
  223. </div>
  224. <!-- ========== Info from phpDoc block ========= -->
  225. <p class="short-description">Timestamp of when this option was last modified.</p>
  226. <p class="description"><p>$var int</p></p>
  227. <ul class="tags">
  228. <li><span class="field">access:</span> public</li>
  229. </ul>
  230. </div>
  231. </div>
  232. </div>
  233. <p class="notes" id="credit">
  234. 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>
  235. </p>
  236. </div></body>
  237. </html>