SloodleBlogPost.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
  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 SloodleBlogPost</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"> SloodleBlogPost</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 single blog post</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_lib---modules---module_blog.php.html">/lib/modules/module_blog.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a259">259</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/Variable.png" alt=" " />
  118. <span class="var-type">string</span>
  119. <a href="#$body" title="details" class="var-name">$body</a>
  120. </div>
  121. <div class="var-title">
  122. <img src="../media/images/Variable.png" alt=" " />
  123. <span class="var-type">mixed</span>
  124. <a href="#$id" title="details" class="var-name">$id</a>
  125. </div>
  126. <div class="var-title">
  127. <img src="../media/images/Variable.png" alt=" " />
  128. <span class="var-type">string</span>
  129. <a href="#$subject" title="details" class="var-name">$subject</a>
  130. </div>
  131. <div class="var-title">
  132. <img src="../media/images/Variable.png" alt=" " />
  133. <span class="var-type">int</span>
  134. <a href="#$timestamp_created" title="details" class="var-name">$timestamp_created</a>
  135. </div>
  136. <div class="var-title">
  137. <img src="../media/images/Variable.png" alt=" " />
  138. <span class="var-type">int</span>
  139. <a href="#$timestamp_modified" title="details" class="var-name">$timestamp_modified</a>
  140. </div>
  141. <div class="var-title">
  142. <img src="../media/images/Variable.png" alt=" " />
  143. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  144. <a href="#$user" title="details" class="var-name">$user</a>
  145. </div>
  146. <div class="var-title">
  147. <img src="../media/images/Variable.png" alt=" " />
  148. <span class="var-type">string</span>
  149. <a href="#$visibility" title="details" class="var-name">$visibility</a>
  150. </div>
  151. </div>
  152. </div>
  153. </div>
  154. <a name="sec-method-summary"></a>
  155. <div class="info-box">
  156. <div class="info-box-title">Method Summary</span></div>
  157. <div class="nav-bar">
  158. <a href="#sec-description">Description</a> |
  159. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  160. |
  161. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  162. </div>
  163. <div class="info-box-body">
  164. <div class="method-summary">
  165. <div class="method-definition">
  166. <img src="../media/images/Method.png" alt=" "/>
  167. <span class="method-result">void</span>
  168. <a href="#load_data" title="details" class="method-name">load_data</a>
  169. (<span class="var-type">object</span>&nbsp;<span class="var-name">$rec</span>)
  170. </div>
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">void</span>
  174. <a href="#set" title="details" class="method-name">set</a>
  175. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$body</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">$visibility</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_created</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_modified</span>)
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">void</span>
  180. <a href="#SloodleChatMessage" title="details" class="method-name">SloodleChatMessage</a>
  181. ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$body</span> = <span class="var-default">''</span>], [<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$visibility</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_created</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_modified</span> = <span class="var-default">0</span>])
  182. </div>
  183. </div>
  184. </div>
  185. </div>
  186. <a name="sec-vars"></a>
  187. <div class="info-box">
  188. <div class="info-box-title">Variables</div>
  189. <div class="nav-bar">
  190. <a href="#sec-description">Description</a> |
  191. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  192. |
  193. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  194. </div>
  195. <div class="info-box-body">
  196. <a name="var$body" id="$body"><!-- --></A>
  197. <div class="oddrow">
  198. <div class="var-header">
  199. <img src="../media/images/Variable.png" />
  200. <span class="var-title">
  201. <span class="var-type">string</span>
  202. <span class="var-name">$body</span>
  203. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a342">342</a></span>)
  204. </span>
  205. </div>
  206. <!-- ========== Info from phpDoc block ========= -->
  207. <p class="short-description">The body of the post.</p>
  208. <ul class="tags">
  209. <li><span class="field">access:</span> public</li>
  210. </ul>
  211. </div>
  212. <a name="var$id" id="$id"><!-- --></A>
  213. <div class="evenrow">
  214. <div class="var-header">
  215. <img src="../media/images/Variable.png" />
  216. <span class="var-title">
  217. <span class="var-type">mixed</span>
  218. <span class="var-name">$id</span>
  219. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a328">328</a></span>)
  220. </span>
  221. </div>
  222. <!-- ========== Info from phpDoc block ========= -->
  223. <p class="short-description">The ID of the message.</p>
  224. <p class="description"><p>The type depends on the VLE, but typically is an integer.</p></p>
  225. <ul class="tags">
  226. <li><span class="field">access:</span> public</li>
  227. </ul>
  228. </div>
  229. <a name="var$subject" id="$subject"><!-- --></A>
  230. <div class="oddrow">
  231. <div class="var-header">
  232. <img src="../media/images/Variable.png" />
  233. <span class="var-title">
  234. <span class="var-type">string</span>
  235. <span class="var-name">$subject</span>
  236. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a335">335</a></span>)
  237. </span>
  238. </div>
  239. <!-- ========== Info from phpDoc block ========= -->
  240. <p class="short-description">The subject of the post.</p>
  241. <ul class="tags">
  242. <li><span class="field">access:</span> public</li>
  243. </ul>
  244. </div>
  245. <a name="var$timestamp_created" id="$timestamp_created"><!-- --></A>
  246. <div class="evenrow">
  247. <div class="var-header">
  248. <img src="../media/images/Variable.png" />
  249. <span class="var-title">
  250. <span class="var-type">int</span>
  251. <span class="var-name">$timestamp_created</span>
  252. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a363">363</a></span>)
  253. </span>
  254. </div>
  255. <!-- ========== Info from phpDoc block ========= -->
  256. <p class="short-description">Timestamp of when this message was created.</p>
  257. <ul class="tags">
  258. <li><span class="field">access:</span> public</li>
  259. </ul>
  260. </div>
  261. <a name="var$timestamp_modified" id="$timestamp_modified"><!-- --></A>
  262. <div class="oddrow">
  263. <div class="var-header">
  264. <img src="../media/images/Variable.png" />
  265. <span class="var-title">
  266. <span class="var-type">int</span>
  267. <span class="var-name">$timestamp_modified</span>
  268. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a370">370</a></span>)
  269. </span>
  270. </div>
  271. <!-- ========== Info from phpDoc block ========= -->
  272. <p class="short-description">Timestamp of when this message was last modified.</p>
  273. <ul class="tags">
  274. <li><span class="field">access:</span> public</li>
  275. </ul>
  276. </div>
  277. <a name="var$user" id="$user"><!-- --></A>
  278. <div class="evenrow">
  279. <div class="var-header">
  280. <img src="../media/images/Variable.png" />
  281. <span class="var-title">
  282. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  283. <span class="var-name">$user</span>
  284. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a349">349</a></span>)
  285. </span>
  286. </div>
  287. <!-- ========== Info from phpDoc block ========= -->
  288. <p class="short-description">The user who wrote this message.</p>
  289. <ul class="tags">
  290. <li><span class="field">access:</span> public</li>
  291. </ul>
  292. </div>
  293. <a name="var$visibility" id="$visibility"><!-- --></A>
  294. <div class="oddrow">
  295. <div class="var-header">
  296. <img src="../media/images/Variable.png" />
  297. <span class="var-title">
  298. <span class="var-type">string</span>
  299. <span class="var-name">$visibility</span>
  300. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a356">356</a></span>)
  301. </span>
  302. </div>
  303. <!-- ========== Info from phpDoc block ========= -->
  304. <p class="short-description">The visibility of this post.</p>
  305. <ul class="tags">
  306. <li><span class="field">access:</span> public</li>
  307. </ul>
  308. </div>
  309. </div>
  310. </div>
  311. <a name="sec-methods"></a>
  312. <div class="info-box">
  313. <div class="info-box-title">Methods</div>
  314. <div class="nav-bar">
  315. <a href="#sec-description">Description</a> |
  316. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  317. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  318. </div>
  319. <div class="info-box-body">
  320. <A NAME='method_detail'></A>
  321. <a name="methodload_data" id="load_data"><!-- --></a>
  322. <div class="evenrow">
  323. <div class="method-header">
  324. <img src="../media/images/Method.png" />
  325. <span class="method-title">load_data</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a309">309</a></span>)
  326. </div>
  327. <!-- ========== Info from phpDoc block ========= -->
  328. <p class="short-description">Loads the data from a post record object.</p>
  329. <div class="method-signature">
  330. <span class="method-result">void</span>
  331. <span class="method-name">
  332. load_data
  333. </span>
  334. (<span class="var-type">object</span>&nbsp;<span class="var-name">$rec</span>)
  335. </div>
  336. <ul class="parameters">
  337. <li>
  338. <span class="var-type">object</span>
  339. <span class="var-name">$rec</span><span class="var-description">: Database record object contain the data required</span> </li>
  340. </ul>
  341. </div>
  342. <a name="methodset" id="set"><!-- --></a>
  343. <div class="oddrow">
  344. <div class="method-header">
  345. <img src="../media/images/Method.png" />
  346. <span class="method-title">set</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a293">293</a></span>)
  347. </div>
  348. <!-- ========== Info from phpDoc block ========= -->
  349. <p class="short-description">Accessor - set all members in a single call.</p>
  350. <div class="method-signature">
  351. <span class="method-result">void</span>
  352. <span class="method-name">
  353. set
  354. </span>
  355. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$body</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">$visibility</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_created</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_modified</span>)
  356. </div>
  357. <ul class="parameters">
  358. <li>
  359. <span class="var-type">mixed</span>
  360. <span class="var-name">$id</span><span class="var-description">: The ID of this message - type depends on VLE, but is typically an integer</span> </li>
  361. <li>
  362. <span class="var-type">string</span>
  363. <span class="var-name">$subject</span><span class="var-description">: The subject line of this post</span> </li>
  364. <li>
  365. <span class="var-type">string</span>
  366. <span class="var-name">$body</span><span class="var-description">: The body text of this post</span> </li>
  367. <li>
  368. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  369. <span class="var-name">$user</span><span class="var-description">: The user who posted this entry</span> </li>
  370. <li>
  371. <span class="var-type">string</span>
  372. <span class="var-name">$visibility</span><span class="var-description">: The visibility identifier of this post</span> </li>
  373. <li>
  374. <span class="var-type">int</span>
  375. <span class="var-name">$timestamp_created</span><span class="var-description">: Time when this post was first made</span> </li>
  376. <li>
  377. <span class="var-type">int</span>
  378. <span class="var-name">$timestamp_modified</span><span class="var-description">: Time when this post was last modified</span> </li>
  379. </ul>
  380. </div>
  381. <a name="methodSloodleChatMessage" id="SloodleChatMessage"><!-- --></a>
  382. <div class="evenrow">
  383. <div class="method-header">
  384. <img src="../media/images/Method.png" />
  385. <span class="method-title">SloodleChatMessage</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a271">271</a></span>)
  386. </div>
  387. <!-- ========== Info from phpDoc block ========= -->
  388. <p class="short-description">Constructor - initialises members.</p>
  389. <div class="method-signature">
  390. <span class="method-result">void</span>
  391. <span class="method-name">
  392. SloodleChatMessage
  393. </span>
  394. ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$body</span> = <span class="var-default">''</span>], [<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$visibility</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_created</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp_modified</span> = <span class="var-default">0</span>])
  395. </div>
  396. <ul class="parameters">
  397. <li>
  398. <span class="var-type">mixed</span>
  399. <span class="var-name">$id</span><span class="var-description">: The ID of this message - type depends on VLE, but is typically an integer</span> </li>
  400. <li>
  401. <span class="var-type">string</span>
  402. <span class="var-name">$subject</span><span class="var-description">: The subject line of this post</span> </li>
  403. <li>
  404. <span class="var-type">string</span>
  405. <span class="var-name">$body</span><span class="var-description">: The body text of this post</span> </li>
  406. <li>
  407. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  408. <span class="var-name">$user</span><span class="var-description">: The user who posted this entry</span> </li>
  409. <li>
  410. <span class="var-type">string</span>
  411. <span class="var-name">$visibility</span><span class="var-description">: The visibility identifier of this post</span> </li>
  412. <li>
  413. <span class="var-type">int</span>
  414. <span class="var-name">$timestamp_created</span><span class="var-description">: Time when this post was first made</span> </li>
  415. <li>
  416. <span class="var-type">int</span>
  417. <span class="var-name">$timestamp_modified</span><span class="var-description">: Time when this post was last modified</span> </li>
  418. </ul>
  419. </div>
  420. </div>
  421. </div>
  422. <p class="notes" id="credit">
  423. Documentation generated on Mon, 07 Jul 2008 12:32:51 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  424. </p>
  425. </div></body>
  426. </html>