[Sommaire] [Imprimer]

   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 IUser</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">Interface IUser</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                      </div>
  22      <div class="info-box-body">
  23                  <!-- ========== Info from phpDoc block ========= -->
  24  <p class="short-description">IUser interface.</p>
  25  <p class="description"><p>This interface must be implemented by user objects.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: interfaces.php 1397 2006-09-07 07:55:53Z wei $</li>
  29                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_interfaces_php.html">/interfaces.php</a> (line <span class="field">105</span>)
  33          </p>
  34          
  35                  
  36          <pre></pre>
  37      
  38              </div>
  39  </div>
  40  
  41  
  42  
  43  
  44      <a name="sec-method-summary"></a>
  45      <div class="info-box">
  46          <div class="info-box-title">Method Summary</span></div>
  47          <div class="nav-bar">
  48              <a href="#sec-description">Description</a> |
  49                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  50          </div>
  51          <div class="info-box-body">            
  52              <div class="method-summary">
  53                                  
  54                  <div class="method-definition">
  55                                              <span class="method-result">boolean</span>
  56                                          <a href="#getIsGuest" title="details" class="method-name">getIsGuest</a>
  57                                          ()
  58                                      </div>
  59                                  
  60                  <div class="method-definition">
  61                                              <span class="method-result">string</span>
  62                                          <a href="#getName" title="details" class="method-name">getName</a>
  63                                          ()
  64                                      </div>
  65                                  
  66                  <div class="method-definition">
  67                                              <span class="method-result">array</span>
  68                                          <a href="#getRoles" title="details" class="method-name">getRoles</a>
  69                                          ()
  70                                      </div>
  71                                  
  72                  <div class="method-definition">
  73                                              <span class="method-result">boolean</span>
  74                                          <a href="#isInRole" title="details" class="method-name">isInRole</a>
  75                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$role</span>)
  76                                      </div>
  77                                  
  78                  <div class="method-definition">
  79                                              <span class="method-result"><a href="../System/IUser.html">IUser</a></span>
  80                                          <a href="#loadFromString" title="details" class="method-name">loadFromString</a>
  81                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  82                                      </div>
  83                                  
  84                  <div class="method-definition">
  85                                              <span class="method-result">string</span>
  86                                          <a href="#saveToString" title="details" class="method-name">saveToString</a>
  87                                          ()
  88                                      </div>
  89                                  
  90                  <div class="method-definition">
  91                                              <span class="method-result">void</span>
  92                                          <a href="#setIsGuest" title="details" class="method-name">setIsGuest</a>
  93                                              (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
  94                                      </div>
  95                                  
  96                  <div class="method-definition">
  97                                              <span class="method-result">void</span>
  98                                          <a href="#setName" title="details" class="method-name">setName</a>
  99                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 100                                      </div>
 101                                  
 102                  <div class="method-definition">
 103                                              <span class="method-result">array|string</span>
 104                                          <a href="#setRoles" title="details" class="method-name">setRoles</a>
 105                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
 106                                      </div>
 107                              </div>
 108          </div>
 109      </div>        
 110  
 111      
 112      <a name="sec-methods"></a>
 113      <div class="info-box">
 114          <div class="info-box-title">Methods</div>
 115          <div class="nav-bar">
 116              <a href="#sec-description">Description</a> |
 117                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 118                          
 119          </div>
 120          <div class="info-box-body">
 121              <A NAME='method_detail'></A>
 122  <a name="methodgetIsGuest" id="getIsGuest"><!-- --></a>
 123  <div class="oddrow">
 124      
 125      <div class="method-header">
 126          <span class="method-title">getIsGuest</span> (line <span class="line-number">118</span>)
 127      </div> 
 128      
 129      <!-- ========== Info from phpDoc block ========= -->
 130      <ul class="tags">
 131                  <li><span class="field">return:</span> if the user is a guest</li>
 132                  <li><span class="field">access:</span> public</li>
 133              </ul>
 134      
 135      <div class="method-signature">
 136          <span class="method-result">boolean</span>
 137          <span class="method-name">
 138              getIsGuest
 139          </span>
 140                  ()
 141              </div>
 142      
 143          
 144          
 145      </div>
 146  <a name="methodgetName" id="getName"><!-- --></a>
 147  <div class="evenrow">
 148      
 149      <div class="method-header">
 150          <span class="method-title">getName</span> (line <span class="line-number">110</span>)
 151      </div> 
 152      
 153      <!-- ========== Info from phpDoc block ========= -->
 154      <ul class="tags">
 155                  <li><span class="field">return:</span> username</li>
 156                  <li><span class="field">access:</span> public</li>
 157              </ul>
 158      
 159      <div class="method-signature">
 160          <span class="method-result">string</span>
 161          <span class="method-name">
 162              getName
 163          </span>
 164                  ()
 165              </div>
 166      
 167          
 168          
 169      </div>
 170  <a name="methodgetRoles" id="getRoles"><!-- --></a>
 171  <div class="oddrow">
 172      
 173      <div class="method-header">
 174          <span class="method-title">getRoles</span> (line <span class="line-number">126</span>)
 175      </div> 
 176      
 177      <!-- ========== Info from phpDoc block ========= -->
 178      <ul class="tags">
 179                  <li><span class="field">return:</span> list of roles that the user is of</li>
 180                  <li><span class="field">access:</span> public</li>
 181              </ul>
 182      
 183      <div class="method-signature">
 184          <span class="method-result">array</span>
 185          <span class="method-name">
 186              getRoles
 187          </span>
 188                  ()
 189              </div>
 190      
 191          
 192          
 193      </div>
 194  <a name="methodisInRole" id="isInRole"><!-- --></a>
 195  <div class="evenrow">
 196      
 197      <div class="method-header">
 198          <span class="method-title">isInRole</span> (line <span class="line-number">135</span>)
 199      </div> 
 200      
 201      <!-- ========== Info from phpDoc block ========= -->
 202      <ul class="tags">
 203                  <li><span class="field">return:</span> whether the user is of this role</li>
 204                  <li><span class="field">access:</span> public</li>
 205              </ul>
 206      
 207      <div class="method-signature">
 208          <span class="method-result">boolean</span>
 209          <span class="method-name">
 210              isInRole
 211          </span>
 212                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$role</span>)
 213              </div>
 214      
 215              <ul class="parameters">
 216                      <li>
 217                  <span class="var-type">string</span>
 218                  <span class="var-name">$role</span><span class="var-description">: role to be tested</span>            </li>
 219                  </ul>
 220          
 221          
 222      </div>
 223  <a name="methodloadFromString" id="loadFromString"><!-- --></a>
 224  <div class="oddrow">
 225      
 226      <div class="method-header">
 227          <span class="method-title">loadFromString</span> (line <span class="line-number">144</span>)
 228      </div> 
 229      
 230      <!-- ========== Info from phpDoc block ========= -->
 231      <ul class="tags">
 232                  <li><span class="field">return:</span> the user object</li>
 233                  <li><span class="field">access:</span> public</li>
 234              </ul>
 235      
 236      <div class="method-signature">
 237          <span class="method-result"><a href="../System/IUser.html">IUser</a></span>
 238          <span class="method-name">
 239              loadFromString
 240          </span>
 241                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
 242              </div>
 243      
 244              <ul class="parameters">
 245                      <li>
 246                  <span class="var-type">string</span>
 247                  <span class="var-name">$string</span><span class="var-description">: user data that is serialized and restored from session</span>            </li>
 248                  </ul>
 249          
 250          
 251      </div>
 252  <a name="methodsaveToString" id="saveToString"><!-- --></a>
 253  <div class="evenrow">
 254      
 255      <div class="method-header">
 256          <span class="method-title">saveToString</span> (line <span class="line-number">139</span>)
 257      </div> 
 258      
 259      <!-- ========== Info from phpDoc block ========= -->
 260      <ul class="tags">
 261                  <li><span class="field">return:</span> user data that is serialized and will be stored in session</li>
 262                  <li><span class="field">access:</span> public</li>
 263              </ul>
 264      
 265      <div class="method-signature">
 266          <span class="method-result">string</span>
 267          <span class="method-name">
 268              saveToString
 269          </span>
 270                  ()
 271              </div>
 272      
 273          
 274          
 275      </div>
 276  <a name="methodsetIsGuest" id="setIsGuest"><!-- --></a>
 277  <div class="oddrow">
 278      
 279      <div class="method-header">
 280          <span class="method-title">setIsGuest</span> (line <span class="line-number">122</span>)
 281      </div> 
 282      
 283      <!-- ========== Info from phpDoc block ========= -->
 284      <ul class="tags">
 285                  <li><span class="field">access:</span> public</li>
 286              </ul>
 287      
 288      <div class="method-signature">
 289          <span class="method-result">void</span>
 290          <span class="method-name">
 291              setIsGuest
 292          </span>
 293                      (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 294              </div>
 295      
 296              <ul class="parameters">
 297                      <li>
 298                  <span class="var-type">boolean</span>
 299                  <span class="var-name">$value</span><span class="var-description">: if the user is a guest</span>            </li>
 300                  </ul>
 301          
 302          
 303      </div>
 304  <a name="methodsetName" id="setName"><!-- --></a>
 305  <div class="evenrow">
 306      
 307      <div class="method-header">
 308          <span class="method-title">setName</span> (line <span class="line-number">114</span>)
 309      </div> 
 310      
 311      <!-- ========== Info from phpDoc block ========= -->
 312      <ul class="tags">
 313                  <li><span class="field">access:</span> public</li>
 314              </ul>
 315      
 316      <div class="method-signature">
 317          <span class="method-result">void</span>
 318          <span class="method-name">
 319              setName
 320          </span>
 321                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 322              </div>
 323      
 324              <ul class="parameters">
 325                      <li>
 326                  <span class="var-type">string</span>
 327                  <span class="var-name">$value</span><span class="var-description">: username</span>            </li>
 328                  </ul>
 329          
 330          
 331      </div>
 332  <a name="methodsetRoles" id="setRoles"><!-- --></a>
 333  <div class="oddrow">
 334      
 335      <div class="method-header">
 336          <span class="method-title">setRoles</span> (line <span class="line-number">130</span>)
 337      </div> 
 338      
 339      <!-- ========== Info from phpDoc block ========= -->
 340      <ul class="tags">
 341                  <li><span class="field">return:</span> list of roles that the user is of. If it is a string, roles are assumed by separated by comma</li>
 342                  <li><span class="field">access:</span> public</li>
 343              </ul>
 344      
 345      <div class="method-signature">
 346          <span class="method-result">array|string</span>
 347          <span class="method-name">
 348              setRoles
 349          </span>
 350                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
 351              </div>
 352      
 353          
 354          
 355      </div>
 356                          
 357          </div>
 358      </div>
 359  
 360  
 361      <p class="notes" id="credit">
 362          Documentation generated on Mon, 04 Dec 2006 11:25:49 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 363      </p>
 364      </div></body>
 365  </html>