SloodleModuleDistributor.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797
  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 SloodleModuleDistributor</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"> SloodleModuleDistributor</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 Distributor module class.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_sloodle---lib---modules---module_distributor.php.html">/sloodle/lib/modules/module_distributor.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a23">23</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
  103. |
  104. --SloodleModuleDistributor</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="#$sloodle_distributor_instance" title="details" class="var-name">$sloodle_distributor_instance</a>
  127. </div>
  128. <div class="var-title">
  129. <img src="../media/images/PrivateVariable.png" alt=" " />
  130. <span class="var-type">object</span>
  131. <a href="#$sloodle_module_instance" title="details" class="var-name">$sloodle_module_instance</a>
  132. </div>
  133. </div>
  134. </div>
  135. </div>
  136. <a name="sec-method-summary"></a>
  137. <div class="info-box">
  138. <div class="info-box-title">Method Summary</span></div>
  139. <div class="nav-bar">
  140. <a href="#sec-description">Description</a> |
  141. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  142. |
  143. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  144. </div>
  145. <div class="info-box-body">
  146. <div class="method-summary">
  147. <div class="method-definition">
  148. <img src="../media/images/Constructor.png" alt=" "/>
  149. <span class="method-result">SloodleModuleDistributor</span>
  150. <a href="#SloodleModuleDistributor" title="details" class="method-name">SloodleModuleDistributor</a>
  151. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  152. </div>
  153. <div class="method-definition">
  154. <img src="../media/images/Method.png" alt=" "/>
  155. <span class="method-result">mixed</span>
  156. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  157. ()
  158. </div>
  159. <div class="method-definition">
  160. <img src="../media/images/Method.png" alt=" "/>
  161. <span class="method-result">int</span>
  162. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  163. ()
  164. </div>
  165. <div class="method-definition">
  166. <img src="../media/images/Method.png" alt=" "/>
  167. <span class="method-result">string</span>
  168. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  169. ()
  170. </div>
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">int</span>
  174. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  175. ()
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">string</span>
  180. <a href="#get_name" title="details" class="method-name">get_name</a>
  181. ()
  182. </div>
  183. <div class="method-definition">
  184. <img src="../media/images/Method.png" alt=" "/>
  185. <span class="method-result">array</span>
  186. <a href="#get_objects" title="details" class="method-name">get_objects</a>
  187. ()
  188. </div>
  189. <div class="method-definition">
  190. <img src="../media/images/Method.png" alt=" "/>
  191. <span class="method-result">string</span>
  192. <a href="#get_type" title="details" class="method-name">get_type</a>
  193. ()
  194. </div>
  195. <div class="method-definition">
  196. <img src="../media/images/Method.png" alt=" "/>
  197. <span class="method-result">string</span>
  198. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  199. ()
  200. </div>
  201. <div class="method-definition">
  202. <img src="../media/images/Method.png" alt=" "/>
  203. <span class="method-result">bool</span>
  204. <a href="#load" title="details" class="method-name">load</a>
  205. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  206. </div>
  207. <div class="method-definition">
  208. <img src="../media/images/Method.png" alt=" "/>
  209. <span class="method-result">bool</span>
  210. <a href="#send_object" title="details" class="method-name">send_object</a>
  211. (<span class="var-type">string</span>&nbsp;<span class="var-name">$objname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>)
  212. </div>
  213. <div class="method-definition">
  214. <img src="../media/images/Method.png" alt=" "/>
  215. <span class="method-result">bool</span>
  216. <a href="#set_channel" title="details" class="method-name">set_channel</a>
  217. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>)
  218. </div>
  219. <div class="method-definition">
  220. <img src="../media/images/Method.png" alt=" "/>
  221. <span class="method-result">bool</span>
  222. <a href="#set_objects" title="details" class="method-name">set_objects</a>
  223. (<span class="var-type">array</span>&nbsp;<span class="var-name">$objects</span>)
  224. </div>
  225. </div>
  226. </div>
  227. </div>
  228. <a name="sec-vars"></a>
  229. <div class="info-box">
  230. <div class="info-box-title">Variables</div>
  231. <div class="nav-bar">
  232. <a href="#sec-description">Description</a> |
  233. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  234. |
  235. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  236. </div>
  237. <div class="info-box-body">
  238. <a name="var$cm" id="$cm"><!-- --></A>
  239. <div class="oddrow">
  240. <div class="var-header">
  241. <img src="../media/images/PrivateVariable.png" />
  242. <span class="var-title">
  243. <span class="var-type">object</span>
  244. <span class="var-name">$cm</span>
  245. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a33">33</a></span>)
  246. </span>
  247. </div>
  248. <!-- ========== Info from phpDoc block ========= -->
  249. <p class="short-description">Internal for Moodle only - course module instance.</p>
  250. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
  251. <ul class="tags">
  252. <li><span class="field">access:</span> private</li>
  253. </ul>
  254. </div>
  255. <a name="var$sloodle_distributor_instance" id="$sloodle_distributor_instance"><!-- --></A>
  256. <div class="evenrow">
  257. <div class="var-header">
  258. <img src="../media/images/PrivateVariable.png" />
  259. <span class="var-title">
  260. <span class="var-type">object</span>
  261. <span class="var-name">$sloodle_distributor_instance</span>
  262. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a49">49</a></span>)
  263. </span>
  264. </div>
  265. <!-- ========== Info from phpDoc block ========= -->
  266. <p class="short-description">Internal only - Sloodle Distributor instance database object.</p>
  267. <p class="description"><p>Corresponds to one record from the Moodle 'sloodle_distributor' table.</p></p>
  268. <ul class="tags">
  269. <li><span class="field">access:</span> private</li>
  270. </ul>
  271. </div>
  272. <a name="var$sloodle_module_instance" id="$sloodle_module_instance"><!-- --></A>
  273. <div class="oddrow">
  274. <div class="var-header">
  275. <img src="../media/images/PrivateVariable.png" />
  276. <span class="var-title">
  277. <span class="var-type">object</span>
  278. <span class="var-name">$sloodle_module_instance</span>
  279. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a41">41</a></span>)
  280. </span>
  281. </div>
  282. <!-- ========== Info from phpDoc block ========= -->
  283. <p class="short-description">Internal only - Sloodle module instance database object.</p>
  284. <p class="description"><p>Corresponds to one record from the Moodle 'sloodle' table.</p></p>
  285. <ul class="tags">
  286. <li><span class="field">access:</span> private</li>
  287. </ul>
  288. </div>
  289. <h4>Inherited Variables</h4>
  290. <A NAME='inherited_vars'><!-- --></A>
  291. <p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  292. <blockquote>
  293. <img src="../media/images/Variable.png" />
  294. <span class="var-title">
  295. <span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
  296. </span>
  297. </blockquote>
  298. </div>
  299. </div>
  300. <a name="sec-methods"></a>
  301. <div class="info-box">
  302. <div class="info-box-title">Methods</div>
  303. <div class="nav-bar">
  304. <a href="#sec-description">Description</a> |
  305. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  306. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  307. </div>
  308. <div class="info-box-body">
  309. <A NAME='method_detail'></A>
  310. <a name="methodSloodleModuleDistributor" id="SloodleModuleDistributor"><!-- --></a>
  311. <div class="evenrow">
  312. <div class="method-header">
  313. <img src="../media/images/Constructor.png" />
  314. <span class="method-title">Constructor SloodleModuleDistributor</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a57">57</a></span>)
  315. </div>
  316. <!-- ========== Info from phpDoc block ========= -->
  317. <p class="short-description">Constructor</p>
  318. <div class="method-signature">
  319. <span class="method-result">SloodleModuleDistributor</span>
  320. <span class="method-name">
  321. SloodleModuleDistributor
  322. </span>
  323. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  324. </div>
  325. <ul class="parameters">
  326. <li>
  327. <span class="var-type"></span>
  328. <span class="var-name">&$_session</span> </li>
  329. </ul>
  330. </div>
  331. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  332. <div class="oddrow">
  333. <div class="method-header">
  334. <img src="../media/images/Method.png" />
  335. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a185">185</a></span>)
  336. </div>
  337. <!-- ========== Info from phpDoc block ========= -->
  338. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  339. <ul class="tags">
  340. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  341. </ul>
  342. <div class="method-signature">
  343. <span class="method-result">mixed</span>
  344. <span class="method-name">
  345. get_course_id
  346. </span>
  347. ()
  348. </div>
  349. <hr class="separator" />
  350. <div class="notes">Redefinition of:</div>
  351. <dl>
  352. <dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
  353. <dd>Gets the identifier of the course this controller belongs to.</dd>
  354. </dl>
  355. </div>
  356. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  357. <div class="evenrow">
  358. <div class="method-header">
  359. <img src="../media/images/Method.png" />
  360. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a194">194</a></span>)
  361. </div>
  362. <!-- ========== Info from phpDoc block ========= -->
  363. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  364. <ul class="tags">
  365. <li><span class="field">return:</span> Timestamp</li>
  366. </ul>
  367. <div class="method-signature">
  368. <span class="method-result">int</span>
  369. <span class="method-name">
  370. get_creation_time
  371. </span>
  372. ()
  373. </div>
  374. <hr class="separator" />
  375. <div class="notes">Redefinition of:</div>
  376. <dl>
  377. <dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
  378. <dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
  379. </dl>
  380. </div>
  381. <a name="methodget_intro" id="get_intro"><!-- --></a>
  382. <div class="oddrow">
  383. <div class="method-header">
  384. <img src="../media/images/Method.png" />
  385. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a176">176</a></span>)
  386. </div>
  387. <!-- ========== Info from phpDoc block ========= -->
  388. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  389. <ul class="tags">
  390. <li><span class="field">return:</span> The intro description of this controller</li>
  391. </ul>
  392. <div class="method-signature">
  393. <span class="method-result">string</span>
  394. <span class="method-name">
  395. get_intro
  396. </span>
  397. ()
  398. </div>
  399. <hr class="separator" />
  400. <div class="notes">Redefinition of:</div>
  401. <dl>
  402. <dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
  403. <dd>Gets the intro description of this module instance, if available.</dd>
  404. </dl>
  405. </div>
  406. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  407. <div class="evenrow">
  408. <div class="method-header">
  409. <img src="../media/images/Method.png" />
  410. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a203">203</a></span>)
  411. </div>
  412. <!-- ========== Info from phpDoc block ========= -->
  413. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  414. <ul class="tags">
  415. <li><span class="field">return:</span> Timestamp</li>
  416. </ul>
  417. <div class="method-signature">
  418. <span class="method-result">int</span>
  419. <span class="method-name">
  420. get_modification_time
  421. </span>
  422. ()
  423. </div>
  424. <hr class="separator" />
  425. <div class="notes">Redefinition of:</div>
  426. <dl>
  427. <dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
  428. <dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
  429. </dl>
  430. </div>
  431. <a name="methodget_name" id="get_name"><!-- --></a>
  432. <div class="oddrow">
  433. <div class="method-header">
  434. <img src="../media/images/Method.png" />
  435. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a167">167</a></span>)
  436. </div>
  437. <!-- ========== Info from phpDoc block ========= -->
  438. <p class="short-description">Gets the name of this module instance.</p>
  439. <ul class="tags">
  440. <li><span class="field">return:</span> The name of this controller</li>
  441. </ul>
  442. <div class="method-signature">
  443. <span class="method-result">string</span>
  444. <span class="method-name">
  445. get_name
  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_name">SloodleModule::get_name()</a></dt>
  453. <dd>Gets the name of this module instance.</dd>
  454. </dl>
  455. </div>
  456. <a name="methodget_objects" id="get_objects"><!-- --></a>
  457. <div class="evenrow">
  458. <div class="method-header">
  459. <img src="../media/images/Method.png" />
  460. <span class="method-title">get_objects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a92">92</a></span>)
  461. </div>
  462. <!-- ========== Info from phpDoc block ========= -->
  463. <p class="short-description">Gets a list of all objects for this Distributor.</p>
  464. <ul class="tags">
  465. <li><span class="field">return:</span> An array of strings, each string containing the name of an object in this Distributor.</li>
  466. </ul>
  467. <div class="method-signature">
  468. <span class="method-result">array</span>
  469. <span class="method-name">
  470. get_objects
  471. </span>
  472. ()
  473. </div>
  474. </div>
  475. <a name="methodget_type" id="get_type"><!-- --></a>
  476. <div class="oddrow">
  477. <div class="method-header">
  478. <img src="../media/images/Method.png" />
  479. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a213">213</a></span>)
  480. </div>
  481. <!-- ========== Info from phpDoc block ========= -->
  482. <p class="short-description">Gets the short type name of this instance.</p>
  483. <div class="method-signature">
  484. <span class="method-result">string</span>
  485. <span class="method-name">
  486. get_type
  487. </span>
  488. ()
  489. </div>
  490. <hr class="separator" />
  491. <div class="notes">Redefinition of:</div>
  492. <dl>
  493. <dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
  494. <dd>Gets the short type name of this instance.</dd>
  495. </dl>
  496. </div>
  497. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  498. <div class="evenrow">
  499. <div class="method-header">
  500. <img src="../media/images/Method.png" />
  501. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a223">223</a></span>)
  502. </div>
  503. <!-- ========== Info from phpDoc block ========= -->
  504. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  505. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  506. <ul class="tags">
  507. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  508. </ul>
  509. <div class="method-signature">
  510. <span class="method-result">string</span>
  511. <span class="method-name">
  512. get_type_full
  513. </span>
  514. ()
  515. </div>
  516. <hr class="separator" />
  517. <div class="notes">Redefinition of:</div>
  518. <dl>
  519. <dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
  520. <dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
  521. </dl>
  522. </div>
  523. <a name="methodload" id="load"><!-- --></a>
  524. <div class="oddrow">
  525. <div class="method-header">
  526. <img src="../media/images/Method.png" />
  527. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a69">69</a></span>)
  528. </div>
  529. <!-- ========== Info from phpDoc block ========= -->
  530. <p class="short-description">Loads data from the database.</p>
  531. <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>
  532. <ul class="tags">
  533. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  534. </ul>
  535. <div class="method-signature">
  536. <span class="method-result">bool</span>
  537. <span class="method-name">
  538. load
  539. </span>
  540. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  541. </div>
  542. <ul class="parameters">
  543. <li>
  544. <span class="var-type">mixed</span>
  545. <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>
  546. </ul>
  547. <hr class="separator" />
  548. <div class="notes">Redefinition of:</div>
  549. <dl>
  550. <dt><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></dt>
  551. <dd>Loads data from the database.</dd>
  552. </dl>
  553. </div>
  554. <a name="methodsend_object" id="send_object"><!-- --></a>
  555. <div class="evenrow">
  556. <div class="method-header">
  557. <img src="../media/images/Method.png" />
  558. <span class="method-title">send_object</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a152">152</a></span>)
  559. </div>
  560. <!-- ========== Info from phpDoc block ========= -->
  561. <p class="short-description">Request that the specified object be sent to the specified avatar.</p>
  562. <ul class="tags">
  563. <li><span class="field">return:</span> True if successful, or false if not.</li>
  564. </ul>
  565. <div class="method-signature">
  566. <span class="method-result">bool</span>
  567. <span class="method-name">
  568. send_object
  569. </span>
  570. (<span class="var-type">string</span>&nbsp;<span class="var-name">$objname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>)
  571. </div>
  572. <ul class="parameters">
  573. <li>
  574. <span class="var-type">string</span>
  575. <span class="var-name">$objname</span><span class="var-description">: Name of the object to send</span> </li>
  576. <li>
  577. <span class="var-type">string</span>
  578. <span class="var-name">$uuid</span><span class="var-description">: UUID of the avatar to send the object to</span> </li>
  579. </ul>
  580. </div>
  581. <a name="methodset_channel" id="set_channel"><!-- --></a>
  582. <div class="oddrow">
  583. <div class="method-header">
  584. <img src="../media/images/Method.png" />
  585. <span class="method-title">set_channel</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a136">136</a></span>)
  586. </div>
  587. <!-- ========== Info from phpDoc block ========= -->
  588. <p class="short-description">Sets the UUID of the XMLRPC channel used for requests.</p>
  589. <ul class="tags">
  590. <li><span class="field">return:</span> True if successful, or false if not</li>
  591. </ul>
  592. <div class="method-signature">
  593. <span class="method-result">bool</span>
  594. <span class="method-name">
  595. set_channel
  596. </span>
  597. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>)
  598. </div>
  599. <ul class="parameters">
  600. <li>
  601. <span class="var-type">string</span>
  602. <span class="var-name">$uuid</span><span class="var-description">: The UUID of an XMLRPC channel</span> </li>
  603. </ul>
  604. </div>
  605. <a name="methodset_objects" id="set_objects"><!-- --></a>
  606. <div class="evenrow">
  607. <div class="method-header">
  608. <img src="../media/images/Method.png" />
  609. <span class="method-title">set_objects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_distributor.php.html#a112">112</a></span>)
  610. </div>
  611. <!-- ========== Info from phpDoc block ========= -->
  612. <p class="short-description">Sets the list of objects in this Distributor</p>
  613. <ul class="tags">
  614. <li><span class="field">return:</span> True if successful, or false if not</li>
  615. </ul>
  616. <div class="method-signature">
  617. <span class="method-result">bool</span>
  618. <span class="method-name">
  619. set_objects
  620. </span>
  621. (<span class="var-type">array</span>&nbsp;<span class="var-name">$objects</span>)
  622. </div>
  623. <ul class="parameters">
  624. <li>
  625. <span class="var-type">array</span>
  626. <span class="var-name">$objects</span><span class="var-description">: An array of strings, each string containing the name of an object in the Distributor.</span> </li>
  627. </ul>
  628. </div>
  629. <h4>Inherited Methods</h4>
  630. <a name='inherited_methods'><!-- --></a>
  631. <!-- =========== Summary =========== -->
  632. <p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  633. <blockquote>
  634. <img src="../media/images/Constructor.png" alt=" "/>
  635. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
  636. <img src="../media/images/Method.png" alt=" "/>
  637. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
  638. <img src="../media/images/Method.png" alt=" "/>
  639. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
  640. <img src="../media/images/Method.png" alt=" "/>
  641. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
  642. <img src="../media/images/Method.png" alt=" "/>
  643. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
  644. <img src="../media/images/Method.png" alt=" "/>
  645. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
  646. <img src="../media/images/Method.png" alt=" "/>
  647. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
  648. <img src="../media/images/Method.png" alt=" "/>
  649. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
  650. <img src="../media/images/Method.png" alt=" "/>
  651. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
  652. </blockquote>
  653. </div>
  654. </div>
  655. <p class="notes" id="credit">
  656. Documentation generated on Mon, 16 Jun 2008 15:56:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  657. </p>
  658. </div></body>
  659. </html>