SloodleChatMessage.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  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 SloodleChatMessage</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"> SloodleChatMessage</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 chat message</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_lib---modules---module_chat.php.html">/lib/modules/module_chat.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a272">272</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">mixed</span>
  119. <a href="#$id" title="details" class="var-name">$id</a>
  120. </div>
  121. <div class="var-title">
  122. <img src="../media/images/Variable.png" alt=" " />
  123. <span class="var-type">string</span>
  124. <a href="#$message" title="details" class="var-name">$message</a>
  125. </div>
  126. <div class="var-title">
  127. <img src="../media/images/Variable.png" alt=" " />
  128. <span class="var-type">int</span>
  129. <a href="#$timestamp" title="details" class="var-name">$timestamp</a>
  130. </div>
  131. <div class="var-title">
  132. <img src="../media/images/Variable.png" alt=" " />
  133. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  134. <a href="#$user" title="details" class="var-name">$user</a>
  135. </div>
  136. </div>
  137. </div>
  138. </div>
  139. <a name="sec-method-summary"></a>
  140. <div class="info-box">
  141. <div class="info-box-title">Method Summary</span></div>
  142. <div class="nav-bar">
  143. <a href="#sec-description">Description</a> |
  144. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  145. |
  146. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  147. </div>
  148. <div class="info-box-body">
  149. <div class="method-summary">
  150. <div class="method-definition">
  151. <img src="../media/images/Constructor.png" alt=" "/>
  152. <span class="method-result">SloodleChatMessage</span>
  153. <a href="#SloodleChatMessage" title="details" class="method-name">SloodleChatMessage</a>
  154. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span>)
  155. </div>
  156. <div class="method-definition">
  157. <img src="../media/images/Method.png" alt=" "/>
  158. <span class="method-result">void</span>
  159. <a href="#set" title="details" class="method-name">set</a>
  160. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span>)
  161. </div>
  162. </div>
  163. </div>
  164. </div>
  165. <a name="sec-vars"></a>
  166. <div class="info-box">
  167. <div class="info-box-title">Variables</div>
  168. <div class="nav-bar">
  169. <a href="#sec-description">Description</a> |
  170. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  171. |
  172. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  173. </div>
  174. <div class="info-box-body">
  175. <a name="var$id" id="$id"><!-- --></A>
  176. <div class="oddrow">
  177. <div class="var-header">
  178. <img src="../media/images/Variable.png" />
  179. <span class="var-title">
  180. <span class="var-type">mixed</span>
  181. <span class="var-name">$id</span>
  182. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a310">310</a></span>)
  183. </span>
  184. </div>
  185. <!-- ========== Info from phpDoc block ========= -->
  186. <p class="short-description">The ID of the message.</p>
  187. <p class="description"><p>The type depends on the VLE, but typically is an integer.</p></p>
  188. <ul class="tags">
  189. <li><span class="field">access:</span> public</li>
  190. </ul>
  191. </div>
  192. <a name="var$message" id="$message"><!-- --></A>
  193. <div class="evenrow">
  194. <div class="var-header">
  195. <img src="../media/images/Variable.png" />
  196. <span class="var-title">
  197. <span class="var-type">string</span>
  198. <span class="var-name">$message</span>
  199. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a317">317</a></span>)
  200. </span>
  201. </div>
  202. <!-- ========== Info from phpDoc block ========= -->
  203. <p class="short-description">The text of the message.</p>
  204. <ul class="tags">
  205. <li><span class="field">access:</span> public</li>
  206. </ul>
  207. </div>
  208. <a name="var$timestamp" id="$timestamp"><!-- --></A>
  209. <div class="oddrow">
  210. <div class="var-header">
  211. <img src="../media/images/Variable.png" />
  212. <span class="var-title">
  213. <span class="var-type">int</span>
  214. <span class="var-name">$timestamp</span>
  215. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a331">331</a></span>)
  216. </span>
  217. </div>
  218. <!-- ========== Info from phpDoc block ========= -->
  219. <p class="short-description">Timestamp of the message.</p>
  220. <ul class="tags">
  221. <li><span class="field">access:</span> public</li>
  222. </ul>
  223. </div>
  224. <a name="var$user" id="$user"><!-- --></A>
  225. <div class="evenrow">
  226. <div class="var-header">
  227. <img src="../media/images/Variable.png" />
  228. <span class="var-title">
  229. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  230. <span class="var-name">$user</span>
  231. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a324">324</a></span>)
  232. </span>
  233. </div>
  234. <!-- ========== Info from phpDoc block ========= -->
  235. <p class="short-description">The user who wrote this message.</p>
  236. <ul class="tags">
  237. <li><span class="field">access:</span> public</li>
  238. </ul>
  239. </div>
  240. </div>
  241. </div>
  242. <a name="sec-methods"></a>
  243. <div class="info-box">
  244. <div class="info-box-title">Methods</div>
  245. <div class="nav-bar">
  246. <a href="#sec-description">Description</a> |
  247. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  248. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  249. </div>
  250. <div class="info-box-body">
  251. <A NAME='method_detail'></A>
  252. <a name="methodSloodleChatMessage" id="SloodleChatMessage"><!-- --></a>
  253. <div class="oddrow">
  254. <div class="method-header">
  255. <img src="../media/images/Constructor.png" />
  256. <span class="method-title">Constructor SloodleChatMessage</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a281">281</a></span>)
  257. </div>
  258. <!-- ========== Info from phpDoc block ========= -->
  259. <p class="short-description">Constructor - initialises members.</p>
  260. <div class="method-signature">
  261. <span class="method-result">SloodleChatMessage</span>
  262. <span class="method-name">
  263. SloodleChatMessage
  264. </span>
  265. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span>)
  266. </div>
  267. <ul class="parameters">
  268. <li>
  269. <span class="var-type">mixed</span>
  270. <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>
  271. <li>
  272. <span class="var-type">string</span>
  273. <span class="var-name">$message</span><span class="var-description">: The chat message</span> </li>
  274. <li>
  275. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  276. <span class="var-name">$user</span><span class="var-description">: The user who wrote the message</span> </li>
  277. <li>
  278. <span class="var-type">int</span>
  279. <span class="var-name">$timestamp</span><span class="var-description">: The timestamp of the message</span> </li>
  280. </ul>
  281. </div>
  282. <a name="methodset" id="set"><!-- --></a>
  283. <div class="evenrow">
  284. <div class="method-header">
  285. <img src="../media/images/Method.png" />
  286. <span class="method-title">set</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_chat.php.html#a296">296</a></span>)
  287. </div>
  288. <!-- ========== Info from phpDoc block ========= -->
  289. <p class="short-description">Accessor - set all members in a single call.</p>
  290. <div class="method-signature">
  291. <span class="method-result">void</span>
  292. <span class="method-name">
  293. set
  294. </span>
  295. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$timestamp</span>)
  296. </div>
  297. <ul class="parameters">
  298. <li>
  299. <span class="var-type">mixed</span>
  300. <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>
  301. <li>
  302. <span class="var-type">string</span>
  303. <span class="var-name">$message</span><span class="var-description">: The chat message</span> </li>
  304. <li>
  305. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  306. <span class="var-name">$user</span><span class="var-description">: The user who wrote the message</span> </li>
  307. <li>
  308. <span class="var-type">int</span>
  309. <span class="var-name">$timestamp</span><span class="var-description">: The timestamp of the message</span> </li>
  310. </ul>
  311. </div>
  312. </div>
  313. </div>
  314. <p class="notes" id="credit">
  315. Documentation generated on Mon, 07 Jul 2008 12:32:53 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  316. </p>
  317. </div></body>
  318. </html>