SloodleUserObject.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  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 SloodleUserObject</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"> SloodleUserObject</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. </div>
  95. <div class="info-box-body">
  96. <!-- ========== Info from phpDoc block ========= -->
  97. <p class="short-description">A user-centric object, relating to the Sloodle user objects DB table.</p>
  98. <p class="notes">
  99. Located in <a class="field" href="_lib---user_object.php.html">/lib/user_object.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a19">19</a></span>)
  100. </p>
  101. <pre></pre>
  102. </div>
  103. </div>
  104. <a name="sec-var-summary"></a>
  105. <div class="info-box">
  106. <div class="info-box-title">Variable Summary</span></div>
  107. <div class="nav-bar">
  108. <a href="#sec-description">Description</a> |
  109. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  110. </div>
  111. <div class="info-box-body">
  112. <div class="var-summary">
  113. <div class="var-title">
  114. <img src="../media/images/Variable.png" alt=" " />
  115. <span class="var-type">bool</span>
  116. <a href="#$authorized" title="details" class="var-name">$authorized</a>
  117. </div>
  118. <div class="var-title">
  119. <img src="../media/images/Variable.png" alt=" " />
  120. <span class="var-type">string</span>
  121. <a href="#$avuuid" title="details" class="var-name">$avuuid</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/Variable.png" alt=" " />
  125. <span class="var-type">int</span>
  126. <a href="#$id" title="details" class="var-name">$id</a>
  127. </div>
  128. <div class="var-title">
  129. <img src="../media/images/Variable.png" alt=" " />
  130. <span class="var-type">string</span>
  131. <a href="#$objname" title="details" class="var-name">$objname</a>
  132. </div>
  133. <div class="var-title">
  134. <img src="../media/images/Variable.png" alt=" " />
  135. <span class="var-type">string</span>
  136. <a href="#$objuuid" title="details" class="var-name">$objuuid</a>
  137. </div>
  138. <div class="var-title">
  139. <img src="../media/images/Variable.png" alt=" " />
  140. <span class="var-type">string</span>
  141. <a href="#$password" title="details" class="var-name">$password</a>
  142. </div>
  143. <div class="var-title">
  144. <img src="../media/images/Variable.png" alt=" " />
  145. <span class="var-type">int</span>
  146. <a href="#$timeupdated" title="details" class="var-name">$timeupdated</a>
  147. </div>
  148. </div>
  149. </div>
  150. </div>
  151. <a name="sec-vars"></a>
  152. <div class="info-box">
  153. <div class="info-box-title">Variables</div>
  154. <div class="nav-bar">
  155. <a href="#sec-description">Description</a> |
  156. <span class="disabled">Vars</span>
  157. </div>
  158. <div class="info-box-body">
  159. <a name="var$authorized" id="$authorized"><!-- --></A>
  160. <div class="evenrow">
  161. <div class="var-header">
  162. <img src="../media/images/Variable.png" />
  163. <span class="var-title">
  164. <span class="var-type">bool</span>
  165. <span class="var-name">$authorized</span>
  166. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a61">61</a></span>)
  167. </span>
  168. </div>
  169. <!-- ========== Info from phpDoc block ========= -->
  170. <p class="short-description">Indicates whether or not this object is currently authorized.</p>
  171. <ul class="tags">
  172. <li><span class="field">access:</span> public</li>
  173. </ul>
  174. </div>
  175. <a name="var$avuuid" id="$avuuid"><!-- --></A>
  176. <div class="oddrow">
  177. <div class="var-header">
  178. <img src="../media/images/Variable.png" />
  179. <span class="var-title">
  180. <span class="var-type">string</span>
  181. <span class="var-name">$avuuid</span>
  182. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a33">33</a></span>)
  183. </span>
  184. </div>
  185. <!-- ========== Info from phpDoc block ========= -->
  186. <p class="short-description">The UUID of the object's user</p>
  187. <ul class="tags">
  188. <li><span class="field">access:</span> public</li>
  189. </ul>
  190. </div>
  191. <a name="var$id" id="$id"><!-- --></A>
  192. <div class="evenrow">
  193. <div class="var-header">
  194. <img src="../media/images/Variable.png" />
  195. <span class="var-title">
  196. <span class="var-type">int</span>
  197. <span class="var-name">$id</span>
  198. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a26">26</a></span>)
  199. </span>
  200. </div>
  201. <!-- ========== Info from phpDoc block ========= -->
  202. <p class="short-description">The database record ID of this object's entry.</p>
  203. <ul class="tags">
  204. <li><span class="field">access:</span> public</li>
  205. </ul>
  206. </div>
  207. <a name="var$objname" id="$objname"><!-- --></A>
  208. <div class="oddrow">
  209. <div class="var-header">
  210. <img src="../media/images/Variable.png" />
  211. <span class="var-title">
  212. <span class="var-type">string</span>
  213. <span class="var-name">$objname</span>
  214. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a47">47</a></span>)
  215. </span>
  216. </div>
  217. <!-- ========== Info from phpDoc block ========= -->
  218. <p class="short-description">The name of this object.</p>
  219. <ul class="tags">
  220. <li><span class="field">access:</span> public</li>
  221. </ul>
  222. </div>
  223. <a name="var$objuuid" id="$objuuid"><!-- --></A>
  224. <div class="evenrow">
  225. <div class="var-header">
  226. <img src="../media/images/Variable.png" />
  227. <span class="var-title">
  228. <span class="var-type">string</span>
  229. <span class="var-name">$objuuid</span>
  230. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a40">40</a></span>)
  231. </span>
  232. </div>
  233. <!-- ========== Info from phpDoc block ========= -->
  234. <p class="short-description">The UUID of this object.</p>
  235. <ul class="tags">
  236. <li><span class="field">access:</span> public</li>
  237. </ul>
  238. </div>
  239. <a name="var$password" id="$password"><!-- --></A>
  240. <div class="oddrow">
  241. <div class="var-header">
  242. <img src="../media/images/Variable.png" />
  243. <span class="var-title">
  244. <span class="var-type">string</span>
  245. <span class="var-name">$password</span>
  246. = <span class="var-default"> ''</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a54">54</a></span>)
  247. </span>
  248. </div>
  249. <!-- ========== Info from phpDoc block ========= -->
  250. <p class="short-description">The password of this object.</p>
  251. <ul class="tags">
  252. <li><span class="field">access:</span> public</li>
  253. </ul>
  254. </div>
  255. <a name="var$timeupdated" id="$timeupdated"><!-- --></A>
  256. <div class="evenrow">
  257. <div class="var-header">
  258. <img src="../media/images/Variable.png" />
  259. <span class="var-title">
  260. <span class="var-type">int</span>
  261. <span class="var-name">$timeupdated</span>
  262. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libuser_object.php.html#a68">68</a></span>)
  263. </span>
  264. </div>
  265. <!-- ========== Info from phpDoc block ========= -->
  266. <p class="short-description">Timestamp for when this object was last used.</p>
  267. <ul class="tags">
  268. <li><span class="field">access:</span> public</li>
  269. </ul>
  270. </div>
  271. </div>
  272. </div>
  273. <p class="notes" id="credit">
  274. Documentation generated on Fri, 17 Jul 2009 11:02:42 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  275. </p>
  276. </div></body>
  277. </html>