| 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 User</title> |
|---|
| 7 | <link rel="stylesheet" href="../media/stylesheet.css" /> |
|---|
| 8 | <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
|---|
| 9 | </head> |
|---|
| 10 | <body> |
|---|
| 11 | <div class="page-body"> |
|---|
| 12 | <h2 class="class-name"><img src="../media/images/Class_logo.png" |
|---|
| 13 | alt=" Class" |
|---|
| 14 | title=" Class" |
|---|
| 15 | style="vertical-align: middle"> User</h2> |
|---|
| 16 | |
|---|
| 17 | <a name="sec-description"></a> |
|---|
| 18 | <div class="info-box"> |
|---|
| 19 | <div class="info-box-title">Description</div> |
|---|
| 20 | <div class="nav-bar"> |
|---|
| 21 | <span class="disabled">Description</span> | |
|---|
| 22 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|---|
| 23 | | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|---|
| 24 | |
|---|
| 25 | </div> |
|---|
| 26 | <div class="info-box-body"> |
|---|
| 27 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 28 | <p class="short-description">Description of User</p> |
|---|
| 29 | <ul class="tags"> |
|---|
| 30 | <li><span class="field">author:</span> jkraaijeveld</li> |
|---|
| 31 | </ul> |
|---|
| 32 | <p class="notes"> |
|---|
| 33 | Located in <a class="field" href="_models---User.php.html">/models/User.php</a> (line <span class="field">13</span>) |
|---|
| 34 | </p> |
|---|
| 35 | |
|---|
| 36 | |
|---|
| 37 | <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a> |
|---|
| 38 | | |
|---|
| 39 | --User</pre> |
|---|
| 40 | |
|---|
| 41 | </div> |
|---|
| 42 | </div> |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | <a name="sec-var-summary"></a> |
|---|
| 47 | <div class="info-box"> |
|---|
| 48 | <div class="info-box-title">Variable Summary</span></div> |
|---|
| 49 | <div class="nav-bar"> |
|---|
| 50 | <a href="#sec-description">Description</a> | |
|---|
| 51 | <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
|---|
| 52 | | |
|---|
| 53 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|---|
| 54 | |
|---|
| 55 | </div> |
|---|
| 56 | <div class="info-box-body"> |
|---|
| 57 | <div class="var-summary"> |
|---|
| 58 | <div class="var-title"> |
|---|
| 59 | <img src="../media/images/Variable.png" alt=" " /> |
|---|
| 60 | <span class="var-type">mixed</span> |
|---|
| 61 | <a href="#$email" title="details" class="var-name">$email</a> |
|---|
| 62 | </div> |
|---|
| 63 | <div class="var-title"> |
|---|
| 64 | <img src="../media/images/Variable.png" alt=" " /> |
|---|
| 65 | <span class="var-type">mixed</span> |
|---|
| 66 | <a href="#$passwordHash" title="details" class="var-name">$passwordHash</a> |
|---|
| 67 | </div> |
|---|
| 68 | <div class="var-title"> |
|---|
| 69 | <img src="../media/images/Variable.png" alt=" " /> |
|---|
| 70 | <span class="var-type">mixed</span> |
|---|
| 71 | <a href="#$passwordSalt" title="details" class="var-name">$passwordSalt</a> |
|---|
| 72 | </div> |
|---|
| 73 | </div> |
|---|
| 74 | </div> |
|---|
| 75 | </div> |
|---|
| 76 | |
|---|
| 77 | <a name="sec-method-summary"></a> |
|---|
| 78 | <div class="info-box"> |
|---|
| 79 | <div class="info-box-title">Method Summary</span></div> |
|---|
| 80 | <div class="nav-bar"> |
|---|
| 81 | <a href="#sec-description">Description</a> | |
|---|
| 82 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|---|
| 83 | |
|---|
| 84 | | |
|---|
| 85 | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
|---|
| 86 | </div> |
|---|
| 87 | <div class="info-box-body"> |
|---|
| 88 | <div class="method-summary"> |
|---|
| 89 | <div class="method-definition"> |
|---|
| 90 | <img src="../media/images/StaticMethod.png" alt=" "/> |
|---|
| 91 | static <span class="method-result">void</span> |
|---|
| 92 | <a href="#create" title="details" class="method-name">create</a> |
|---|
| 93 | (<span class="var-type"></span> <span class="var-name">$obj</span>) |
|---|
| 94 | </div> |
|---|
| 95 | <div class="method-definition"> |
|---|
| 96 | <img src="../media/images/StaticMethod.png" alt=" "/> |
|---|
| 97 | static <span class="method-result">void</span> |
|---|
| 98 | <a href="#get" title="details" class="method-name">get</a> |
|---|
| 99 | (<span class="var-type">type</span> <span class="var-name">$arguments</span>) |
|---|
| 100 | </div> |
|---|
| 101 | <div class="method-definition"> |
|---|
| 102 | <img src="../media/images/Constructor.png" alt=" "/> |
|---|
| 103 | <span class="method-result">User</span> |
|---|
| 104 | <a href="#__construct" title="details" class="method-name">__construct</a> |
|---|
| 105 | ([<span class="var-type"></span> <span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$email</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$passwordHash</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$passwordSalt</span> = <span class="var-default">null</span>]) |
|---|
| 106 | </div> |
|---|
| 107 | <div class="method-definition"> |
|---|
| 108 | <img src="../media/images/Method.png" alt=" "/> |
|---|
| 109 | <span class="method-result">void</span> |
|---|
| 110 | <a href="#save" title="details" class="method-name">save</a> |
|---|
| 111 | () |
|---|
| 112 | </div> |
|---|
| 113 | </div> |
|---|
| 114 | </div> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | <a name="sec-vars"></a> |
|---|
| 118 | <div class="info-box"> |
|---|
| 119 | <div class="info-box-title">Variables</div> |
|---|
| 120 | <div class="nav-bar"> |
|---|
| 121 | <a href="#sec-description">Description</a> | |
|---|
| 122 | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
|---|
| 123 | |
|---|
| 124 | |
|---|
| 125 | | |
|---|
| 126 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|---|
| 127 | |
|---|
| 128 | </div> |
|---|
| 129 | <div class="info-box-body"> |
|---|
| 130 | |
|---|
| 131 | <a name="var$email" id="$email"><!-- --></A> |
|---|
| 132 | <div class="evenrow"> |
|---|
| 133 | |
|---|
| 134 | <div class="var-header"> |
|---|
| 135 | <img src="../media/images/Variable.png" /> |
|---|
| 136 | <span class="var-title"> |
|---|
| 137 | <span class="var-type">mixed</span> |
|---|
| 138 | <span class="var-name">$email</span> |
|---|
| 139 | (line <span class="line-number">18</span>) |
|---|
| 140 | </span> |
|---|
| 141 | </div> |
|---|
| 142 | |
|---|
| 143 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 144 | <ul class="tags"> |
|---|
| 145 | <li><span class="field">access:</span> public</li> |
|---|
| 146 | </ul> |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | </div> |
|---|
| 153 | <a name="var$passwordHash" id="$passwordHash"><!-- --></A> |
|---|
| 154 | <div class="oddrow"> |
|---|
| 155 | |
|---|
| 156 | <div class="var-header"> |
|---|
| 157 | <img src="../media/images/Variable.png" /> |
|---|
| 158 | <span class="var-title"> |
|---|
| 159 | <span class="var-type">mixed</span> |
|---|
| 160 | <span class="var-name">$passwordHash</span> |
|---|
| 161 | (line <span class="line-number">19</span>) |
|---|
| 162 | </span> |
|---|
| 163 | </div> |
|---|
| 164 | |
|---|
| 165 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 166 | <ul class="tags"> |
|---|
| 167 | <li><span class="field">access:</span> public</li> |
|---|
| 168 | </ul> |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | </div> |
|---|
| 175 | <a name="var$passwordSalt" id="$passwordSalt"><!-- --></A> |
|---|
| 176 | <div class="evenrow"> |
|---|
| 177 | |
|---|
| 178 | <div class="var-header"> |
|---|
| 179 | <img src="../media/images/Variable.png" /> |
|---|
| 180 | <span class="var-title"> |
|---|
| 181 | <span class="var-type">mixed</span> |
|---|
| 182 | <span class="var-name">$passwordSalt</span> |
|---|
| 183 | (line <span class="line-number">20</span>) |
|---|
| 184 | </span> |
|---|
| 185 | </div> |
|---|
| 186 | |
|---|
| 187 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 188 | <ul class="tags"> |
|---|
| 189 | <li><span class="field">access:</span> public</li> |
|---|
| 190 | </ul> |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | </div> |
|---|
| 197 | <h4>Inherited Variables</h4> |
|---|
| 198 | <A NAME='inherited_vars'><!-- --></A> |
|---|
| 199 | <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p> |
|---|
| 200 | <blockquote> |
|---|
| 201 | <img src="../media/images/Variable.png" /> |
|---|
| 202 | <span class="var-title"> |
|---|
| 203 | <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br> |
|---|
| 204 | </span> |
|---|
| 205 | </blockquote> |
|---|
| 206 | |
|---|
| 207 | </div> |
|---|
| 208 | </div> |
|---|
| 209 | |
|---|
| 210 | <a name="sec-methods"></a> |
|---|
| 211 | <div class="info-box"> |
|---|
| 212 | <div class="info-box-title">Methods</div> |
|---|
| 213 | <div class="nav-bar"> |
|---|
| 214 | <a href="#sec-description">Description</a> | |
|---|
| 215 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|---|
| 216 | <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
|---|
| 217 | |
|---|
| 218 | </div> |
|---|
| 219 | <div class="info-box-body"> |
|---|
| 220 | <A NAME='method_detail'></A> |
|---|
| 221 | <a name="methodcreate" id="create"><!-- --></a> |
|---|
| 222 | <div class="oddrow"> |
|---|
| 223 | |
|---|
| 224 | <div class="method-header"> |
|---|
| 225 | <img src="../media/images/StaticMethod.png" /> |
|---|
| 226 | <span class="method-title">static create</span> (line <span class="line-number">114</span>) |
|---|
| 227 | </div> |
|---|
| 228 | |
|---|
| 229 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 230 | <ul class="tags"> |
|---|
| 231 | <li><span class="field">access:</span> public</li> |
|---|
| 232 | </ul> |
|---|
| 233 | |
|---|
| 234 | <div class="method-signature"> |
|---|
| 235 | <span class="method-result">void</span> |
|---|
| 236 | <span class="method-name"> |
|---|
| 237 | create |
|---|
| 238 | </span> |
|---|
| 239 | (<span class="var-type"></span> <span class="var-name">$obj</span>) |
|---|
| 240 | </div> |
|---|
| 241 | |
|---|
| 242 | <ul class="parameters"> |
|---|
| 243 | <li> |
|---|
| 244 | <span class="var-type"></span> |
|---|
| 245 | <span class="var-name">$obj</span> </li> |
|---|
| 246 | </ul> |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | </div> |
|---|
| 250 | <a name="methodget" id="get"><!-- --></a> |
|---|
| 251 | <div class="evenrow"> |
|---|
| 252 | |
|---|
| 253 | <div class="method-header"> |
|---|
| 254 | <img src="../media/images/StaticMethod.png" /> |
|---|
| 255 | <span class="method-title">static get</span> (line <span class="line-number">83</span>) |
|---|
| 256 | </div> |
|---|
| 257 | |
|---|
| 258 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 259 | <p class="short-description">static function get($arguments) Gets the array of User objects belonging to arguments supplied.</p> |
|---|
| 260 | <ul class="tags"> |
|---|
| 261 | <li><span class="field">access:</span> public</li> |
|---|
| 262 | </ul> |
|---|
| 263 | |
|---|
| 264 | <div class="method-signature"> |
|---|
| 265 | <span class="method-result">void</span> |
|---|
| 266 | <span class="method-name"> |
|---|
| 267 | get |
|---|
| 268 | </span> |
|---|
| 269 | (<span class="var-type">type</span> <span class="var-name">$arguments</span>) |
|---|
| 270 | </div> |
|---|
| 271 | |
|---|
| 272 | <ul class="parameters"> |
|---|
| 273 | <li> |
|---|
| 274 | <span class="var-type">type</span> |
|---|
| 275 | <span class="var-name">$arguments</span><span class="var-description">: : An array containing zero or more of the following keys: 'uid', 'email', 'passwordHash', 'passwordSalt'</span> </li> |
|---|
| 276 | </ul> |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | </div> |
|---|
| 280 | <a name="method__construct" id="__construct"><!-- --></a> |
|---|
| 281 | <div class="oddrow"> |
|---|
| 282 | |
|---|
| 283 | <div class="method-header"> |
|---|
| 284 | <img src="../media/images/Constructor.png" /> |
|---|
| 285 | <span class="method-title">Constructor __construct</span> (line <span class="line-number">26</span>) |
|---|
| 286 | </div> |
|---|
| 287 | |
|---|
| 288 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 289 | <p class="short-description">Constructor of User</p> |
|---|
| 290 | <p class="description"><p>If the user does not yet exist in the database, call with null as first parameter</p></p> |
|---|
| 291 | <ul class="tags"> |
|---|
| 292 | <li><span class="field">access:</span> public</li> |
|---|
| 293 | </ul> |
|---|
| 294 | |
|---|
| 295 | <div class="method-signature"> |
|---|
| 296 | <span class="method-result">User</span> |
|---|
| 297 | <span class="method-name"> |
|---|
| 298 | __construct |
|---|
| 299 | </span> |
|---|
| 300 | ([<span class="var-type"></span> <span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$email</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$passwordHash</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$passwordSalt</span> = <span class="var-default">null</span>]) |
|---|
| 301 | </div> |
|---|
| 302 | |
|---|
| 303 | <ul class="parameters"> |
|---|
| 304 | <li> |
|---|
| 305 | <span class="var-type"></span> |
|---|
| 306 | <span class="var-name">$uid</span> </li> |
|---|
| 307 | <li> |
|---|
| 308 | <span class="var-type"></span> |
|---|
| 309 | <span class="var-name">$email</span> </li> |
|---|
| 310 | <li> |
|---|
| 311 | <span class="var-type"></span> |
|---|
| 312 | <span class="var-name">$passwordHash</span> </li> |
|---|
| 313 | <li> |
|---|
| 314 | <span class="var-type"></span> |
|---|
| 315 | <span class="var-name">$passwordSalt</span> </li> |
|---|
| 316 | </ul> |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | </div> |
|---|
| 320 | <a name="methodsave" id="save"><!-- --></a> |
|---|
| 321 | <div class="evenrow"> |
|---|
| 322 | |
|---|
| 323 | <div class="method-header"> |
|---|
| 324 | <img src="../media/images/Method.png" /> |
|---|
| 325 | <span class="method-title">save</span> (line <span class="line-number">41</span>) |
|---|
| 326 | </div> |
|---|
| 327 | |
|---|
| 328 | <!-- ========== Info from phpDoc block ========= --> |
|---|
| 329 | <p class="short-description">function save() Saves the current object into the database.</p> |
|---|
| 330 | <ul class="tags"> |
|---|
| 331 | <li><span class="field">access:</span> public</li> |
|---|
| 332 | </ul> |
|---|
| 333 | |
|---|
| 334 | <div class="method-signature"> |
|---|
| 335 | <span class="method-result">void</span> |
|---|
| 336 | <span class="method-name"> |
|---|
| 337 | save |
|---|
| 338 | </span> |
|---|
| 339 | () |
|---|
| 340 | </div> |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | </div> |
|---|
| 345 | <h4>Inherited Methods</h4> |
|---|
| 346 | <a name='inherited_methods'><!-- --></a> |
|---|
| 347 | <!-- =========== Summary =========== --> |
|---|
| 348 | <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p> |
|---|
| 349 | <blockquote> |
|---|
| 350 | <img src="../media/images/Method.png" alt=" "/> |
|---|
| 351 | <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br> |
|---|
| 352 | <img src="../media/images/Method.png" alt=" "/> |
|---|
| 353 | <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br> |
|---|
| 354 | <img src="../media/images/Method.png" alt=" "/> |
|---|
| 355 | <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br> |
|---|
| 356 | <img src="../media/images/Method.png" alt=" "/> |
|---|
| 357 | <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br> |
|---|
| 358 | <img src="../media/images/Method.png" alt=" "/> |
|---|
| 359 | <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br> |
|---|
| 360 | </blockquote> |
|---|
| 361 | |
|---|
| 362 | </div> |
|---|
| 363 | </div> |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | <p class="notes" id="credit"> |
|---|
| 367 | Documentation generated on Thu, 01 Mar 2012 15:13:52 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
|---|
| 368 | </p> |
|---|
| 369 | </div></body> |
|---|
| 370 | </html> |
|---|
