SloodleLayout.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645
  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 SloodleLayout</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"> SloodleLayout</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">This file defines structures for managing Sloodle layout profiles.</p>
  99. <ul class="tags">
  100. <li><span class="field">copyright:</span> Copyright (c) 2008 Sloodle (various contributors)</li>
  101. <li><span class="field">contributor:</span> Peter R. Bloomfield</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. <p class="notes">
  105. Located in <a class="field" href="_lib---layout_profile.php.html">/lib/layout_profile.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a14">14</a></span>)
  106. </p>
  107. <pre></pre>
  108. </div>
  109. </div>
  110. <a name="sec-var-summary"></a>
  111. <div class="info-box">
  112. <div class="info-box-title">Variable Summary</span></div>
  113. <div class="nav-bar">
  114. <a href="#sec-description">Description</a> |
  115. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  116. |
  117. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  118. </div>
  119. <div class="info-box-body">
  120. <div class="var-summary">
  121. <div class="var-title">
  122. <img src="../media/images/Variable.png" alt=" " />
  123. <span class="var-type">mixed</span>
  124. <a href="#$courseid" title="details" class="var-name">$courseid</a>
  125. </div>
  126. <div class="var-title">
  127. <img src="../media/images/Variable.png" alt=" " />
  128. <span class="var-type">mixed</span>
  129. <a href="#$entries" title="details" class="var-name">$entries</a>
  130. </div>
  131. <div class="var-title">
  132. <img src="../media/images/Variable.png" alt=" " />
  133. <span class="var-type">mixed</span>
  134. <a href="#$id" title="details" class="var-name">$id</a>
  135. </div>
  136. <div class="var-title">
  137. <img src="../media/images/Variable.png" alt=" " />
  138. <span class="var-type">mixed</span>
  139. <a href="#$name" title="details" class="var-name">$name</a>
  140. </div>
  141. <div class="var-title">
  142. <img src="../media/images/Variable.png" alt=" " />
  143. <span class="var-type">mixed</span>
  144. <a href="#$originalentryids" title="details" class="var-name">$originalentryids</a>
  145. </div>
  146. </div>
  147. </div>
  148. </div>
  149. <a name="sec-method-summary"></a>
  150. <div class="info-box">
  151. <div class="info-box-title">Method Summary</span></div>
  152. <div class="nav-bar">
  153. <a href="#sec-description">Description</a> |
  154. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  155. |
  156. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  157. </div>
  158. <div class="info-box-body">
  159. <div class="method-summary">
  160. <div class="method-definition">
  161. <img src="../media/images/Constructor.png" alt=" "/>
  162. <span class="method-result">SloodleLayout</span>
  163. <a href="#SloodleLayout" title="details" class="method-name">SloodleLayout</a>
  164. ([<span class="var-type"></span>&nbsp;<span class="var-name">$r</span> = <span class="var-default">null</span>])
  165. </div>
  166. <div class="method-definition">
  167. <img src="../media/images/Method.png" alt=" "/>
  168. <span class="method-result">void</span>
  169. <a href="#add_entry" title="details" class="method-name">add_entry</a>
  170. (<span class="var-type"></span>&nbsp;<span class="var-name">$entry</span>)
  171. </div>
  172. <div class="method-definition">
  173. <img src="../media/images/Method.png" alt=" "/>
  174. <span class="method-result">void</span>
  175. <a href="#get_course" title="details" class="method-name">get_course</a>
  176. ()
  177. </div>
  178. <div class="method-definition">
  179. <img src="../media/images/Method.png" alt=" "/>
  180. <span class="method-result">void</span>
  181. <a href="#get_entries" title="details" class="method-name">get_entries</a>
  182. ([<span class="var-type"></span>&nbsp;<span class="var-name">$store</span> = <span class="var-default">true</span>])
  183. </div>
  184. <div class="method-definition">
  185. <img src="../media/images/Method.png" alt=" "/>
  186. <span class="method-result">void</span>
  187. <a href="#get_sloodle_course" title="details" class="method-name">get_sloodle_course</a>
  188. ()
  189. </div>
  190. <div class="method-definition">
  191. <img src="../media/images/Method.png" alt=" "/>
  192. <span class="method-result">void</span>
  193. <a href="#insert" title="details" class="method-name">insert</a>
  194. ()
  195. </div>
  196. <div class="method-definition">
  197. <img src="../media/images/Method.png" alt=" "/>
  198. <span class="method-result">void</span>
  199. <a href="#load" title="details" class="method-name">load</a>
  200. (<span class="var-type"></span>&nbsp;<span class="var-name">$id</span>)
  201. </div>
  202. <div class="method-definition">
  203. <img src="../media/images/Method.png" alt=" "/>
  204. <span class="method-result">void</span>
  205. <a href="#load_from_row" title="details" class="method-name">load_from_row</a>
  206. (<span class="var-type"></span>&nbsp;<span class="var-name">$r</span>)
  207. </div>
  208. <div class="method-definition">
  209. <img src="../media/images/Method.png" alt=" "/>
  210. <span class="method-result">void</span>
  211. <a href="#populate_entries_from_active_objects" title="details" class="method-name">populate_entries_from_active_objects</a>
  212. ()
  213. </div>
  214. <div class="method-definition">
  215. <img src="../media/images/Method.png" alt=" "/>
  216. <span class="method-result">void</span>
  217. <a href="#save_entries" title="details" class="method-name">save_entries</a>
  218. ()
  219. </div>
  220. <div class="method-definition">
  221. <img src="../media/images/Method.png" alt=" "/>
  222. <span class="method-result">void</span>
  223. <a href="#update" title="details" class="method-name">update</a>
  224. ()
  225. </div>
  226. </div>
  227. </div>
  228. </div>
  229. <a name="sec-vars"></a>
  230. <div class="info-box">
  231. <div class="info-box-title">Variables</div>
  232. <div class="nav-bar">
  233. <a href="#sec-description">Description</a> |
  234. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  235. |
  236. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  237. </div>
  238. <div class="info-box-body">
  239. <a name="var$courseid" id="$courseid"><!-- --></A>
  240. <div class="oddrow">
  241. <div class="var-header">
  242. <img src="../media/images/Variable.png" />
  243. <span class="var-title">
  244. <span class="var-type">mixed</span>
  245. <span class="var-name">$courseid</span>
  246. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a18">18</a></span>)
  247. </span>
  248. </div>
  249. <!-- ========== Info from phpDoc block ========= -->
  250. </div>
  251. <a name="var$entries" id="$entries"><!-- --></A>
  252. <div class="evenrow">
  253. <div class="var-header">
  254. <img src="../media/images/Variable.png" />
  255. <span class="var-title">
  256. <span class="var-type">mixed</span>
  257. <span class="var-name">$entries</span>
  258. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a20">20</a></span>)
  259. </span>
  260. </div>
  261. <!-- ========== Info from phpDoc block ========= -->
  262. </div>
  263. <a name="var$id" id="$id"><!-- --></A>
  264. <div class="oddrow">
  265. <div class="var-header">
  266. <img src="../media/images/Variable.png" />
  267. <span class="var-title">
  268. <span class="var-type">mixed</span>
  269. <span class="var-name">$id</span>
  270. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a17">17</a></span>)
  271. </span>
  272. </div>
  273. <!-- ========== Info from phpDoc block ========= -->
  274. </div>
  275. <a name="var$name" id="$name"><!-- --></A>
  276. <div class="evenrow">
  277. <div class="var-header">
  278. <img src="../media/images/Variable.png" />
  279. <span class="var-title">
  280. <span class="var-type">mixed</span>
  281. <span class="var-name">$name</span>
  282. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a16">16</a></span>)
  283. </span>
  284. </div>
  285. <!-- ========== Info from phpDoc block ========= -->
  286. </div>
  287. <a name="var$originalentryids" id="$originalentryids"><!-- --></A>
  288. <div class="oddrow">
  289. <div class="var-header">
  290. <img src="../media/images/Variable.png" />
  291. <span class="var-title">
  292. <span class="var-type">mixed</span>
  293. <span class="var-name">$originalentryids</span>
  294. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a21">21</a></span>)
  295. </span>
  296. </div>
  297. <!-- ========== Info from phpDoc block ========= -->
  298. </div>
  299. </div>
  300. </div>
  301. <a name="sec-methods"></a>
  302. <div class="info-box">
  303. <div class="info-box-title">Methods</div>
  304. <div class="nav-bar">
  305. <a href="#sec-description">Description</a> |
  306. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  307. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  308. </div>
  309. <div class="info-box-body">
  310. <A NAME='method_detail'></A>
  311. <a name="methodSloodleLayout" id="SloodleLayout"><!-- --></a>
  312. <div class="evenrow">
  313. <div class="method-header">
  314. <img src="../media/images/Constructor.png" />
  315. <span class="method-title">Constructor SloodleLayout</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a23">23</a></span>)
  316. </div>
  317. <!-- ========== Info from phpDoc block ========= -->
  318. <div class="method-signature">
  319. <span class="method-result">SloodleLayout</span>
  320. <span class="method-name">
  321. SloodleLayout
  322. </span>
  323. ([<span class="var-type"></span>&nbsp;<span class="var-name">$r</span> = <span class="var-default">null</span>])
  324. </div>
  325. <ul class="parameters">
  326. <li>
  327. <span class="var-type"></span>
  328. <span class="var-name">$r</span> </li>
  329. </ul>
  330. </div>
  331. <a name="methodadd_entry" id="add_entry"><!-- --></a>
  332. <div class="oddrow">
  333. <div class="method-header">
  334. <img src="../media/images/Method.png" />
  335. <span class="method-title">add_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a104">104</a></span>)
  336. </div>
  337. <!-- ========== Info from phpDoc block ========= -->
  338. <div class="method-signature">
  339. <span class="method-result">void</span>
  340. <span class="method-name">
  341. add_entry
  342. </span>
  343. (<span class="var-type"></span>&nbsp;<span class="var-name">$entry</span>)
  344. </div>
  345. <ul class="parameters">
  346. <li>
  347. <span class="var-type"></span>
  348. <span class="var-name">$entry</span> </li>
  349. </ul>
  350. </div>
  351. <a name="methodget_course" id="get_course"><!-- --></a>
  352. <div class="evenrow">
  353. <div class="method-header">
  354. <img src="../media/images/Method.png" />
  355. <span class="method-title">get_course</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a76">76</a></span>)
  356. </div>
  357. <!-- ========== Info from phpDoc block ========= -->
  358. <div class="method-signature">
  359. <span class="method-result">void</span>
  360. <span class="method-name">
  361. get_course
  362. </span>
  363. ()
  364. </div>
  365. </div>
  366. <a name="methodget_entries" id="get_entries"><!-- --></a>
  367. <div class="oddrow">
  368. <div class="method-header">
  369. <img src="../media/images/Method.png" />
  370. <span class="method-title">get_entries</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a85">85</a></span>)
  371. </div>
  372. <!-- ========== Info from phpDoc block ========= -->
  373. <div class="method-signature">
  374. <span class="method-result">void</span>
  375. <span class="method-name">
  376. get_entries
  377. </span>
  378. ([<span class="var-type"></span>&nbsp;<span class="var-name">$store</span> = <span class="var-default">true</span>])
  379. </div>
  380. <ul class="parameters">
  381. <li>
  382. <span class="var-type"></span>
  383. <span class="var-name">$store</span> </li>
  384. </ul>
  385. </div>
  386. <a name="methodget_sloodle_course" id="get_sloodle_course"><!-- --></a>
  387. <div class="evenrow">
  388. <div class="method-header">
  389. <img src="../media/images/Method.png" />
  390. <span class="method-title">get_sloodle_course</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a66">66</a></span>)
  391. </div>
  392. <!-- ========== Info from phpDoc block ========= -->
  393. <div class="method-signature">
  394. <span class="method-result">void</span>
  395. <span class="method-name">
  396. get_sloodle_course
  397. </span>
  398. ()
  399. </div>
  400. </div>
  401. <a name="methodinsert" id="insert"><!-- --></a>
  402. <div class="oddrow">
  403. <div class="method-header">
  404. <img src="../media/images/Method.png" />
  405. <span class="method-title">insert</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a112">112</a></span>)
  406. </div>
  407. <!-- ========== Info from phpDoc block ========= -->
  408. <div class="method-signature">
  409. <span class="method-result">void</span>
  410. <span class="method-name">
  411. insert
  412. </span>
  413. ()
  414. </div>
  415. </div>
  416. <a name="methodload" id="load"><!-- --></a>
  417. <div class="evenrow">
  418. <div class="method-header">
  419. <img src="../media/images/Method.png" />
  420. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a46">46</a></span>)
  421. </div>
  422. <!-- ========== Info from phpDoc block ========= -->
  423. <div class="method-signature">
  424. <span class="method-result">void</span>
  425. <span class="method-name">
  426. load
  427. </span>
  428. (<span class="var-type"></span>&nbsp;<span class="var-name">$id</span>)
  429. </div>
  430. <ul class="parameters">
  431. <li>
  432. <span class="var-type"></span>
  433. <span class="var-name">$id</span> </li>
  434. </ul>
  435. </div>
  436. <a name="methodload_from_row" id="load_from_row"><!-- --></a>
  437. <div class="oddrow">
  438. <div class="method-header">
  439. <img src="../media/images/Method.png" />
  440. <span class="method-title">load_from_row</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a32">32</a></span>)
  441. </div>
  442. <!-- ========== Info from phpDoc block ========= -->
  443. <div class="method-signature">
  444. <span class="method-result">void</span>
  445. <span class="method-name">
  446. load_from_row
  447. </span>
  448. (<span class="var-type"></span>&nbsp;<span class="var-name">$r</span>)
  449. </div>
  450. <ul class="parameters">
  451. <li>
  452. <span class="var-type"></span>
  453. <span class="var-name">$r</span> </li>
  454. </ul>
  455. </div>
  456. <a name="methodpopulate_entries_from_active_objects" id="populate_entries_from_active_objects"><!-- --></a>
  457. <div class="evenrow">
  458. <div class="method-header">
  459. <img src="../media/images/Method.png" />
  460. <span class="method-title">populate_entries_from_active_objects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a54">54</a></span>)
  461. </div>
  462. <!-- ========== Info from phpDoc block ========= -->
  463. <div class="method-signature">
  464. <span class="method-result">void</span>
  465. <span class="method-name">
  466. populate_entries_from_active_objects
  467. </span>
  468. ()
  469. </div>
  470. </div>
  471. <a name="methodsave_entries" id="save_entries"><!-- --></a>
  472. <div class="oddrow">
  473. <div class="method-header">
  474. <img src="../media/images/Method.png" />
  475. <span class="method-title">save_entries</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a129">129</a></span>)
  476. </div>
  477. <!-- ========== Info from phpDoc block ========= -->
  478. <div class="method-signature">
  479. <span class="method-result">void</span>
  480. <span class="method-name">
  481. save_entries
  482. </span>
  483. ()
  484. </div>
  485. </div>
  486. <a name="methodupdate" id="update"><!-- --></a>
  487. <div class="evenrow">
  488. <div class="method-header">
  489. <img src="../media/images/Method.png" />
  490. <span class="method-title">update</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__liblayout_profile.php.html#a120">120</a></span>)
  491. </div>
  492. <!-- ========== Info from phpDoc block ========= -->
  493. <div class="method-signature">
  494. <span class="method-result">void</span>
  495. <span class="method-name">
  496. update
  497. </span>
  498. ()
  499. </div>
  500. </div>
  501. </div>
  502. </div>
  503. <p class="notes" id="credit">
  504. Documentation generated on Fri, 17 Jul 2009 11:01:32 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  505. </p>
  506. </div></body>
  507. </html>