SloodleController.html 51 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298
  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 SloodleController</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"> SloodleController</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">Represents a Sloodle Controller, including data such as prim password.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_sloodle---lib---controller.php.html">/sloodle/lib/controller.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a25">25</a></span>)
  101. </p>
  102. <pre></pre>
  103. </div>
  104. </div>
  105. <a name="sec-var-summary"></a>
  106. <div class="info-box">
  107. <div class="info-box-title">Variable Summary</span></div>
  108. <div class="nav-bar">
  109. <a href="#sec-description">Description</a> |
  110. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  111. |
  112. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  113. </div>
  114. <div class="info-box-body">
  115. <div class="var-summary">
  116. <div class="var-title">
  117. <img src="../media/images/PrivateVariable.png" alt=" " />
  118. <span class="var-type">object</span>
  119. <a href="#$cm" title="details" class="var-name">$cm</a>
  120. </div>
  121. <div class="var-title">
  122. <img src="../media/images/PrivateVariable.png" alt=" " />
  123. <span class="var-type">object</span>
  124. <a href="#$sloodle_controller_instance" title="details" class="var-name">$sloodle_controller_instance</a>
  125. </div>
  126. <div class="var-title">
  127. <img src="../media/images/PrivateVariable.png" alt=" " />
  128. <span class="var-type">object</span>
  129. <a href="#$sloodle_module_instance" title="details" class="var-name">$sloodle_module_instance</a>
  130. </div>
  131. </div>
  132. </div>
  133. </div>
  134. <a name="sec-method-summary"></a>
  135. <div class="info-box">
  136. <div class="info-box-title">Method Summary</span></div>
  137. <div class="nav-bar">
  138. <a href="#sec-description">Description</a> |
  139. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  140. |
  141. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  142. </div>
  143. <div class="info-box-body">
  144. <div class="method-summary">
  145. <div class="method-definition">
  146. <img src="../media/images/Constructor.png" alt=" "/>
  147. <span class="method-result">SloodleController</span>
  148. <a href="#SloodleController" title="details" class="method-name">SloodleController</a>
  149. ()
  150. </div>
  151. <div class="method-definition">
  152. <img src="../media/images/Method.png" alt=" "/>
  153. <span class="method-result">bool</span>
  154. <a href="#authorise_object" title="details" class="method-name">authorise_object</a>
  155. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <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">$type</span> = <span class="var-default">null</span>])
  156. </div>
  157. <div class="method-definition">
  158. <img src="../media/images/Method.png" alt=" "/>
  159. <span class="method-result">bool</span>
  160. <a href="#check_authorisation" title="details" class="method-name">check_authorisation</a>
  161. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
  162. </div>
  163. <div class="method-definition">
  164. <img src="../media/images/Method.png" alt=" "/>
  165. <span class="method-result">void</span>
  166. <a href="#disable" title="details" class="method-name">disable</a>
  167. ()
  168. </div>
  169. <div class="method-definition">
  170. <img src="../media/images/Method.png" alt=" "/>
  171. <span class="method-result">void</span>
  172. <a href="#enable" title="details" class="method-name">enable</a>
  173. ()
  174. </div>
  175. <div class="method-definition">
  176. <img src="../media/images/Method.png" alt=" "/>
  177. <span class="method-result">mixed|bool</span>
  178. <a href="#get_authorizing_user" title="details" class="method-name">get_authorizing_user</a>
  179. (<span class="var-type"></span>&nbsp;<span class="var-name">$uuid</span>)
  180. </div>
  181. <div class="method-definition">
  182. <img src="../media/images/Method.png" alt=" "/>
  183. <span class="method-result">mixed</span>
  184. <a href="#get_controller_id" title="details" class="method-name">get_controller_id</a>
  185. ()
  186. </div>
  187. <div class="method-definition">
  188. <img src="../media/images/Method.png" alt=" "/>
  189. <span class="method-result">mixed</span>
  190. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  191. ()
  192. </div>
  193. <div class="method-definition">
  194. <img src="../media/images/Method.png" alt=" "/>
  195. <span class="method-result">int</span>
  196. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  197. ()
  198. </div>
  199. <div class="method-definition">
  200. <img src="../media/images/Method.png" alt=" "/>
  201. <span class="method-result">mixed</span>
  202. <a href="#get_id" title="details" class="method-name">get_id</a>
  203. ()
  204. </div>
  205. <div class="method-definition">
  206. <img src="../media/images/Method.png" alt=" "/>
  207. <span class="method-result">string</span>
  208. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  209. ()
  210. </div>
  211. <div class="method-definition">
  212. <img src="../media/images/Method.png" alt=" "/>
  213. <span class="method-result">int</span>
  214. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  215. ()
  216. </div>
  217. <div class="method-definition">
  218. <img src="../media/images/Method.png" alt=" "/>
  219. <span class="method-result">string</span>
  220. <a href="#get_name" title="details" class="method-name">get_name</a>
  221. ()
  222. </div>
  223. <div class="method-definition">
  224. <img src="../media/images/Method.png" alt=" "/>
  225. <span class="method-result"><a href="../sloodle/SloodleActiveObject.html">SloodleActiveObject</a>|bool</span>
  226. <a href="#get_object" title="details" class="method-name">get_object</a>
  227. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  228. </div>
  229. <div class="method-definition">
  230. <img src="../media/images/Method.png" alt=" "/>
  231. <span class="method-result">array</span>
  232. <a href="#get_object_configuration" title="details" class="method-name">get_object_configuration</a>
  233. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  234. </div>
  235. <div class="method-definition">
  236. <img src="../media/images/Method.png" alt=" "/>
  237. <span class="method-result">string</span>
  238. <a href="#get_password" title="details" class="method-name">get_password</a>
  239. ()
  240. </div>
  241. <div class="method-definition">
  242. <img src="../media/images/Method.png" alt=" "/>
  243. <span class="method-result">bool</span>
  244. <a href="#is_available" title="details" class="method-name">is_available</a>
  245. ()
  246. </div>
  247. <div class="method-definition">
  248. <img src="../media/images/Method.png" alt=" "/>
  249. <span class="method-result">bool</span>
  250. <a href="#is_enabled" title="details" class="method-name">is_enabled</a>
  251. ()
  252. </div>
  253. <div class="method-definition">
  254. <img src="../media/images/Method.png" alt=" "/>
  255. <span class="method-result">bool</span>
  256. <a href="#is_loaded" title="details" class="method-name">is_loaded</a>
  257. ()
  258. </div>
  259. <div class="method-definition">
  260. <img src="../media/images/Method.png" alt=" "/>
  261. <span class="method-result">bool</span>
  262. <a href="#load" title="details" class="method-name">load</a>
  263. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  264. </div>
  265. <div class="method-definition">
  266. <img src="../media/images/Method.png" alt=" "/>
  267. <span class="method-result">bool</span>
  268. <a href="#ping_object" title="details" class="method-name">ping_object</a>
  269. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  270. </div>
  271. <div class="method-definition">
  272. <img src="../media/images/Method.png" alt=" "/>
  273. <span class="method-result">int|bool</span>
  274. <a href="#register_object" title="details" class="method-name">register_object</a>
  275. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <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">$password</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  276. </div>
  277. <div class="method-definition">
  278. <img src="../media/images/Method.png" alt=" "/>
  279. <span class="method-result">int|bool</span>
  280. <a href="#register_unauth_object" title="details" class="method-name">register_unauth_object</a>
  281. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  282. </div>
  283. <div class="method-definition">
  284. <img src="../media/images/Method.png" alt=" "/>
  285. <span class="method-result">void</span>
  286. <a href="#remove_object" title="details" class="method-name">remove_object</a>
  287. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  288. </div>
  289. <div class="method-definition">
  290. <img src="../media/images/Method.png" alt=" "/>
  291. <span class="method-result">void</span>
  292. <a href="#set_intro" title="details" class="method-name">set_intro</a>
  293. (<span class="var-type">string</span>&nbsp;<span class="var-name">$intro</span>)
  294. </div>
  295. <div class="method-definition">
  296. <img src="../media/images/Method.png" alt=" "/>
  297. <span class="method-result">void</span>
  298. <a href="#set_name" title="details" class="method-name">set_name</a>
  299. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
  300. </div>
  301. <div class="method-definition">
  302. <img src="../media/images/Method.png" alt=" "/>
  303. <span class="method-result">bool</span>
  304. <a href="#set_password" title="details" class="method-name">set_password</a>
  305. (<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
  306. </div>
  307. <div class="method-definition">
  308. <img src="../media/images/Method.png" alt=" "/>
  309. <span class="method-result">bool</span>
  310. <a href="#update_object_type" title="details" class="method-name">update_object_type</a>
  311. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
  312. </div>
  313. <div class="method-definition">
  314. <img src="../media/images/Method.png" alt=" "/>
  315. <span class="method-result">bool</span>
  316. <a href="#write" title="details" class="method-name">write</a>
  317. ()
  318. </div>
  319. </div>
  320. </div>
  321. </div>
  322. <a name="sec-vars"></a>
  323. <div class="info-box">
  324. <div class="info-box-title">Variables</div>
  325. <div class="nav-bar">
  326. <a href="#sec-description">Description</a> |
  327. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  328. |
  329. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  330. </div>
  331. <div class="info-box-body">
  332. <a name="var$cm" id="$cm"><!-- --></A>
  333. <div class="oddrow">
  334. <div class="var-header">
  335. <img src="../media/images/PrivateVariable.png" />
  336. <span class="var-title">
  337. <span class="var-type">object</span>
  338. <span class="var-name">$cm</span>
  339. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a35">35</a></span>)
  340. </span>
  341. </div>
  342. <!-- ========== Info from phpDoc block ========= -->
  343. <p class="short-description">Internal for Moodle only - course module instance.</p>
  344. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
  345. <ul class="tags">
  346. <li><span class="field">access:</span> private</li>
  347. </ul>
  348. </div>
  349. <a name="var$sloodle_controller_instance" id="$sloodle_controller_instance"><!-- --></A>
  350. <div class="evenrow">
  351. <div class="var-header">
  352. <img src="../media/images/PrivateVariable.png" />
  353. <span class="var-title">
  354. <span class="var-type">object</span>
  355. <span class="var-name">$sloodle_controller_instance</span>
  356. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a51">51</a></span>)
  357. </span>
  358. </div>
  359. <!-- ========== Info from phpDoc block ========= -->
  360. <p class="short-description">Internal only - Sloodle Controller instance database object.</p>
  361. <p class="description"><p>Corresponds to one record from the Moodle 'sloodle_controller' table.</p></p>
  362. <ul class="tags">
  363. <li><span class="field">access:</span> private</li>
  364. </ul>
  365. </div>
  366. <a name="var$sloodle_module_instance" id="$sloodle_module_instance"><!-- --></A>
  367. <div class="oddrow">
  368. <div class="var-header">
  369. <img src="../media/images/PrivateVariable.png" />
  370. <span class="var-title">
  371. <span class="var-type">object</span>
  372. <span class="var-name">$sloodle_module_instance</span>
  373. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a43">43</a></span>)
  374. </span>
  375. </div>
  376. <!-- ========== Info from phpDoc block ========= -->
  377. <p class="short-description">Internal only - Sloodle module instance database object.</p>
  378. <p class="description"><p>Corresponds to one record from the Moodle 'sloodle' table.</p></p>
  379. <ul class="tags">
  380. <li><span class="field">access:</span> private</li>
  381. </ul>
  382. </div>
  383. </div>
  384. </div>
  385. <a name="sec-methods"></a>
  386. <div class="info-box">
  387. <div class="info-box-title">Methods</div>
  388. <div class="nav-bar">
  389. <a href="#sec-description">Description</a> |
  390. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  391. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  392. </div>
  393. <div class="info-box-body">
  394. <A NAME='method_detail'></A>
  395. <a name="methodSloodleController" id="SloodleController"><!-- --></a>
  396. <div class="evenrow">
  397. <div class="method-header">
  398. <img src="../media/images/Constructor.png" />
  399. <span class="method-title">Constructor SloodleController</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a59">59</a></span>)
  400. </div>
  401. <!-- ========== Info from phpDoc block ========= -->
  402. <p class="short-description">Constructor</p>
  403. <div class="method-signature">
  404. <span class="method-result">SloodleController</span>
  405. <span class="method-name">
  406. SloodleController
  407. </span>
  408. ()
  409. </div>
  410. </div>
  411. <a name="methodauthorise_object" id="authorise_object"><!-- --></a>
  412. <div class="oddrow">
  413. <div class="method-header">
  414. <img src="../media/images/Method.png" />
  415. <span class="method-title">authorise_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a404">404</a></span>)
  416. </div>
  417. <!-- ========== Info from phpDoc block ========= -->
  418. <p class="short-description">Authorises an otherwise unauthorised active object against the given user and the current controller.</p>
  419. <p class="description"><p>(NOTE: the object must previously have been registered using <a href="../sloodle/SloodleController.html#methodregister_object">register_object()</a>). <strong>Must not be called statically.</strong></p></p>
  420. <ul class="tags">
  421. <li><span class="field">return:</span> True if successful, or false if not</li>
  422. </ul>
  423. <div class="method-signature">
  424. <span class="method-result">bool</span>
  425. <span class="method-name">
  426. authorise_object
  427. </span>
  428. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <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">$type</span> = <span class="var-default">null</span>])
  429. </div>
  430. <ul class="parameters">
  431. <li>
  432. <span class="var-type">string</span>
  433. <span class="var-name">$uuid</span><span class="var-description">: The UUID of the object being updated</span> </li>
  434. <li>
  435. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  436. <span class="var-name">$user</span><span class="var-description">: The user to authorise the object against</span> </li>
  437. <li>
  438. <span class="var-type">string</span>
  439. <span class="var-name">$type</span><span class="var-description">: (Optional). Specifies the type to store for this object. Ignored if null.</span> </li>
  440. </ul>
  441. </div>
  442. <a name="methodcheck_authorisation" id="check_authorisation"><!-- --></a>
  443. <div class="evenrow">
  444. <div class="method-header">
  445. <img src="../media/images/Method.png" />
  446. <span class="method-title">check_authorisation</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a424">424</a></span>)
  447. </div>
  448. <!-- ========== Info from phpDoc block ========= -->
  449. <p class="short-description">Checks if the specified object is authorised for this controller with the given password.</p>
  450. <ul class="tags">
  451. <li><span class="field">return:</span> True if object is authorised, or false if not</li>
  452. </ul>
  453. <div class="method-signature">
  454. <span class="method-result">bool</span>
  455. <span class="method-name">
  456. check_authorisation
  457. </span>
  458. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
  459. </div>
  460. <ul class="parameters">
  461. <li>
  462. <span class="var-type">string</span>
  463. <span class="var-name">$uuid</span><span class="var-description">: The UUID of the object to check</span> </li>
  464. <li>
  465. <span class="var-type">string</span>
  466. <span class="var-name">$password</span><span class="var-description">: The password to check</span> </li>
  467. </ul>
  468. </div>
  469. <a name="methoddisable" id="disable"><!-- --></a>
  470. <div class="oddrow">
  471. <div class="method-header">
  472. <img src="../media/images/Method.png" />
  473. <span class="method-title">disable</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a250">250</a></span>)
  474. </div>
  475. <!-- ========== Info from phpDoc block ========= -->
  476. <p class="short-description">Disables this controller</p>
  477. <div class="method-signature">
  478. <span class="method-result">void</span>
  479. <span class="method-name">
  480. disable
  481. </span>
  482. ()
  483. </div>
  484. </div>
  485. <a name="methodenable" id="enable"><!-- --></a>
  486. <div class="evenrow">
  487. <div class="method-header">
  488. <img src="../media/images/Method.png" />
  489. <span class="method-title">enable</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a241">241</a></span>)
  490. </div>
  491. <!-- ========== Info from phpDoc block ========= -->
  492. <p class="short-description">Enables this controller</p>
  493. <div class="method-signature">
  494. <span class="method-result">void</span>
  495. <span class="method-name">
  496. enable
  497. </span>
  498. ()
  499. </div>
  500. </div>
  501. <a name="methodget_authorizing_user" id="get_authorizing_user"><!-- --></a>
  502. <div class="oddrow">
  503. <div class="method-header">
  504. <img src="../media/images/Method.png" />
  505. <span class="method-title">get_authorizing_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a440">440</a></span>)
  506. </div>
  507. <!-- ========== Info from phpDoc block ========= -->
  508. <p class="short-description">Gets the ID of the user who authorised the specified object.</p>
  509. <ul class="tags">
  510. <li><span class="field">return:</span> Returns the user ID if successful, or FALSE if not</li>
  511. </ul>
  512. <div class="method-signature">
  513. <span class="method-result">mixed|bool</span>
  514. <span class="method-name">
  515. get_authorizing_user
  516. </span>
  517. (<span class="var-type"></span>&nbsp;<span class="var-name">$uuid</span>)
  518. </div>
  519. <ul class="parameters">
  520. <li>
  521. <span class="var-type"></span>
  522. <span class="var-name">$uuid</span> </li>
  523. </ul>
  524. </div>
  525. <a name="methodget_controller_id" id="get_controller_id"><!-- --></a>
  526. <div class="evenrow">
  527. <div class="method-header">
  528. <img src="../media/images/Method.png" />
  529. <span class="method-title">get_controller_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a148">148</a></span>)
  530. </div>
  531. <!-- ========== Info from phpDoc block ========= -->
  532. <p class="short-description">Gets the identifier for controller (unique among all Sloodle controlers - may be the same as get_id() in some environments</p>
  533. <ul class="tags">
  534. <li><span class="field">return:</span> Identifier. Type is dependent on VLE. On Moodle, it is an integer relating to the 'id' field of the 'sloodle_controller' table</li>
  535. </ul>
  536. <div class="method-signature">
  537. <span class="method-result">mixed</span>
  538. <span class="method-name">
  539. get_controller_id
  540. </span>
  541. ()
  542. </div>
  543. </div>
  544. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  545. <div class="oddrow">
  546. <div class="method-header">
  547. <img src="../media/images/Method.png" />
  548. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a195">195</a></span>)
  549. </div>
  550. <!-- ========== Info from phpDoc block ========= -->
  551. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  552. <ul class="tags">
  553. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  554. </ul>
  555. <div class="method-signature">
  556. <span class="method-result">mixed</span>
  557. <span class="method-name">
  558. get_course_id
  559. </span>
  560. ()
  561. </div>
  562. </div>
  563. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  564. <div class="evenrow">
  565. <div class="method-header">
  566. <img src="../media/images/Method.png" />
  567. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a204">204</a></span>)
  568. </div>
  569. <!-- ========== Info from phpDoc block ========= -->
  570. <p class="short-description">Gets the time at which this controller was created.</p>
  571. <ul class="tags">
  572. <li><span class="field">return:</span> Timestamp</li>
  573. </ul>
  574. <div class="method-signature">
  575. <span class="method-result">int</span>
  576. <span class="method-name">
  577. get_creation_time
  578. </span>
  579. ()
  580. </div>
  581. </div>
  582. <a name="methodget_id" id="get_id"><!-- --></a>
  583. <div class="oddrow">
  584. <div class="method-header">
  585. <img src="../media/images/Method.png" />
  586. <span class="method-title">get_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a139">139</a></span>)
  587. </div>
  588. <!-- ========== Info from phpDoc block ========= -->
  589. <p class="short-description">Gets the site-wide unique identifier for this module.</p>
  590. <ul class="tags">
  591. <li><span class="field">return:</span> Identifier. Type is dependent on VLE. On Moodle, it is an integer course module identifier.</li>
  592. </ul>
  593. <div class="method-signature">
  594. <span class="method-result">mixed</span>
  595. <span class="method-name">
  596. get_id
  597. </span>
  598. ()
  599. </div>
  600. </div>
  601. <a name="methodget_intro" id="get_intro"><!-- --></a>
  602. <div class="evenrow">
  603. <div class="method-header">
  604. <img src="../media/images/Method.png" />
  605. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a176">176</a></span>)
  606. </div>
  607. <!-- ========== Info from phpDoc block ========= -->
  608. <p class="short-description">Gets the intro description of this controller.</p>
  609. <ul class="tags">
  610. <li><span class="field">return:</span> The intro description of this controller</li>
  611. </ul>
  612. <div class="method-signature">
  613. <span class="method-result">string</span>
  614. <span class="method-name">
  615. get_intro
  616. </span>
  617. ()
  618. </div>
  619. </div>
  620. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  621. <div class="oddrow">
  622. <div class="method-header">
  623. <img src="../media/images/Method.png" />
  624. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a213">213</a></span>)
  625. </div>
  626. <!-- ========== Info from phpDoc block ========= -->
  627. <p class="short-description">Gets the time at which this controller was last modified.</p>
  628. <ul class="tags">
  629. <li><span class="field">return:</span> Timestamp</li>
  630. </ul>
  631. <div class="method-signature">
  632. <span class="method-result">int</span>
  633. <span class="method-name">
  634. get_modification_time
  635. </span>
  636. ()
  637. </div>
  638. </div>
  639. <a name="methodget_name" id="get_name"><!-- --></a>
  640. <div class="evenrow">
  641. <div class="method-header">
  642. <img src="../media/images/Method.png" />
  643. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a157">157</a></span>)
  644. </div>
  645. <!-- ========== Info from phpDoc block ========= -->
  646. <p class="short-description">Gets the name of this controller.</p>
  647. <ul class="tags">
  648. <li><span class="field">return:</span> The name of this controller</li>
  649. </ul>
  650. <div class="method-signature">
  651. <span class="method-result">string</span>
  652. <span class="method-name">
  653. get_name
  654. </span>
  655. ()
  656. </div>
  657. </div>
  658. <a name="methodget_object" id="get_object"><!-- --></a>
  659. <div class="oddrow">
  660. <div class="method-header">
  661. <img src="../media/images/Method.png" />
  662. <span class="method-title">get_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a471">471</a></span>)
  663. </div>
  664. <!-- ========== Info from phpDoc block ========= -->
  665. <p class="short-description">Gets data about an active object.</p>
  666. <ul class="tags">
  667. <li><span class="field">return:</span> Returns false on failure</li>
  668. </ul>
  669. <div class="method-signature">
  670. <span class="method-result"><a href="../sloodle/SloodleActiveObject.html">SloodleActiveObject</a>|bool</span>
  671. <span class="method-name">
  672. get_object
  673. </span>
  674. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  675. </div>
  676. <ul class="parameters">
  677. <li>
  678. <span class="var-type">mixed</span>
  679. <span class="var-name">$id</span><span class="var-description">: If an integer, it is the ID of an active object. If it is a string it is the object's UUID.</span> </li>
  680. </ul>
  681. </div>
  682. <a name="methodget_object_configuration" id="get_object_configuration"><!-- --></a>
  683. <div class="evenrow">
  684. <div class="method-header">
  685. <img src="../media/images/Method.png" />
  686. <span class="method-title">get_object_configuration</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a506">506</a></span>)
  687. </div>
  688. <!-- ========== Info from phpDoc block ========= -->
  689. <p class="short-description">Gets an array of object configuration settings.</p>
  690. <p class="description"><p>(Can be called statically).</p></p>
  691. <ul class="tags">
  692. <li><span class="field">return:</span> Associative array of setting names to values. (Returns an empty array if unsuccessful.)</li>
  693. </ul>
  694. <div class="method-signature">
  695. <span class="method-result">array</span>
  696. <span class="method-name">
  697. get_object_configuration
  698. </span>
  699. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  700. </div>
  701. <ul class="parameters">
  702. <li>
  703. <span class="var-type">mixed</span>
  704. <span class="var-name">$id</span><span class="var-description">: If an integer, it is the ID of an active object. If it is a string it is the object's UUID.</span> </li>
  705. </ul>
  706. </div>
  707. <a name="methodget_password" id="get_password"><!-- --></a>
  708. <div class="oddrow">
  709. <div class="method-header">
  710. <img src="../media/images/Method.png" />
  711. <span class="method-title">get_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a259">259</a></span>)
  712. </div>
  713. <!-- ========== Info from phpDoc block ========= -->
  714. <p class="short-description">Gets the prim password of this controller.</p>
  715. <ul class="tags">
  716. <li><span class="field">return:</span> The current prim password.</li>
  717. </ul>
  718. <div class="method-signature">
  719. <span class="method-result">string</span>
  720. <span class="method-name">
  721. get_password
  722. </span>
  723. ()
  724. </div>
  725. </div>
  726. <a name="methodis_available" id="is_available"><!-- --></a>
  727. <div class="evenrow">
  728. <div class="method-header">
  729. <img src="../media/images/Method.png" />
  730. <span class="method-title">is_available</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a223">223</a></span>)
  731. </div>
  732. <!-- ========== Info from phpDoc block ========= -->
  733. <p class="short-description">Determines whether or not this controller is available (i.e. not hidden).</p>
  734. <p class="description"><p>Note: this is separate from being enabled or disabled.</p></p>
  735. <ul class="tags">
  736. <li><span class="field">return:</span> True if the controller is available.</li>
  737. </ul>
  738. <div class="method-signature">
  739. <span class="method-result">bool</span>
  740. <span class="method-name">
  741. is_available
  742. </span>
  743. ()
  744. </div>
  745. </div>
  746. <a name="methodis_enabled" id="is_enabled"><!-- --></a>
  747. <div class="oddrow">
  748. <div class="method-header">
  749. <img src="../media/images/Method.png" />
  750. <span class="method-title">is_enabled</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a232">232</a></span>)
  751. </div>
  752. <!-- ========== Info from phpDoc block ========= -->
  753. <p class="short-description">Determines if this controller is enabled or not.</p>
  754. <ul class="tags">
  755. <li><span class="field">return:</span> True if the controller is enabled, or false otherwise.</li>
  756. </ul>
  757. <div class="method-signature">
  758. <span class="method-result">bool</span>
  759. <span class="method-name">
  760. is_enabled
  761. </span>
  762. ()
  763. </div>
  764. </div>
  765. <a name="methodis_loaded" id="is_loaded"><!-- --></a>
  766. <div class="evenrow">
  767. <div class="method-header">
  768. <img src="../media/images/Method.png" />
  769. <span class="method-title">is_loaded</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a129">129</a></span>)
  770. </div>
  771. <!-- ========== Info from phpDoc block ========= -->
  772. <p class="short-description">Determines whether or not this controller is loaded.</p>
  773. <div class="method-signature">
  774. <span class="method-result">bool</span>
  775. <span class="method-name">
  776. is_loaded
  777. </span>
  778. ()
  779. </div>
  780. </div>
  781. <a name="methodload" id="load"><!-- --></a>
  782. <div class="oddrow">
  783. <div class="method-header">
  784. <img src="../media/images/Method.png" />
  785. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a70">70</a></span>)
  786. </div>
  787. <!-- ========== Info from phpDoc block ========= -->
  788. <p class="short-description">Loads data from the database.</p>
  789. <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>
  790. <ul class="tags">
  791. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  792. </ul>
  793. <div class="method-signature">
  794. <span class="method-result">bool</span>
  795. <span class="method-name">
  796. load
  797. </span>
  798. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  799. </div>
  800. <ul class="parameters">
  801. <li>
  802. <span class="var-type">mixed</span>
  803. <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>
  804. </ul>
  805. </div>
  806. <a name="methodping_object" id="ping_object"><!-- --></a>
  807. <div class="evenrow">
  808. <div class="method-header">
  809. <img src="../media/images/Method.png" />
  810. <span class="method-title">ping_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a530">530</a></span>)
  811. </div>
  812. <!-- ========== Info from phpDoc block ========= -->
  813. <p class="short-description">Updates the last active timer on an object.</p>
  814. <p class="description"><p>(Cannot be called statically... object must be authorised for this controller).</p></p>
  815. <ul class="tags">
  816. <li><span class="field">return:</span> True if successful, or false if not.</li>
  817. </ul>
  818. <div class="method-signature">
  819. <span class="method-result">bool</span>
  820. <span class="method-name">
  821. ping_object
  822. </span>
  823. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  824. </div>
  825. <ul class="parameters">
  826. <li>
  827. <span class="var-type">mixed</span>
  828. <span class="var-name">$id</span><span class="var-description">: If an integer, it is the ID of an active object. If it is a string it is the object's UUID.</span> </li>
  829. </ul>
  830. </div>
  831. <a name="methodregister_object" id="register_object"><!-- --></a>
  832. <div class="oddrow">
  833. <div class="method-header">
  834. <img src="../media/images/Method.png" />
  835. <span class="method-title">register_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a290">290</a></span>)
  836. </div>
  837. <!-- ========== Info from phpDoc block ========= -->
  838. <p class="short-description">Registers a new active object (or renew an existing authorisation) with this controller.</p>
  839. <ul class="tags">
  840. <li><span class="field">return:</span> The new authorisation ID if successful, or false if not</li>
  841. </ul>
  842. <div class="method-signature">
  843. <span class="method-result">int|bool</span>
  844. <span class="method-name">
  845. register_object
  846. </span>
  847. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <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">$password</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  848. </div>
  849. <ul class="parameters">
  850. <li>
  851. <span class="var-type">string</span>
  852. <span class="var-name">$uuid</span><span class="var-description">: The UUID of the object to be registered</span> </li>
  853. <li>
  854. <span class="var-type">string</span>
  855. <span class="var-name">$name</span><span class="var-description">: Name of the object to be registered</span> </li>
  856. <li>
  857. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  858. <span class="var-name">$user</span><span class="var-description">: The user who is authorising the object</span> </li>
  859. <li>
  860. <span class="var-type">string</span>
  861. <span class="var-name">$password</span><span class="var-description">: The password for the object</span> </li>
  862. <li>
  863. <span class="var-type">string</span>
  864. <span class="var-name">$type</span><span class="var-description">: Type identifier of the object to be registered</span> </li>
  865. <li>
  866. <span class="var-type">int</span>
  867. <span class="var-name">$timestamp</span><span class="var-description">: The timestamp of the object's registration, or null to use the current time.</span> </li>
  868. </ul>
  869. </div>
  870. <a name="methodregister_unauth_object" id="register_unauth_object"><!-- --></a>
  871. <div class="evenrow">
  872. <div class="method-header">
  873. <img src="../media/images/Method.png" />
  874. <span class="method-title">register_unauth_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a341">341</a></span>)
  875. </div>
  876. <!-- ========== Info from phpDoc block ========= -->
  877. <p class="short-description">Registers a new unauthorised object.</p>
  878. <p class="description"><p>(Can be called statically). Creates a new active object entry, not linked to any user or controller.</p></p>
  879. <ul class="tags">
  880. <li><span class="field">return:</span> The integer ID of the active object entry, or false if not</li>
  881. </ul>
  882. <div class="method-signature">
  883. <span class="method-result">int|bool</span>
  884. <span class="method-name">
  885. register_unauth_object
  886. </span>
  887. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span> = <span class="var-default">null</span>])
  888. </div>
  889. <ul class="parameters">
  890. <li>
  891. <span class="var-type">string</span>
  892. <span class="var-name">$uuid</span><span class="var-description">: The UUID of the object to be registered</span> </li>
  893. <li>
  894. <span class="var-type">string</span>
  895. <span class="var-name">$name</span><span class="var-description">: Name of the object to be registered</span> </li>
  896. <li>
  897. <span class="var-type">string</span>
  898. <span class="var-name">$password</span><span class="var-description">: The password for the object</span> </li>
  899. <li>
  900. <span class="var-type">string</span>
  901. <span class="var-name">$type</span><span class="var-description">: Type identifier of the object to be registered</span> </li>
  902. <li>
  903. <span class="var-type">int</span>
  904. <span class="var-name">$timestamp</span><span class="var-description">: The timestamp of the object's registration, or null to use the current time.</span> </li>
  905. </ul>
  906. </div>
  907. <a name="methodremove_object" id="remove_object"><!-- --></a>
  908. <div class="oddrow">
  909. <div class="method-header">
  910. <img src="../media/images/Method.png" />
  911. <span class="method-title">remove_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a454">454</a></span>)
  912. </div>
  913. <!-- ========== Info from phpDoc block ========= -->
  914. <p class="short-description">Removes an active object and all its related items.</p>
  915. <div class="method-signature">
  916. <span class="method-result">void</span>
  917. <span class="method-name">
  918. remove_object
  919. </span>
  920. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  921. </div>
  922. <ul class="parameters">
  923. <li>
  924. <span class="var-type">mixed</span>
  925. <span class="var-name">$id</span><span class="var-description">: If it is an integer, then it is treated as the active object ID. If a string, it is treated as the object UUID.</span> </li>
  926. </ul>
  927. </div>
  928. <a name="methodset_intro" id="set_intro"><!-- --></a>
  929. <div class="evenrow">
  930. <div class="method-header">
  931. <img src="../media/images/Method.png" />
  932. <span class="method-title">set_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a186">186</a></span>)
  933. </div>
  934. <!-- ========== Info from phpDoc block ========= -->
  935. <p class="short-description">Sets the intro description of this controller.</p>
  936. <div class="method-signature">
  937. <span class="method-result">void</span>
  938. <span class="method-name">
  939. set_intro
  940. </span>
  941. (<span class="var-type">string</span>&nbsp;<span class="var-name">$intro</span>)
  942. </div>
  943. <ul class="parameters">
  944. <li>
  945. <span class="var-type">string</span>
  946. <span class="var-name">$intro</span><span class="var-description">: The new intro for this controller - ignored if empty</span> </li>
  947. </ul>
  948. </div>
  949. <a name="methodset_name" id="set_name"><!-- --></a>
  950. <div class="oddrow">
  951. <div class="method-header">
  952. <img src="../media/images/Method.png" />
  953. <span class="method-title">set_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a167">167</a></span>)
  954. </div>
  955. <!-- ========== Info from phpDoc block ========= -->
  956. <p class="short-description">Sets the name of this controller.</p>
  957. <div class="method-signature">
  958. <span class="method-result">void</span>
  959. <span class="method-name">
  960. set_name
  961. </span>
  962. (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
  963. </div>
  964. <ul class="parameters">
  965. <li>
  966. <span class="var-type">string</span>
  967. <span class="var-name">$name</span><span class="var-description">: The new name for this controller - ignored if empty</span> </li>
  968. </ul>
  969. </div>
  970. <a name="methodset_password" id="set_password"><!-- --></a>
  971. <div class="evenrow">
  972. <div class="method-header">
  973. <img src="../media/images/Method.png" />
  974. <span class="method-title">set_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a270">270</a></span>)
  975. </div>
  976. <!-- ========== Info from phpDoc block ========= -->
  977. <p class="short-description">Sets the prim password of this controller.</p>
  978. <p class="description"><p>Also checks for validity before storing.</p></p>
  979. <ul class="tags">
  980. <li><span class="field">return:</span> True if successfully stored, or false if the password is invalid</li>
  981. </ul>
  982. <div class="method-signature">
  983. <span class="method-result">bool</span>
  984. <span class="method-name">
  985. set_password
  986. </span>
  987. (<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
  988. </div>
  989. <ul class="parameters">
  990. <li>
  991. <span class="var-type">string</span>
  992. <span class="var-name">$password</span><span class="var-description">: The new prim password</span> </li>
  993. </ul>
  994. </div>
  995. <a name="methodupdate_object_type" id="update_object_type"><!-- --></a>
  996. <div class="oddrow">
  997. <div class="method-header">
  998. <img src="../media/images/Method.png" />
  999. <span class="method-title">update_object_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a383">383</a></span>)
  1000. </div>
  1001. <!-- ========== Info from phpDoc block ========= -->
  1002. <p class="short-description">Updates the type of a given active object to the specified type.</p>
  1003. <ul class="tags">
  1004. <li><span class="field">return:</span> True if successful, or false if not</li>
  1005. </ul>
  1006. <div class="method-signature">
  1007. <span class="method-result">bool</span>
  1008. <span class="method-name">
  1009. update_object_type
  1010. </span>
  1011. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
  1012. </div>
  1013. <ul class="parameters">
  1014. <li>
  1015. <span class="var-type">string</span>
  1016. <span class="var-name">$uuid</span><span class="var-description">: The UUID of the object being updated</span> </li>
  1017. <li>
  1018. <span class="var-type">string</span>
  1019. <span class="var-name">$type</span><span class="var-description">: Name of the new type identifier</span> </li>
  1020. </ul>
  1021. </div>
  1022. <a name="methodwrite" id="write"><!-- --></a>
  1023. <div class="evenrow">
  1024. <div class="method-header">
  1025. <img src="../media/images/Method.png" />
  1026. <span class="method-title">write</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibcontroller.php.html#a108">108</a></span>)
  1027. </div>
  1028. <!-- ========== Info from phpDoc block ========= -->
  1029. <p class="short-description">Updates the currently loaded entry in the database.</p>
  1030. <p class="description"><p>Note: the data *must* have been previously loaded using load_from_db(). This function cannot be used to create new entries.</p></p>
  1031. <ul class="tags">
  1032. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  1033. </ul>
  1034. <div class="method-signature">
  1035. <span class="method-result">bool</span>
  1036. <span class="method-name">
  1037. write
  1038. </span>
  1039. ()
  1040. </div>
  1041. </div>
  1042. </div>
  1043. </div>
  1044. <p class="notes" id="credit">
  1045. Documentation generated on Mon, 16 Jun 2008 15:56:14 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  1046. </p>
  1047. </div></body>
  1048. </html>