_lib---sl_classroomlib.php.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509
  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 page sl_classroomlib.php</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="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/lib/sl_classroomlib.php</h2>
  85. <a name="sec-description"></a>
  86. <div class="info-box">
  87. <div class="info-box-title">Description</div>
  88. <div class="nav-bar">
  89. <span class="disabled">Description</span> |
  90. <a href="#sec-includes">Includes</a>
  91. | <a href="#sec-functions">Functions</a>
  92. </div>
  93. <div class="info-box-body">
  94. <!-- ========== Info from phpDoc block ========= -->
  95. <p class="short-description">Sloodle classroom setup profile library.</p>
  96. <p class="description"><p>Provides back-end functionality for handling and managing Sloodle classroom setup profiles.</p></p>
  97. <ul class="tags">
  98. <li><span class="field">copyright:</span> Copyright (c) 2006-8 Sloodle (various contributors)</li>
  99. <li><span class="field">contributor:</span> Edmund Edgar</li>
  100. <li><span class="field">contributor:</span> Peter R. Bloomfield</li>
  101. <li><span class="field">filesource:</span> <a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html">Source Code for this file</a></li>
  102. <li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl-3.0.html">GNU GPL v3</a></li>
  103. </ul>
  104. </div>
  105. </div>
  106. <a name="sec-includes"></a>
  107. <div class="info-box">
  108. <div class="info-box-title">Includes</div>
  109. <div class="nav-bar">
  110. <a href="#sec-description">Description</a> |
  111. <span class="disabled">Includes</span>
  112. | <a href="#sec-functions">Functions</a>
  113. </div>
  114. <div class="info-box-body">
  115. <a name="_SLOODLE_DIRROOT_/lib/sl_generallib_php"><!-- --></a>
  116. <div class="evenrow">
  117. <div>
  118. <img src="../media/images/Page.png" alt=" " />
  119. <span class="include-title">
  120. <span class="include-type">require_once</span>
  121. (<span class="include-name">SLOODLE_DIRROOT.'/lib/sl_generallib.php'</span>)
  122. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a18">18</a></span>)
  123. </span>
  124. </div>
  125. <!-- ========== Info from phpDoc block ========= -->
  126. </div>
  127. </div>
  128. </div>
  129. <a name="sec-functions"></a>
  130. <div class="info-box">
  131. <div class="info-box-title">Functions</div>
  132. <div class="nav-bar">
  133. <a href="#sec-description">Description</a> |
  134. <a href="#sec-includes">Includes</a>
  135. | <span class="disabled">Functions</span>
  136. </div>
  137. <div class="info-box-body">
  138. <a name="functionsloodle_add_classroom_profile" id="functionsloodle_add_classroom_profile"><!-- --></a>
  139. <div class="oddrow">
  140. <div>
  141. <img src="../media/images/Function.png" />
  142. <span class="method-title">sloodle_add_classroom_profile</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a40">40</a></span>)
  143. </div>
  144. <!-- ========== Info from phpDoc block ========= -->
  145. <div class="method-signature">
  146. <span class="method-result">void</span>
  147. <span class="method-name">
  148. sloodle_add_classroom_profile
  149. </span>
  150. (<span class="var-type"></span>&nbsp;<span class="var-name">$profile</span>)
  151. </div>
  152. <ul class="parameters">
  153. <li>
  154. <span class="var-type"></span>
  155. <span class="var-name">$profile</span> </li>
  156. </ul>
  157. </div>
  158. <a name="functionsloodle_add_classroom_profile_entry" id="functionsloodle_add_classroom_profile_entry"><!-- --></a>
  159. <div class="evenrow">
  160. <div>
  161. <img src="../media/images/Function.png" />
  162. <span class="method-title">sloodle_add_classroom_profile_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a44">44</a></span>)
  163. </div>
  164. <!-- ========== Info from phpDoc block ========= -->
  165. <div class="method-signature">
  166. <span class="method-result">void</span>
  167. <span class="method-name">
  168. sloodle_add_classroom_profile_entry
  169. </span>
  170. (<span class="var-type"></span>&nbsp;<span class="var-name">$profileentry</span>)
  171. </div>
  172. <ul class="parameters">
  173. <li>
  174. <span class="var-type"></span>
  175. <span class="var-name">$profileentry</span> </li>
  176. </ul>
  177. </div>
  178. <a name="functionsloodle_authorize_object" id="functionsloodle_authorize_object"><!-- --></a>
  179. <div class="oddrow">
  180. <div>
  181. <img src="../media/images/Function.png" />
  182. <span class="method-title">sloodle_authorize_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a132">132</a></span>)
  183. </div>
  184. <!-- ========== Info from phpDoc block ========= -->
  185. <div class="method-signature">
  186. <span class="method-result">void</span>
  187. <span class="method-name">
  188. sloodle_authorize_object
  189. </span>
  190. (<span class="var-type"></span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$userid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$channel</span>)
  191. </div>
  192. <ul class="parameters">
  193. <li>
  194. <span class="var-type"></span>
  195. <span class="var-name">$uuid</span> </li>
  196. <li>
  197. <span class="var-type"></span>
  198. <span class="var-name">$name</span> </li>
  199. <li>
  200. <span class="var-type"></span>
  201. <span class="var-name">$userid</span> </li>
  202. <li>
  203. <span class="var-type"></span>
  204. <span class="var-name">$channel</span> </li>
  205. </ul>
  206. </div>
  207. <a name="functionsloodle_classroom_profile_exists_by_name" id="functionsloodle_classroom_profile_exists_by_name"><!-- --></a>
  208. <div class="evenrow">
  209. <div>
  210. <img src="../media/images/Function.png" />
  211. <span class="method-title">sloodle_classroom_profile_exists_by_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a36">36</a></span>)
  212. </div>
  213. <!-- ========== Info from phpDoc block ========= -->
  214. <div class="method-signature">
  215. <span class="method-result">void</span>
  216. <span class="method-name">
  217. sloodle_classroom_profile_exists_by_name
  218. </span>
  219. (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span>)
  220. </div>
  221. <ul class="parameters">
  222. <li>
  223. <span class="var-type"></span>
  224. <span class="var-name">$name</span> </li>
  225. <li>
  226. <span class="var-type"></span>
  227. <span class="var-name">$courseid</span> </li>
  228. </ul>
  229. </div>
  230. <a name="functionsloodle_get_classroom_profile" id="functionsloodle_get_classroom_profile"><!-- --></a>
  231. <div class="oddrow">
  232. <div>
  233. <img src="../media/images/Function.png" />
  234. <span class="method-title">sloodle_get_classroom_profile</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a28">28</a></span>)
  235. </div>
  236. <!-- ========== Info from phpDoc block ========= -->
  237. <div class="method-signature">
  238. <span class="method-result">void</span>
  239. <span class="method-name">
  240. sloodle_get_classroom_profile
  241. </span>
  242. (<span class="var-type"></span>&nbsp;<span class="var-name">$profileid</span>)
  243. </div>
  244. <ul class="parameters">
  245. <li>
  246. <span class="var-type"></span>
  247. <span class="var-name">$profileid</span> </li>
  248. </ul>
  249. </div>
  250. <a name="functionsloodle_get_classroom_profiles" id="functionsloodle_get_classroom_profiles"><!-- --></a>
  251. <div class="evenrow">
  252. <div>
  253. <img src="../media/images/Function.png" />
  254. <span class="method-title">sloodle_get_classroom_profiles</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a20">20</a></span>)
  255. </div>
  256. <!-- ========== Info from phpDoc block ========= -->
  257. <div class="method-signature">
  258. <span class="method-result">void</span>
  259. <span class="method-name">
  260. sloodle_get_classroom_profiles
  261. </span>
  262. ([<span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span> = <span class="var-default">null</span>])
  263. </div>
  264. <ul class="parameters">
  265. <li>
  266. <span class="var-type"></span>
  267. <span class="var-name">$courseid</span> </li>
  268. </ul>
  269. </div>
  270. <a name="functionsloodle_get_classroom_profile_by_name" id="functionsloodle_get_classroom_profile_by_name"><!-- --></a>
  271. <div class="oddrow">
  272. <div>
  273. <img src="../media/images/Function.png" />
  274. <span class="method-title">sloodle_get_classroom_profile_by_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a32">32</a></span>)
  275. </div>
  276. <!-- ========== Info from phpDoc block ========= -->
  277. <div class="method-signature">
  278. <span class="method-result">void</span>
  279. <span class="method-name">
  280. sloodle_get_classroom_profile_by_name
  281. </span>
  282. (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$courseid</span>)
  283. </div>
  284. <ul class="parameters">
  285. <li>
  286. <span class="var-type"></span>
  287. <span class="var-name">$name</span> </li>
  288. <li>
  289. <span class="var-type"></span>
  290. <span class="var-name">$courseid</span> </li>
  291. </ul>
  292. </div>
  293. <a name="functionsloodle_get_classroom_profile_entries" id="functionsloodle_get_classroom_profile_entries"><!-- --></a>
  294. <div class="evenrow">
  295. <div>
  296. <img src="../media/images/Function.png" />
  297. <span class="method-title">sloodle_get_classroom_profile_entries</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a24">24</a></span>)
  298. </div>
  299. <!-- ========== Info from phpDoc block ========= -->
  300. <div class="method-signature">
  301. <span class="method-result">void</span>
  302. <span class="method-name">
  303. sloodle_get_classroom_profile_entries
  304. </span>
  305. (<span class="var-type"></span>&nbsp;<span class="var-name">$profileid</span>)
  306. </div>
  307. <ul class="parameters">
  308. <li>
  309. <span class="var-type"></span>
  310. <span class="var-name">$profileid</span> </li>
  311. </ul>
  312. </div>
  313. <a name="functionsloodle_random_object_pwd" id="functionsloodle_random_object_pwd"><!-- --></a>
  314. <div class="oddrow">
  315. <div>
  316. <img src="../media/images/Function.png" />
  317. <span class="method-title">sloodle_random_object_pwd</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a118">118</a></span>)
  318. </div>
  319. <!-- ========== Info from phpDoc block ========= -->
  320. <div class="method-signature">
  321. <span class="method-result">void</span>
  322. <span class="method-name">
  323. sloodle_random_object_pwd
  324. </span>
  325. ()
  326. </div>
  327. </div>
  328. <a name="functionsloodle_register_object" id="functionsloodle_register_object"><!-- --></a>
  329. <div class="evenrow">
  330. <div>
  331. <img src="../media/images/Function.png" />
  332. <span class="method-title">sloodle_register_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a81">81</a></span>)
  333. </div>
  334. <!-- ========== Info from phpDoc block ========= -->
  335. <div class="method-signature">
  336. <span class="method-result">void</span>
  337. <span class="method-name">
  338. sloodle_register_object
  339. </span>
  340. (<span class="var-type"></span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$userid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$masteruuid</span>)
  341. </div>
  342. <ul class="parameters">
  343. <li>
  344. <span class="var-type"></span>
  345. <span class="var-name">$uuid</span> </li>
  346. <li>
  347. <span class="var-type"></span>
  348. <span class="var-name">$name</span> </li>
  349. <li>
  350. <span class="var-type"></span>
  351. <span class="var-name">$userid</span> </li>
  352. <li>
  353. <span class="var-type"></span>
  354. <span class="var-name">$masteruuid</span> </li>
  355. </ul>
  356. </div>
  357. <a name="functionsloodle_save_classroom_profile" id="functionsloodle_save_classroom_profile"><!-- --></a>
  358. <div class="oddrow">
  359. <div>
  360. <img src="../media/images/Function.png" />
  361. <span class="method-title">sloodle_save_classroom_profile</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a72">72</a></span>)
  362. </div>
  363. <!-- ========== Info from phpDoc block ========= -->
  364. <div class="method-signature">
  365. <span class="method-result">void</span>
  366. <span class="method-name">
  367. sloodle_save_classroom_profile
  368. </span>
  369. (<span class="var-type"></span>&nbsp;<span class="var-name">$profile</span>)
  370. </div>
  371. <ul class="parameters">
  372. <li>
  373. <span class="var-type"></span>
  374. <span class="var-name">$profile</span> </li>
  375. </ul>
  376. </div>
  377. <a name="functionsloodle_save_classroom_profile_entries" id="functionsloodle_save_classroom_profile_entries"><!-- --></a>
  378. <div class="evenrow">
  379. <div>
  380. <img src="../media/images/Function.png" />
  381. <span class="method-title">sloodle_save_classroom_profile_entries</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a60">60</a></span>)
  382. </div>
  383. <!-- ========== Info from phpDoc block ========= -->
  384. <div class="method-signature">
  385. <span class="method-result">void</span>
  386. <span class="method-name">
  387. sloodle_save_classroom_profile_entries
  388. </span>
  389. (<span class="var-type"></span>&nbsp;<span class="var-name">$profileid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$entries</span>)
  390. </div>
  391. <ul class="parameters">
  392. <li>
  393. <span class="var-type"></span>
  394. <span class="var-name">$profileid</span> </li>
  395. <li>
  396. <span class="var-type"></span>
  397. <span class="var-name">$entries</span> </li>
  398. </ul>
  399. </div>
  400. <a name="functionsloodle_validate_object_for_pwd" id="functionsloodle_validate_object_for_pwd"><!-- --></a>
  401. <div class="oddrow">
  402. <div>
  403. <img src="../media/images/Function.png" />
  404. <span class="method-title">sloodle_validate_object_for_pwd</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_classroomlib.php.html#a76">76</a></span>)
  405. </div>
  406. <!-- ========== Info from phpDoc block ========= -->
  407. <div class="method-signature">
  408. <span class="method-result">void</span>
  409. <span class="method-name">
  410. sloodle_validate_object_for_pwd
  411. </span>
  412. (<span class="var-type"></span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pwd</span>)
  413. </div>
  414. <ul class="parameters">
  415. <li>
  416. <span class="var-type"></span>
  417. <span class="var-name">$uuid</span> </li>
  418. <li>
  419. <span class="var-type"></span>
  420. <span class="var-name">$pwd</span> </li>
  421. </ul>
  422. </div>
  423. </div>
  424. </div>
  425. <p class="notes" id="credit">
  426. Documentation generated on Tue, 04 Mar 2008 15:08:38 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  427. </p>
  428. </div></body>
  429. </html>