SloodleController.html 54 KB

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