SloodleModuleBlog.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751
  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 SloodleModuleBlog</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"> SloodleModuleBlog</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-vars">Vars</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">The Sloodle blog module class.</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#a33">33</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
  103. |
  104. --SloodleModuleBlog</pre>
  105. </div>
  106. </div>
  107. <a name="sec-method-summary"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Method Summary</span></div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <a href="#sec-vars">Vars</a>
  113. |
  114. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <div class="method-summary">
  118. <div class="method-definition">
  119. <img src="../media/images/Constructor.png" alt=" "/>
  120. <span class="method-result">SloodleModuleBlog</span>
  121. <a href="#SloodleModuleBlog" title="details" class="method-name">SloodleModuleBlog</a>
  122. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  123. </div>
  124. <div class="method-definition">
  125. <img src="../media/images/Method.png" alt=" "/>
  126. <span class="method-result">bool</span>
  127. <a href="#add_entry" title="details" class="method-name">add_entry</a>
  128. (<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">string</span>&nbsp;<span class="var-name">$visibility</span> = <span class="var-default">''</span>])
  129. </div>
  130. <div class="method-definition">
  131. <img src="../media/images/Method.png" alt=" "/>
  132. <span class="method-result">mixed</span>
  133. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  134. ()
  135. </div>
  136. <div class="method-definition">
  137. <img src="../media/images/Method.png" alt=" "/>
  138. <span class="method-result">int</span>
  139. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  140. ()
  141. </div>
  142. <div class="method-definition">
  143. <img src="../media/images/Method.png" alt=" "/>
  144. <span class="method-result">string</span>
  145. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  146. ()
  147. </div>
  148. <div class="method-definition">
  149. <img src="../media/images/Method.png" alt=" "/>
  150. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  151. <a href="#get_latest_public_post" title="details" class="method-name">get_latest_public_post</a>
  152. ()
  153. </div>
  154. <div class="method-definition">
  155. <img src="../media/images/Method.png" alt=" "/>
  156. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  157. <a href="#get_latest_site_post" title="details" class="method-name">get_latest_site_post</a>
  158. ()
  159. </div>
  160. <div class="method-definition">
  161. <img src="../media/images/Method.png" alt=" "/>
  162. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  163. <a href="#get_latest_user_post" title="details" class="method-name">get_latest_user_post</a>
  164. ([<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>])
  165. </div>
  166. <div class="method-definition">
  167. <img src="../media/images/Method.png" alt=" "/>
  168. <span class="method-result">int</span>
  169. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  170. ()
  171. </div>
  172. <div class="method-definition">
  173. <img src="../media/images/Method.png" alt=" "/>
  174. <span class="method-result">string</span>
  175. <a href="#get_name" title="details" class="method-name">get_name</a>
  176. ()
  177. </div>
  178. <div class="method-definition">
  179. <img src="../media/images/Method.png" alt=" "/>
  180. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  181. <a href="#get_post" title="details" class="method-name">get_post</a>
  182. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  183. </div>
  184. <div class="method-definition">
  185. <img src="../media/images/Method.png" alt=" "/>
  186. <span class="method-result">string</span>
  187. <a href="#get_type" title="details" class="method-name">get_type</a>
  188. ()
  189. </div>
  190. <div class="method-definition">
  191. <img src="../media/images/Method.png" alt=" "/>
  192. <span class="method-result">string</span>
  193. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  194. ()
  195. </div>
  196. <div class="method-definition">
  197. <img src="../media/images/Method.png" alt=" "/>
  198. <span class="method-result">bool</span>
  199. <a href="#is_enabled" title="details" class="method-name">is_enabled</a>
  200. ()
  201. </div>
  202. <div class="method-definition">
  203. <img src="../media/images/Method.png" alt=" "/>
  204. <span class="method-result">bool</span>
  205. <a href="#user_can_write" title="details" class="method-name">user_can_write</a>
  206. ()
  207. </div>
  208. </div>
  209. </div>
  210. </div>
  211. <a name="sec-vars"></a>
  212. <div class="info-box">
  213. <div class="info-box-title">Variables</div>
  214. <div class="nav-bar">
  215. <a href="#sec-description">Description</a> |
  216. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  217. |
  218. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  219. </div>
  220. <div class="info-box-body">
  221. <h4>Inherited Variables</h4>
  222. <A NAME='inherited_vars'><!-- --></A>
  223. <p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  224. <blockquote>
  225. <img src="../media/images/Variable.png" />
  226. <span class="var-title">
  227. <span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
  228. </span>
  229. </blockquote>
  230. </div>
  231. </div>
  232. <a name="sec-methods"></a>
  233. <div class="info-box">
  234. <div class="info-box-title">Methods</div>
  235. <div class="nav-bar">
  236. <a href="#sec-description">Description</a> |
  237. <a href="#sec-vars">Vars</a>
  238. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  239. </div>
  240. <div class="info-box-body">
  241. <A NAME='method_detail'></A>
  242. <a name="methodSloodleModuleBlog" id="SloodleModuleBlog"><!-- --></a>
  243. <div class="evenrow">
  244. <div class="method-header">
  245. <img src="../media/images/Constructor.png" />
  246. <span class="method-title">Constructor SloodleModuleBlog</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a45">45</a></span>)
  247. </div>
  248. <!-- ========== Info from phpDoc block ========= -->
  249. <p class="short-description">Constructor</p>
  250. <div class="method-signature">
  251. <span class="method-result">SloodleModuleBlog</span>
  252. <span class="method-name">
  253. SloodleModuleBlog
  254. </span>
  255. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  256. </div>
  257. <ul class="parameters">
  258. <li>
  259. <span class="var-type"></span>
  260. <span class="var-name">&$_session</span> </li>
  261. </ul>
  262. </div>
  263. <a name="methodadd_entry" id="add_entry"><!-- --></a>
  264. <div class="oddrow">
  265. <div class="method-header">
  266. <img src="../media/images/Method.png" />
  267. <span class="method-title">add_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a82">82</a></span>)
  268. </div>
  269. <!-- ========== Info from phpDoc block ========= -->
  270. <p class="short-description">Attempts to write a new blog entry to the database, attributed to the user currently loaded in the <a href="../sloodle/SloodleSession.html">SloodleSession</a>.</p>
  271. <p class="description"><p>All of the text provided in parameters _must_ be database-safe!</p></p>
  272. <ul class="tags">
  273. <li><span class="field">return:</span> True if successful or false otherwise</li>
  274. </ul>
  275. <div class="method-signature">
  276. <span class="method-result">bool</span>
  277. <span class="method-name">
  278. add_entry
  279. </span>
  280. (<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">string</span>&nbsp;<span class="var-name">$visibility</span> = <span class="var-default">''</span>])
  281. </div>
  282. <ul class="parameters">
  283. <li>
  284. <span class="var-type">string</span>
  285. <span class="var-name">$subject</span><span class="var-description">: The subject line of the post</span> </li>
  286. <li>
  287. <span class="var-type">string</span>
  288. <span class="var-name">$body</span><span class="var-description">: The body of the post</span> </li>
  289. <li>
  290. <span class="var-type">string</span>
  291. <span class="var-name">$visibility</span><span class="var-description">: The visibility identifier of the post (defaults to site level)</span> </li>
  292. </ul>
  293. </div>
  294. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  295. <div class="evenrow">
  296. <div class="method-header">
  297. <img src="../media/images/Method.png" />
  298. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a209">209</a></span>)
  299. </div>
  300. <!-- ========== Info from phpDoc block ========= -->
  301. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  302. <ul class="tags">
  303. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  304. </ul>
  305. <div class="method-signature">
  306. <span class="method-result">mixed</span>
  307. <span class="method-name">
  308. get_course_id
  309. </span>
  310. ()
  311. </div>
  312. <hr class="separator" />
  313. <div class="notes">Redefinition of:</div>
  314. <dl>
  315. <dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
  316. <dd>Gets the identifier of the course this controller belongs to.</dd>
  317. </dl>
  318. </div>
  319. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  320. <div class="oddrow">
  321. <div class="method-header">
  322. <img src="../media/images/Method.png" />
  323. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a218">218</a></span>)
  324. </div>
  325. <!-- ========== Info from phpDoc block ========= -->
  326. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  327. <ul class="tags">
  328. <li><span class="field">return:</span> Timestamp</li>
  329. </ul>
  330. <div class="method-signature">
  331. <span class="method-result">int</span>
  332. <span class="method-name">
  333. get_creation_time
  334. </span>
  335. ()
  336. </div>
  337. <hr class="separator" />
  338. <div class="notes">Redefinition of:</div>
  339. <dl>
  340. <dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
  341. <dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
  342. </dl>
  343. </div>
  344. <a name="methodget_intro" id="get_intro"><!-- --></a>
  345. <div class="evenrow">
  346. <div class="method-header">
  347. <img src="../media/images/Method.png" />
  348. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a200">200</a></span>)
  349. </div>
  350. <!-- ========== Info from phpDoc block ========= -->
  351. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  352. <ul class="tags">
  353. <li><span class="field">return:</span> The intro description of this controller</li>
  354. </ul>
  355. <div class="method-signature">
  356. <span class="method-result">string</span>
  357. <span class="method-name">
  358. get_intro
  359. </span>
  360. ()
  361. </div>
  362. <hr class="separator" />
  363. <div class="notes">Redefinition of:</div>
  364. <dl>
  365. <dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
  366. <dd>Gets the intro description of this module instance, if available.</dd>
  367. </dl>
  368. </div>
  369. <a name="methodget_latest_public_post" id="get_latest_public_post"><!-- --></a>
  370. <div class="oddrow">
  371. <div class="method-header">
  372. <img src="../media/images/Method.png" />
  373. <span class="method-title">get_latest_public_post</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a139">139</a></span>)
  374. </div>
  375. <!-- ========== Info from phpDoc block ========= -->
  376. <p class="short-description">Gets the most recent public post.</p>
  377. <ul class="tags">
  378. <li><span class="field">return:</span> Returns a <a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a> object, or FALSE if unsuccessful.</li>
  379. </ul>
  380. <div class="method-signature">
  381. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  382. <span class="method-name">
  383. get_latest_public_post
  384. </span>
  385. ()
  386. </div>
  387. </div>
  388. <a name="methodget_latest_site_post" id="get_latest_site_post"><!-- --></a>
  389. <div class="evenrow">
  390. <div class="method-header">
  391. <img src="../media/images/Method.png" />
  392. <span class="method-title">get_latest_site_post</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a153">153</a></span>)
  393. </div>
  394. <!-- ========== Info from phpDoc block ========= -->
  395. <p class="short-description">Gets the most recent public/site level post.</p>
  396. <ul class="tags">
  397. <li><span class="field">return:</span> Returns a <a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a> object, or FALSE if unsuccessful.</li>
  398. </ul>
  399. <div class="method-signature">
  400. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  401. <span class="method-name">
  402. get_latest_site_post
  403. </span>
  404. ()
  405. </div>
  406. </div>
  407. <a name="methodget_latest_user_post" id="get_latest_user_post"><!-- --></a>
  408. <div class="oddrow">
  409. <div class="method-header">
  410. <img src="../media/images/Method.png" />
  411. <span class="method-title">get_latest_user_post</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a168">168</a></span>)
  412. </div>
  413. <!-- ========== Info from phpDoc block ========= -->
  414. <p class="short-description">Gets the most recent post by a particular user, regardless of visibility.</p>
  415. <ul class="tags">
  416. <li><span class="field">return:</span> Returns a <a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a> object, or FALSE if unsuccessful.</li>
  417. </ul>
  418. <div class="method-signature">
  419. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  420. <span class="method-name">
  421. get_latest_user_post
  422. </span>
  423. ([<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>])
  424. </div>
  425. <ul class="parameters">
  426. <li>
  427. <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
  428. <span class="var-name">$user</span><span class="var-description">: The user to search for. Uses the current <a href="../sloodle/SloodleSession.html">SloodleSession</a> user if unspecified.</span> </li>
  429. </ul>
  430. </div>
  431. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  432. <div class="evenrow">
  433. <div class="method-header">
  434. <img src="../media/images/Method.png" />
  435. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a227">227</a></span>)
  436. </div>
  437. <!-- ========== Info from phpDoc block ========= -->
  438. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  439. <ul class="tags">
  440. <li><span class="field">return:</span> Timestamp</li>
  441. </ul>
  442. <div class="method-signature">
  443. <span class="method-result">int</span>
  444. <span class="method-name">
  445. get_modification_time
  446. </span>
  447. ()
  448. </div>
  449. <hr class="separator" />
  450. <div class="notes">Redefinition of:</div>
  451. <dl>
  452. <dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
  453. <dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
  454. </dl>
  455. </div>
  456. <a name="methodget_name" id="get_name"><!-- --></a>
  457. <div class="oddrow">
  458. <div class="method-header">
  459. <img src="../media/images/Method.png" />
  460. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a191">191</a></span>)
  461. </div>
  462. <!-- ========== Info from phpDoc block ========= -->
  463. <p class="short-description">Gets the name of this module instance.</p>
  464. <ul class="tags">
  465. <li><span class="field">return:</span> The name of this controller</li>
  466. </ul>
  467. <div class="method-signature">
  468. <span class="method-result">string</span>
  469. <span class="method-name">
  470. get_name
  471. </span>
  472. ()
  473. </div>
  474. <hr class="separator" />
  475. <div class="notes">Redefinition of:</div>
  476. <dl>
  477. <dt><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></dt>
  478. <dd>Gets the name of this module instance.</dd>
  479. </dl>
  480. </div>
  481. <a name="methodget_post" id="get_post"><!-- --></a>
  482. <div class="evenrow">
  483. <div class="method-header">
  484. <img src="../media/images/Method.png" />
  485. <span class="method-title">get_post</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a125">125</a></span>)
  486. </div>
  487. <!-- ========== Info from phpDoc block ========= -->
  488. <p class="short-description">Gets the identified post.</p>
  489. <ul class="tags">
  490. <li><span class="field">return:</span> Returns a <a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a> object, or FALSE if unsuccessful.</li>
  491. </ul>
  492. <div class="method-signature">
  493. <span class="method-result"><a href="../sloodle/SloodleBlogPost.html">SloodleBlogPost</a>|bool</span>
  494. <span class="method-name">
  495. get_post
  496. </span>
  497. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  498. </div>
  499. <ul class="parameters">
  500. <li>
  501. <span class="var-type">mixed</span>
  502. <span class="var-name">$id</span><span class="var-description">: The unique site-wide identifier of the post.</span> </li>
  503. </ul>
  504. </div>
  505. <a name="methodget_type" id="get_type"><!-- --></a>
  506. <div class="oddrow">
  507. <div class="method-header">
  508. <img src="../media/images/Method.png" />
  509. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a237">237</a></span>)
  510. </div>
  511. <!-- ========== Info from phpDoc block ========= -->
  512. <p class="short-description">Gets the short type name of this instance.</p>
  513. <div class="method-signature">
  514. <span class="method-result">string</span>
  515. <span class="method-name">
  516. get_type
  517. </span>
  518. ()
  519. </div>
  520. <hr class="separator" />
  521. <div class="notes">Redefinition of:</div>
  522. <dl>
  523. <dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
  524. <dd>Gets the short type name of this instance.</dd>
  525. </dl>
  526. </div>
  527. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  528. <div class="evenrow">
  529. <div class="method-header">
  530. <img src="../media/images/Method.png" />
  531. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a247">247</a></span>)
  532. </div>
  533. <!-- ========== Info from phpDoc block ========= -->
  534. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  535. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  536. <ul class="tags">
  537. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  538. </ul>
  539. <div class="method-signature">
  540. <span class="method-result">string</span>
  541. <span class="method-name">
  542. get_type_full
  543. </span>
  544. ()
  545. </div>
  546. <hr class="separator" />
  547. <div class="notes">Redefinition of:</div>
  548. <dl>
  549. <dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
  550. <dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
  551. </dl>
  552. </div>
  553. <a name="methodis_enabled" id="is_enabled"><!-- --></a>
  554. <div class="oddrow">
  555. <div class="method-header">
  556. <img src="../media/images/Method.png" />
  557. <span class="method-title">is_enabled</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a56">56</a></span>)
  558. </div>
  559. <!-- ========== Info from phpDoc block ========= -->
  560. <p class="short-description">Checks if blogging is enabled on the site.</p>
  561. <ul class="tags">
  562. <li><span class="field">return:</span> True if blogging is enabled, or false otherwise</li>
  563. </ul>
  564. <div class="method-signature">
  565. <span class="method-result">bool</span>
  566. <span class="method-name">
  567. is_enabled
  568. </span>
  569. ()
  570. </div>
  571. </div>
  572. <a name="methoduser_can_write" id="user_can_write"><!-- --></a>
  573. <div class="evenrow">
  574. <div class="method-header">
  575. <img src="../media/images/Method.png" />
  576. <span class="method-title">user_can_write</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_blog.php.html#a68">68</a></span>)
  577. </div>
  578. <!-- ========== Info from phpDoc block ========= -->
  579. <p class="short-description">Checks if the currently logged-in user has permission to create blog entries.</p>
  580. <ul class="tags">
  581. <li><span class="field">return:</span> True if user has permission, or false otherwise</li>
  582. </ul>
  583. <div class="method-signature">
  584. <span class="method-result">bool</span>
  585. <span class="method-name">
  586. user_can_write
  587. </span>
  588. ()
  589. </div>
  590. </div>
  591. <h4>Inherited Methods</h4>
  592. <a name='inherited_methods'><!-- --></a>
  593. <!-- =========== Summary =========== -->
  594. <p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  595. <blockquote>
  596. <img src="../media/images/Constructor.png" alt=" "/>
  597. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
  598. <img src="../media/images/Method.png" alt=" "/>
  599. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
  600. <img src="../media/images/Method.png" alt=" "/>
  601. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
  602. <img src="../media/images/Method.png" alt=" "/>
  603. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
  604. <img src="../media/images/Method.png" alt=" "/>
  605. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
  606. <img src="../media/images/Method.png" alt=" "/>
  607. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
  608. <img src="../media/images/Method.png" alt=" "/>
  609. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
  610. <img src="../media/images/Method.png" alt=" "/>
  611. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
  612. <img src="../media/images/Method.png" alt=" "/>
  613. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
  614. </blockquote>
  615. </div>
  616. </div>
  617. <p class="notes" id="credit">
  618. Documentation generated on Fri, 17 Jul 2009 11:01:54 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  619. </p>
  620. </div></body>
  621. </html>