_sloodle---sl_config.php.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  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 page sl_config.php</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="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/sloodle/sl_config.php</h2>
  85. <a name="sec-description"></a>
  86. <div class="info-box">
  87. <div class="info-box-title">Description</div>
  88. <div class="nav-bar">
  89. <span class="disabled">Description</span> |
  90. <a href="#sec-includes">Includes</a>
  91. | <a href="#sec-constants">Constants</a>
  92. | <a href="#sec-functions">Functions</a>
  93. </div>
  94. <div class="info-box-body">
  95. <!-- ========== Info from phpDoc block ========= -->
  96. <p class="short-description">Sloodle core script.</p>
  97. <p class="description"><p>Sets up the basic Sloodle information, and includes the necessary Moodle data/functionality.</p></p>
  98. <ul class="tags">
  99. <li><span class="field">filesource:</span> <a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html">Source Code for this file</a></li>
  100. </ul>
  101. </div>
  102. </div>
  103. <a name="sec-includes"></a>
  104. <div class="info-box">
  105. <div class="info-box-title">Includes</div>
  106. <div class="nav-bar">
  107. <a href="#sec-description">Description</a> |
  108. <span class="disabled">Includes</span>
  109. | <a href="#sec-constants">Constants</a>
  110. | <a href="#sec-functions">Functions</a>
  111. </div>
  112. <div class="info-box-body">
  113. <a name="_realpath(dirname(__FILE__)_/___/__/config_php)"><!-- --></a>
  114. <div class="evenrow">
  115. <div>
  116. <img src="../media/images/Page.png" alt=" " />
  117. <span class="include-title">
  118. <span class="include-type">require_once</span>
  119. (<span class="include-name">realpath(dirname(__FILE__)."/"."../../config.php")</span>)
  120. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a13">13</a></span>)
  121. </span>
  122. </div>
  123. <!-- ========== Info from phpDoc block ========= -->
  124. </div>
  125. </div>
  126. </div>
  127. <a name="sec-constants"></a>
  128. <div class="info-box">
  129. <div class="info-box-title">Constants</div>
  130. <div class="nav-bar">
  131. <a href="#sec-description">Description</a> |
  132. <a href="#sec-includes">Includes</a>
  133. | <span class="disabled">Constants</span>
  134. | <a href="#sec-functions">Functions</a>
  135. </div>
  136. <div class="info-box-body">
  137. <a name="defineSLOODLE_DEBUG"><!-- --></a>
  138. <div class="oddrow">
  139. <div>
  140. <img src="../media/images/Constant.png" />
  141. <span class="const-title">
  142. <span class="const-name">SLOODLE_DEBUG</span> = true
  143. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a44">44</a></span>)
  144. </span>
  145. </div>
  146. <!-- ========== Info from phpDoc block ========= -->
  147. <ul class="tags">
  148. <li><span class="field">usedby:</span> <a href="../sloodle/_sloodle---sl_config.php.html#functionsloodle_debug">sloodle_debug()</a></li>
  149. </ul>
  150. </div>
  151. <a name="defineSLOODLE_DEBUG_MODE_PARAM_NAME"><!-- --></a>
  152. <div class="evenrow">
  153. <div>
  154. <img src="../media/images/Constant.png" />
  155. <span class="const-title">
  156. <span class="const-name">SLOODLE_DEBUG_MODE_PARAM_NAME</span> = 'sloodledebug'
  157. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a38">38</a></span>)
  158. </span>
  159. </div>
  160. <!-- ========== Info from phpDoc block ========= -->
  161. <p class="short-description">The name of the HTTP parameter which can be used to activate Sloodle debug mode.</p>
  162. </div>
  163. <a name="defineSLOODLE_DIRROOT"><!-- --></a>
  164. <div class="oddrow">
  165. <div>
  166. <img src="../media/images/Constant.png" />
  167. <span class="const-title">
  168. <span class="const-name">SLOODLE_DIRROOT</span> = $CFG-&gt;dirroot.'/mod/sloodle'
  169. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a29">29</a></span>)
  170. </span>
  171. </div>
  172. <!-- ========== Info from phpDoc block ========= -->
  173. <p class="short-description">The data path for the root of the Sloodle folder.</p>
  174. </div>
  175. <a name="defineSLOODLE_LIBROOT"><!-- --></a>
  176. <div class="evenrow">
  177. <div>
  178. <img src="../media/images/Constant.png" />
  179. <span class="const-title">
  180. <span class="const-name">SLOODLE_LIBROOT</span> = $CFG-&gt;dirroot.'/mod/sloodle/lib'
  181. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a31">31</a></span>)
  182. </span>
  183. </div>
  184. <!-- ========== Info from phpDoc block ========= -->
  185. <p class="short-description">The data path for the root of the Sloodle library folder.</p>
  186. </div>
  187. <a name="defineSLOODLE_OBJECT_ACCESS_LEVEL_GROUP"><!-- --></a>
  188. <div class="oddrow">
  189. <div>
  190. <img src="../media/images/Constant.png" />
  191. <span class="const-title">
  192. <span class="const-name">SLOODLE_OBJECT_ACCESS_LEVEL_GROUP</span> = 2
  193. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a102">102</a></span>)
  194. </span>
  195. </div>
  196. <!-- ========== Info from phpDoc block ========= -->
  197. <p class="short-description">Indicates that only in-world group-members may access an object in-world.</p>
  198. </div>
  199. <a name="defineSLOODLE_OBJECT_ACCESS_LEVEL_OWNER"><!-- --></a>
  200. <div class="evenrow">
  201. <div>
  202. <img src="../media/images/Constant.png" />
  203. <span class="const-title">
  204. <span class="const-name">SLOODLE_OBJECT_ACCESS_LEVEL_OWNER</span> = 1
  205. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a100">100</a></span>)
  206. </span>
  207. </div>
  208. <!-- ========== Info from phpDoc block ========= -->
  209. <p class="short-description">Indicates that only the owner may access an object in-world.</p>
  210. </div>
  211. <a name="defineSLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC"><!-- --></a>
  212. <div class="oddrow">
  213. <div>
  214. <img src="../media/images/Constant.png" />
  215. <span class="const-title">
  216. <span class="const-name">SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC</span> = 0
  217. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a98">98</a></span>)
  218. </span>
  219. </div>
  220. <!-- ========== Info from phpDoc block ========= -->
  221. <p class="short-description">Indicates that anybody may access an object in-world.</p>
  222. </div>
  223. <a name="defineSLOODLE_SERVER_ACCESS_LEVEL_COURSE"><!-- --></a>
  224. <div class="evenrow">
  225. <div>
  226. <img src="../media/images/Constant.png" />
  227. <span class="const-title">
  228. <span class="const-name">SLOODLE_SERVER_ACCESS_LEVEL_COURSE</span> = 1
  229. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a107">107</a></span>)
  230. </span>
  231. </div>
  232. <!-- ========== Info from phpDoc block ========= -->
  233. <p class="short-description">Indicates that only those registered and enrolled in a specific course may access a server resource.</p>
  234. </div>
  235. <a name="defineSLOODLE_SERVER_ACCESS_LEVEL_PUBLIC"><!-- --></a>
  236. <div class="oddrow">
  237. <div>
  238. <img src="../media/images/Constant.png" />
  239. <span class="const-title">
  240. <span class="const-name">SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC</span> = 0
  241. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a105">105</a></span>)
  242. </span>
  243. </div>
  244. <!-- ========== Info from phpDoc block ========= -->
  245. <p class="short-description">Indicates that anybody may access a server resource (still requires an authenticated request).</p>
  246. </div>
  247. <a name="defineSLOODLE_SERVER_ACCESS_LEVEL_SITE"><!-- --></a>
  248. <div class="evenrow">
  249. <div>
  250. <img src="../media/images/Constant.png" />
  251. <span class="const-title">
  252. <span class="const-name">SLOODLE_SERVER_ACCESS_LEVEL_SITE</span> = 2
  253. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a109">109</a></span>)
  254. </span>
  255. </div>
  256. <!-- ========== Info from phpDoc block ========= -->
  257. <p class="short-description">Indicates that only those registered on the site may access a server resource.</p>
  258. </div>
  259. <a name="defineSLOODLE_SERVER_ACCESS_LEVEL_STAFF"><!-- --></a>
  260. <div class="oddrow">
  261. <div>
  262. <img src="../media/images/Constant.png" />
  263. <span class="const-title">
  264. <span class="const-name">SLOODLE_SERVER_ACCESS_LEVEL_STAFF</span> = 3
  265. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a111">111</a></span>)
  266. </span>
  267. </div>
  268. <!-- ========== Info from phpDoc block ========= -->
  269. <p class="short-description">Indicates that only those with Sloodle staff status on a course may access a server resource.</p>
  270. </div>
  271. <a name="defineSLOODLE_TYPE_CTRL"><!-- --></a>
  272. <div class="evenrow">
  273. <div>
  274. <img src="../media/images/Constant.png" />
  275. <span class="const-title">
  276. <span class="const-name">SLOODLE_TYPE_CTRL</span> = 'controller'
  277. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a82">82</a></span>)
  278. </span>
  279. </div>
  280. <!-- ========== Info from phpDoc block ========= -->
  281. </div>
  282. <a name="defineSLOODLE_TYPE_DISTRIB"><!-- --></a>
  283. <div class="oddrow">
  284. <div>
  285. <img src="../media/images/Constant.png" />
  286. <span class="const-title">
  287. <span class="const-name">SLOODLE_TYPE_DISTRIB</span> = 'distributor'
  288. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a85">85</a></span>)
  289. </span>
  290. </div>
  291. <!-- ========== Info from phpDoc block ========= -->
  292. </div>
  293. <a name="defineSLOODLE_VERSION"><!-- --></a>
  294. <div class="evenrow">
  295. <div>
  296. <img src="../media/images/Constant.png" />
  297. <span class="const-title">
  298. <span class="const-name">SLOODLE_VERSION</span> = 0.3
  299. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a33">33</a></span>)
  300. </span>
  301. </div>
  302. <!-- ========== Info from phpDoc block ========= -->
  303. <p class="short-description">The Sloodle version number.</p>
  304. </div>
  305. <a name="defineSLOODLE_WWWROOT"><!-- --></a>
  306. <div class="oddrow">
  307. <div>
  308. <img src="../media/images/Constant.png" />
  309. <span class="const-title">
  310. <span class="const-name">SLOODLE_WWWROOT</span> = $CFG-&gt;wwwroot.'/mod/sloodle'
  311. (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a27">27</a></span>)
  312. </span>
  313. </div>
  314. <!-- ========== Info from phpDoc block ========= -->
  315. <p class="short-description">The path for browsing to the root of the Sloodle folder.</p>
  316. </div>
  317. </div>
  318. </div>
  319. <a name="sec-functions"></a>
  320. <div class="info-box">
  321. <div class="info-box-title">Functions</div>
  322. <div class="nav-bar">
  323. <a href="#sec-description">Description</a> |
  324. <a href="#sec-includes">Includes</a>
  325. | <a href="#sec-constants">Constants</a>
  326. | <span class="disabled">Functions</span>
  327. </div>
  328. <div class="info-box-body">
  329. <a name="functionsloodle_debug" id="functionsloodle_debug"><!-- --></a>
  330. <div class="evenrow">
  331. <div>
  332. <img src="../media/images/Function.png" />
  333. <span class="method-title">sloodle_debug</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlesl_config.php.html#a69">69</a></span>)
  334. </div>
  335. <!-- ========== Info from phpDoc block ========= -->
  336. <p class="short-description">Outputs messages if in debug mode.</p>
  337. <ul class="tags">
  338. <li><span class="field">uses:</span> <a href="../sloodle/_sloodle---sl_config.php.html#defineSLOODLE_DEBUG">SLOODLE_DEBUG</a></li>
  339. </ul>
  340. <div class="method-signature">
  341. <span class="method-result">void</span>
  342. <span class="method-name">
  343. sloodle_debug
  344. </span>
  345. (<span class="var-type">string</span>&nbsp;<span class="var-name">$msg</span>)
  346. </div>
  347. <ul class="parameters">
  348. <li>
  349. <span class="var-type">string</span>
  350. <span class="var-name">$msg</span><span class="var-description">: The debug message to output</span> </li>
  351. </ul>
  352. </div>
  353. </div>
  354. </div>
  355. <p class="notes" id="credit">
  356. Documentation generated on Mon, 16 Jun 2008 15:57:00 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  357. </p>
  358. </div></body>
  359. </html>