source: Doc/Backend/PHPDoc/default/User.html @ 179

Last change on this file since 179 was 179, checked in by jkraaijeveld, 13 years ago

Updated documentation and PHPDoc

File size: 6.8 KB
Line 
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">Class User</h2>
13
14<a name="sec-description"></a>
15<div class="info-box">
16        <div class="info-box-title">Description</div>
17        <div class="nav-bar">
18                                        <span class="disabled">Description</span> |
19                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21                                               
22                                        </div>
23        <div class="info-box-body">
24                        <!-- ========== Info from phpDoc block ========= -->
25<p class="short-description">Description of User</p>
26        <ul class="tags">
27                                <li><span class="field">author:</span> jkraaijeveld</li>
28                        </ul>
29                <p class="notes">
30                        Located in <a class="field" href="_User.php.html">/User.php</a> (line <span class="field">9</span>)
31                </p>
32               
33                               
34                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
35   |
36   --User</pre>
37       
38                        </div>
39</div>
40
41
42
43        <a name="sec-var-summary"></a>
44        <div class="info-box">
45                <div class="info-box-title">Variable Summary</span></div>
46                <div class="nav-bar">
47                        <a href="#sec-description">Description</a> |
48                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
49                                                        |
50                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
51                                                       
52                                                                </div>
53                <div class="info-box-body">
54                        <div class="var-summary">
55                                                                                                                                                                                                                                                                <div class="var-title">
56                                        <span class="var-type">mixed</span>
57                                        <a href="#$name" title="details" class="var-name">$name</a>
58                                </div>
59                                                                                                                                <div class="var-title">
60                                        <span class="var-type">mixed</span>
61                                        <a href="#$password" title="details" class="var-name">$password</a>
62                                </div>
63                                                                                        </div>
64                </div>
65        </div>
66
67        <a name="sec-method-summary"></a>
68        <div class="info-box">
69                <div class="info-box-title">Method Summary</span></div>
70                <div class="nav-bar">
71                        <a href="#sec-description">Description</a> |
72                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
73                                 
74                                |
75                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
76                </div>
77                <div class="info-box-body">                     
78                        <div class="method-summary">
79                                                                                               
80                                                                                                <div class="method-definition">
81                                                                                        <span class="method-result">User</span>
82                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
83                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">null</span>])
84                                                                        </div>
85                                                                </div>
86                </div>
87        </div>         
88
89        <a name="sec-vars"></a>
90        <div class="info-box">
91                <div class="info-box-title">Variables</div>
92                <div class="nav-bar">
93                        <a href="#sec-description">Description</a> |
94                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
95                                               
96                       
97                                                                                |
98                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
99                                                       
100                                        </div>
101                <div class="info-box-body">
102                        <a name="var$name" id="$name"><!-- --></A>
103<div class="oddrow">
104
105        <div class="var-header">
106                <span class="var-title">
107                        <span class="var-type">mixed</span>
108                        <span class="var-name">$name</span>
109                                                (line <span class="line-number">11</span>)
110                </span>
111        </div>
112
113        <!-- ========== Info from phpDoc block ========= -->
114        <ul class="tags">
115                                <li><span class="field">access:</span> public</li>
116                        </ul>
117       
118       
119               
120               
121
122</div>
123<a name="var$password" id="$password"><!-- --></A>
124<div class="evenrow">
125
126        <div class="var-header">
127                <span class="var-title">
128                        <span class="var-type">mixed</span>
129                        <span class="var-name">$password</span>
130                                                (line <span class="line-number">12</span>)
131                </span>
132        </div>
133
134        <!-- ========== Info from phpDoc block ========= -->
135        <ul class="tags">
136                                <li><span class="field">access:</span> public</li>
137                        </ul>
138       
139       
140               
141               
142
143</div>
144                                                        <h4>Inherited Variables</h4>
145                                <A NAME='inherited_vars'><!-- --></A>
146                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
147                                        <blockquote>
148                                                                                                        <span class="var-title">
149                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
150                                                        </span>
151                                                                                        </blockquote>
152                                                                               
153                </div>
154        </div>
155       
156        <a name="sec-methods"></a>
157        <div class="info-box">
158                <div class="info-box-title">Methods</div>
159                <div class="nav-bar">
160                        <a href="#sec-description">Description</a> |
161                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
162                                                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
163                                               
164                </div>
165                <div class="info-box-body">
166                        <A NAME='method_detail'></A>
167
168<a name="method__construct" id="__construct"><!-- --></a>
169<div class="oddrow">
170       
171        <div class="method-header">
172                <span class="method-title">Constructor __construct</span> (line <span class="line-number">18</span>)
173        </div>
174       
175        <!-- ========== Info from phpDoc block ========= -->
176<p class="short-description">Constructor of User</p>
177<p class="description"><p>If the user does not yet exist in the database, call with null as first parameter</p></p>
178        <ul class="tags">
179                                <li><span class="field">access:</span> public</li>
180                        </ul>
181       
182        <div class="method-signature">
183                <span class="method-result">User</span>
184                <span class="method-name">
185                        __construct
186                </span>
187                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">null</span>])
188                        </div>
189       
190                        <ul class="parameters">
191                                        <li>
192                                <span class="var-type"></span>
193                                <span class="var-name">$uid</span>                      </li>
194                                        <li>
195                                <span class="var-type"></span>
196                                <span class="var-name">$name</span>                     </li>
197                                        <li>
198                                <span class="var-type"></span>
199                                <span class="var-name">$password</span>                 </li>
200                                </ul>
201               
202                       
203        </div>
204                                               
205                </div>
206        </div>
207
208
209        <p class="notes" id="credit">
210                Documentation generated on Fri, 09 Dec 2011 09:33:27 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
211        </p>
212        </div></body>
213</html>
Note: See TracBrowser for help on using the repository browser.