SloodleModuleGlossary.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668
  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 SloodleModuleGlossary</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"> SloodleModuleGlossary</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">The Sloodle glossary module class.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_sloodle---lib---modules---module_glossary.php.html">/sloodle/lib/modules/module_glossary.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a23">23</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
  103. |
  104. --SloodleModuleGlossary</pre>
  105. </div>
  106. </div>
  107. <a name="sec-var-summary"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Variable Summary</span></div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  113. |
  114. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <div class="var-summary">
  118. <div class="var-title">
  119. <img src="../media/images/PrivateVariable.png" alt=" " />
  120. <span class="var-type">object</span>
  121. <a href="#$cm" title="details" class="var-name">$cm</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/PrivateVariable.png" alt=" " />
  125. <span class="var-type">object</span>
  126. <a href="#$moodle_glossary_instance" title="details" class="var-name">$moodle_glossary_instance</a>
  127. </div>
  128. </div>
  129. </div>
  130. </div>
  131. <a name="sec-method-summary"></a>
  132. <div class="info-box">
  133. <div class="info-box-title">Method Summary</span></div>
  134. <div class="nav-bar">
  135. <a href="#sec-description">Description</a> |
  136. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  137. |
  138. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  139. </div>
  140. <div class="info-box-body">
  141. <div class="method-summary">
  142. <div class="method-definition">
  143. <img src="../media/images/Constructor.png" alt=" "/>
  144. <span class="method-result">SloodleModuleGlossary</span>
  145. <a href="#SloodleModuleGlossary" title="details" class="method-name">SloodleModuleGlossary</a>
  146. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  147. </div>
  148. <div class="method-definition">
  149. <img src="../media/images/Method.png" alt=" "/>
  150. <span class="method-result">mixed</span>
  151. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  152. ()
  153. </div>
  154. <div class="method-definition">
  155. <img src="../media/images/Method.png" alt=" "/>
  156. <span class="method-result">int</span>
  157. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  158. ()
  159. </div>
  160. <div class="method-definition">
  161. <img src="../media/images/Method.png" alt=" "/>
  162. <span class="method-result">string</span>
  163. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  164. ()
  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">string</span>
  181. <a href="#get_type" title="details" class="method-name">get_type</a>
  182. ()
  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_full" title="details" class="method-name">get_type_full</a>
  188. ()
  189. </div>
  190. <div class="method-definition">
  191. <img src="../media/images/Method.png" alt=" "/>
  192. <span class="method-result">bool</span>
  193. <a href="#load" title="details" class="method-name">load</a>
  194. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  195. </div>
  196. <div class="method-definition">
  197. <img src="../media/images/Method.png" alt=" "/>
  198. <span class="method-result">array</span>
  199. <a href="#search" title="details" class="method-name">search</a>
  200. (<span class="var-type">string</span>&nbsp;<span class="var-name">$term</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$matchPartial</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$searchAliases</span> = <span class="var-default">false</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$searchDefinitions</span> = <span class="var-default">false</span>])
  201. </div>
  202. </div>
  203. </div>
  204. </div>
  205. <a name="sec-vars"></a>
  206. <div class="info-box">
  207. <div class="info-box-title">Variables</div>
  208. <div class="nav-bar">
  209. <a href="#sec-description">Description</a> |
  210. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  211. |
  212. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  213. </div>
  214. <div class="info-box-body">
  215. <a name="var$cm" id="$cm"><!-- --></A>
  216. <div class="evenrow">
  217. <div class="var-header">
  218. <img src="../media/images/PrivateVariable.png" />
  219. <span class="var-title">
  220. <span class="var-type">object</span>
  221. <span class="var-name">$cm</span>
  222. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a33">33</a></span>)
  223. </span>
  224. </div>
  225. <!-- ========== Info from phpDoc block ========= -->
  226. <p class="short-description">Internal for Moodle only - course module instance.</p>
  227. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
  228. <ul class="tags">
  229. <li><span class="field">access:</span> private</li>
  230. </ul>
  231. </div>
  232. <a name="var$moodle_glossary_instance" id="$moodle_glossary_instance"><!-- --></A>
  233. <div class="oddrow">
  234. <div class="var-header">
  235. <img src="../media/images/PrivateVariable.png" />
  236. <span class="var-title">
  237. <span class="var-type">object</span>
  238. <span class="var-name">$moodle_glossary_instance</span>
  239. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a41">41</a></span>)
  240. </span>
  241. </div>
  242. <!-- ========== Info from phpDoc block ========= -->
  243. <p class="short-description">Internal only - Moodle glossary module instance database object.</p>
  244. <p class="description"><p>Corresponds to one record from the Moodle 'glossary' table.</p></p>
  245. <ul class="tags">
  246. <li><span class="field">access:</span> private</li>
  247. </ul>
  248. </div>
  249. <h4>Inherited Variables</h4>
  250. <A NAME='inherited_vars'><!-- --></A>
  251. <p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  252. <blockquote>
  253. <img src="../media/images/Variable.png" />
  254. <span class="var-title">
  255. <span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
  256. </span>
  257. </blockquote>
  258. </div>
  259. </div>
  260. <a name="sec-methods"></a>
  261. <div class="info-box">
  262. <div class="info-box-title">Methods</div>
  263. <div class="nav-bar">
  264. <a href="#sec-description">Description</a> |
  265. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  266. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  267. </div>
  268. <div class="info-box-body">
  269. <A NAME='method_detail'></A>
  270. <a name="methodSloodleModuleGlossary" id="SloodleModuleGlossary"><!-- --></a>
  271. <div class="evenrow">
  272. <div class="method-header">
  273. <img src="../media/images/Constructor.png" />
  274. <span class="method-title">Constructor SloodleModuleGlossary</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a50">50</a></span>)
  275. </div>
  276. <!-- ========== Info from phpDoc block ========= -->
  277. <p class="short-description">Constructor</p>
  278. <div class="method-signature">
  279. <span class="method-result">SloodleModuleGlossary</span>
  280. <span class="method-name">
  281. SloodleModuleGlossary
  282. </span>
  283. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  284. </div>
  285. <ul class="parameters">
  286. <li>
  287. <span class="var-type"></span>
  288. <span class="var-name">&$_session</span> </li>
  289. </ul>
  290. </div>
  291. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  292. <div class="oddrow">
  293. <div class="method-header">
  294. <img src="../media/images/Method.png" />
  295. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a169">169</a></span>)
  296. </div>
  297. <!-- ========== Info from phpDoc block ========= -->
  298. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  299. <ul class="tags">
  300. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  301. </ul>
  302. <div class="method-signature">
  303. <span class="method-result">mixed</span>
  304. <span class="method-name">
  305. get_course_id
  306. </span>
  307. ()
  308. </div>
  309. <hr class="separator" />
  310. <div class="notes">Redefinition of:</div>
  311. <dl>
  312. <dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
  313. <dd>Gets the identifier of the course this controller belongs to.</dd>
  314. </dl>
  315. </div>
  316. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  317. <div class="evenrow">
  318. <div class="method-header">
  319. <img src="../media/images/Method.png" />
  320. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a178">178</a></span>)
  321. </div>
  322. <!-- ========== Info from phpDoc block ========= -->
  323. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  324. <ul class="tags">
  325. <li><span class="field">return:</span> Timestamp</li>
  326. </ul>
  327. <div class="method-signature">
  328. <span class="method-result">int</span>
  329. <span class="method-name">
  330. get_creation_time
  331. </span>
  332. ()
  333. </div>
  334. <hr class="separator" />
  335. <div class="notes">Redefinition of:</div>
  336. <dl>
  337. <dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
  338. <dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
  339. </dl>
  340. </div>
  341. <a name="methodget_intro" id="get_intro"><!-- --></a>
  342. <div class="oddrow">
  343. <div class="method-header">
  344. <img src="../media/images/Method.png" />
  345. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a160">160</a></span>)
  346. </div>
  347. <!-- ========== Info from phpDoc block ========= -->
  348. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  349. <ul class="tags">
  350. <li><span class="field">return:</span> The intro description of this controller</li>
  351. </ul>
  352. <div class="method-signature">
  353. <span class="method-result">string</span>
  354. <span class="method-name">
  355. get_intro
  356. </span>
  357. ()
  358. </div>
  359. <hr class="separator" />
  360. <div class="notes">Redefinition of:</div>
  361. <dl>
  362. <dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
  363. <dd>Gets the intro description of this module instance, if available.</dd>
  364. </dl>
  365. </div>
  366. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  367. <div class="evenrow">
  368. <div class="method-header">
  369. <img src="../media/images/Method.png" />
  370. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a187">187</a></span>)
  371. </div>
  372. <!-- ========== Info from phpDoc block ========= -->
  373. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  374. <ul class="tags">
  375. <li><span class="field">return:</span> Timestamp</li>
  376. </ul>
  377. <div class="method-signature">
  378. <span class="method-result">int</span>
  379. <span class="method-name">
  380. get_modification_time
  381. </span>
  382. ()
  383. </div>
  384. <hr class="separator" />
  385. <div class="notes">Redefinition of:</div>
  386. <dl>
  387. <dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
  388. <dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
  389. </dl>
  390. </div>
  391. <a name="methodget_name" id="get_name"><!-- --></a>
  392. <div class="oddrow">
  393. <div class="method-header">
  394. <img src="../media/images/Method.png" />
  395. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a151">151</a></span>)
  396. </div>
  397. <!-- ========== Info from phpDoc block ========= -->
  398. <p class="short-description">Gets the name of this module instance.</p>
  399. <ul class="tags">
  400. <li><span class="field">return:</span> The name of this controller</li>
  401. </ul>
  402. <div class="method-signature">
  403. <span class="method-result">string</span>
  404. <span class="method-name">
  405. get_name
  406. </span>
  407. ()
  408. </div>
  409. <hr class="separator" />
  410. <div class="notes">Redefinition of:</div>
  411. <dl>
  412. <dt><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></dt>
  413. <dd>Gets the name of this module instance.</dd>
  414. </dl>
  415. </div>
  416. <a name="methodget_type" id="get_type"><!-- --></a>
  417. <div class="evenrow">
  418. <div class="method-header">
  419. <img src="../media/images/Method.png" />
  420. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a197">197</a></span>)
  421. </div>
  422. <!-- ========== Info from phpDoc block ========= -->
  423. <p class="short-description">Gets the short type name of this instance.</p>
  424. <div class="method-signature">
  425. <span class="method-result">string</span>
  426. <span class="method-name">
  427. get_type
  428. </span>
  429. ()
  430. </div>
  431. <hr class="separator" />
  432. <div class="notes">Redefinition of:</div>
  433. <dl>
  434. <dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
  435. <dd>Gets the short type name of this instance.</dd>
  436. </dl>
  437. </div>
  438. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  439. <div class="oddrow">
  440. <div class="method-header">
  441. <img src="../media/images/Method.png" />
  442. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a207">207</a></span>)
  443. </div>
  444. <!-- ========== Info from phpDoc block ========= -->
  445. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  446. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  447. <ul class="tags">
  448. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  449. </ul>
  450. <div class="method-signature">
  451. <span class="method-result">string</span>
  452. <span class="method-name">
  453. get_type_full
  454. </span>
  455. ()
  456. </div>
  457. <hr class="separator" />
  458. <div class="notes">Redefinition of:</div>
  459. <dl>
  460. <dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
  461. <dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
  462. </dl>
  463. </div>
  464. <a name="methodload" id="load"><!-- --></a>
  465. <div class="evenrow">
  466. <div class="method-header">
  467. <img src="../media/images/Method.png" />
  468. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a62">62</a></span>)
  469. </div>
  470. <!-- ========== Info from phpDoc block ========= -->
  471. <p class="short-description">Loads data from the database.</p>
  472. <p class="description"><p>Note: even if the function fails, it may still have overwritten some or all existing data in the object.</p></p>
  473. <ul class="tags">
  474. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  475. </ul>
  476. <div class="method-signature">
  477. <span class="method-result">bool</span>
  478. <span class="method-name">
  479. load
  480. </span>
  481. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  482. </div>
  483. <ul class="parameters">
  484. <li>
  485. <span class="var-type">mixed</span>
  486. <span class="var-name">$id</span><span class="var-description">: The site-wide unique identifier for all modules. Type depends on VLE. On Moodle, it is an integer course module identifier ('id' field of 'course_modules' table)</span> </li>
  487. </ul>
  488. <hr class="separator" />
  489. <div class="notes">Redefinition of:</div>
  490. <dl>
  491. <dt><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></dt>
  492. <dd>Loads data from the database.</dd>
  493. </dl>
  494. </div>
  495. <a name="methodsearch" id="search"><!-- --></a>
  496. <div class="oddrow">
  497. <div class="method-header">
  498. <img src="../media/images/Method.png" />
  499. <span class="method-title">search</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_glossary.php.html#a97">97</a></span>)
  500. </div>
  501. <!-- ========== Info from phpDoc block ========= -->
  502. <p class="short-description">Searches all entries in the current glossary for the given term.</p>
  503. <ul class="tags">
  504. <li><span class="field">return:</span> An array of <a href="../sloodle/SloodleGlossaryEntry.html">SloodleGlossaryEntry</a> objects</li>
  505. </ul>
  506. <div class="method-signature">
  507. <span class="method-result">array</span>
  508. <span class="method-name">
  509. search
  510. </span>
  511. (<span class="var-type">string</span>&nbsp;<span class="var-name">$term</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$matchPartial</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$searchAliases</span> = <span class="var-default">false</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$searchDefinitions</span> = <span class="var-default">false</span>])
  512. </div>
  513. <ul class="parameters">
  514. <li>
  515. <span class="var-type">string</span>
  516. <span class="var-name">$term</span><span class="var-description">: The term to search for</span> </li>
  517. <li>
  518. <span class="var-type">bool</span>
  519. <span class="var-name">$matchPartial</span><span class="var-description">: If TRUE (default) then partial matches will be returned (e.g. 'vat' would partially match 'avatar')</span> </li>
  520. <li>
  521. <span class="var-type">bool</span>
  522. <span class="var-name">$searchAliases</span><span class="var-description">: If TRUE (not default) then aliases will be searched as well</span> </li>
  523. <li>
  524. <span class="var-type">bool</span>
  525. <span class="var-name">$searchDefinitions</span><span class="var-description">: If TRUE (not default) then definitions will be searched as well (can be SLOW, and always gets partial matches)</span> </li>
  526. </ul>
  527. </div>
  528. <h4>Inherited Methods</h4>
  529. <a name='inherited_methods'><!-- --></a>
  530. <!-- =========== Summary =========== -->
  531. <p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  532. <blockquote>
  533. <img src="../media/images/Constructor.png" alt=" "/>
  534. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
  535. <img src="../media/images/Method.png" alt=" "/>
  536. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
  537. <img src="../media/images/Method.png" alt=" "/>
  538. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
  539. <img src="../media/images/Method.png" alt=" "/>
  540. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
  541. <img src="../media/images/Method.png" alt=" "/>
  542. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
  543. <img src="../media/images/Method.png" alt=" "/>
  544. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
  545. <img src="../media/images/Method.png" alt=" "/>
  546. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
  547. <img src="../media/images/Method.png" alt=" "/>
  548. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
  549. <img src="../media/images/Method.png" alt=" "/>
  550. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
  551. </blockquote>
  552. </div>
  553. </div>
  554. <p class="notes" id="credit">
  555. Documentation generated on Mon, 16 Jun 2008 15:56:48 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  556. </p>
  557. </div></body>
  558. </html>